From 8013c53d8ed96952ba09ecf2190be0757d0f3b66 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Tue, 16 Sep 2025 18:54:37 +1000 Subject: [PATCH 1/2] move docs to microsite --- README.md | 348 +- package-lock.json | 527 + .../docgen/provider-data/headerContent1.txt | 10 +- .../docgen/provider-data/headerContent2.txt | 10 +- provider-dev/openapi/.gitkeep | 0 .../src/pagerduty/v00.00.00000/provider.yaml | 327 + .../v00.00.00000/services/abilities.yaml | 2603 +++++ .../v00.00.00000/services/add_ons.yaml | 2950 ++++++ .../v00.00.00000/services/analytics.yaml | 3643 +++++++ .../v00.00.00000/services/audit.yaml | 2812 +++++ .../services/automation_actions.yaml | 4946 +++++++++ .../services/business_services.yaml | 3922 +++++++ .../v00.00.00000/services/change_events.yaml | 3155 ++++++ .../v00.00.00000/services/custom_fields.yaml | 4934 +++++++++ .../services/escalation_policies.yaml | 3424 +++++++ .../services/event_orchestrations.yaml | 5378 ++++++++++ .../services/extension_schemas.yaml | 2745 +++++ .../v00.00.00000/services/extensions.yaml | 4238 ++++++++ .../services/incident_workflows.yaml | 4214 ++++++++ .../v00.00.00000/services/incidents.yaml | 7229 +++++++++++++ .../v00.00.00000/services/licenses.yaml | 2816 +++++ .../v00.00.00000/services/log_entries.yaml | 3221 ++++++ .../services/maintenance_windows.yaml | 3065 ++++++ .../v00.00.00000/services/notifications.yaml | 2691 +++++ .../v00.00.00000/services/on_calls.yaml | 2726 +++++ .../services/paused_incident_reports.yaml | 2688 +++++ .../v00.00.00000/services/priorities.yaml | 2669 +++++ .../v00.00.00000/services/response_plays.yaml | 3153 ++++++ .../v00.00.00000/services/rulesets.yaml | 3806 +++++++ .../v00.00.00000/services/schedules.yaml | 4291 ++++++++ .../services/service_dependencies.yaml | 2951 ++++++ .../v00.00.00000/services/services.yaml | 5085 +++++++++ .../services/status_dashboards.yaml | 2951 ++++++ .../pagerduty/v00.00.00000/services/tags.yaml | 3091 ++++++ .../v00.00.00000/services/teams.yaml | 3870 +++++++ .../v00.00.00000/services/templates.yaml | 3121 ++++++ .../v00.00.00000/services/users.yaml | 5949 +++++++++++ .../v00.00.00000/services/vendors.yaml | 2747 +++++ .../v00.00.00000/services/webhooks.yaml | 2885 ++++++ provider-dev/scripts/.gitkeep | 0 provider-dev/scripts/fix-broken-links.sh | 1 + website/docs/.gitkeep | 0 website/docs/index.md | 110 + .../services/abilities/abilities/index.md | 189 + website/docs/services/abilities/index.md | 33 + website/docs/services/add_ons/addons/index.md | 413 + website/docs/services/add_ons/index.md | 33 + website/docs/services/analytics/index.md | 36 + .../analytics/metrics_incidents_all/index.md | 139 + .../metrics_incidents_services/index.md | 141 + .../metrics_incidents_teams/index.md | 141 + .../services/analytics/raw_incidents/index.md | 237 + .../raw_incidents_responses/index.md | 198 + website/docs/services/audit/index.md | 33 + website/docs/services/audit/records/index.md | 282 + .../automation_actions/actions/index.md | 420 + .../actions_services/index.md | 379 + .../automation_actions/actions_teams/index.md | 375 + .../docs/services/automation_actions/index.md | 37 + .../automation_actions/invocations/index.md | 379 + .../automation_actions/runners/index.md | 548 + .../automation_actions/runners_teams/index.md | 375 + .../account_subscription/index.md | 190 + .../business_services/index.md | 406 + .../business_services/impactors/index.md | 175 + .../business_services/impacts/index.md | 200 + .../docs/services/business_services/index.md | 38 + .../priority_thresholds/index.md | 220 + .../business_services/subscribers/index.md | 222 + .../supporting_services_impacts/index.md | 207 + .../change_events/change_events/index.md | 497 + .../incidents_related_change_events/index.md | 256 + website/docs/services/change_events/index.md | 34 + .../services/change_events/services/index.md | 292 + .../customfields_fields/index.md | 487 + .../index.md | 389 + .../field_configurations/index.md | 422 + .../custom_fields/fields_schemas/index.md | 227 + website/docs/services/custom_fields/index.md | 37 + .../custom_fields/schema_assignments/index.md | 298 + .../services/custom_fields/schemas/index.md | 443 + .../audit_records/index.md | 247 + .../escalation_policies/index.md | 540 + .../services/escalation_policies/index.md | 33 + .../event_orchestrations/index.md | 457 + .../event_orchestrations/global/index.md | 213 + .../services/event_orchestrations/index.md | 38 + .../integrations/index.md | 372 + .../event_orchestrations/router/index.md | 213 + .../event_orchestrations/services/index.md | 213 + .../services_active/index.md | 190 + .../event_orchestrations/unrouted/index.md | 213 + .../extension_schemas/index.md | 338 + .../docs/services/extension_schemas/index.md | 33 + .../services/extensions/extensions/index.md | 531 + website/docs/services/extensions/index.md | 33 + .../incident_workflows/actions/index.md | 482 + .../incident_workflows/index.md | 511 + .../docs/services/incident_workflows/index.md | 34 + .../incident_workflows/triggers/index.md | 588 ++ .../docs/services/incidents/alerts/index.md | 518 + .../business_services_impacts/index.md | 223 + .../services/incidents/field_values/index.md | 234 + .../incidents/field_values_schema/index.md | 207 + .../services/incidents/incidents/index.md | 915 ++ website/docs/services/incidents/index.md | 42 + .../services/incidents/log_entries/index.md | 222 + .../docs/services/incidents/notes/index.md | 263 + .../incidents/outlier_incident/index.md | 191 + .../incidents/past_incidents/index.md | 175 + .../incidents/related_incidents/index.md | 184 + .../status_updates_subscribers/index.md | 234 + website/docs/services/licenses/index.md | 33 + .../licenses/license_allocations/index.md | 190 + .../docs/services/licenses/licenses/index.md | 224 + website/docs/services/log_entries/index.md | 33 + .../services/log_entries/log_entries/index.md | 320 + .../services/maintenance_windows/index.md | 33 + .../maintenance_windows/index.md | 540 + website/docs/services/notifications/index.md | 33 + .../notifications/notifications/index.md | 262 + website/docs/services/on_calls/index.md | 33 + .../docs/services/on_calls/oncalls/index.md | 271 + .../paused_incident_reports/alerts/index.md | 210 + .../paused_incident_reports/counts/index.md | 216 + .../services/paused_incident_reports/index.md | 33 + website/docs/services/priorities/index.md | 33 + .../services/priorities/priorities/index.md | 221 + website/docs/services/response_plays/index.md | 33 + .../response_plays/response_plays/index.md | 490 + website/docs/services/rulesets/index.md | 33 + website/docs/services/rulesets/rules/index.md | 474 + .../docs/services/rulesets/rulesets/index.md | 469 + .../services/schedules/audit_records/index.md | 247 + website/docs/services/schedules/index.md | 35 + .../services/schedules/overrides/index.md | 337 + .../services/schedules/schedules/index.md | 602 ++ .../docs/services/schedules/users/index.md | 287 + .../business_services/index.md | 189 + .../services/service_dependencies/index.md | 33 + .../technical_services/index.md | 267 + .../services/services/audit_records/index.md | 247 + website/docs/services/services/index.md | 35 + .../services/services/integrations/index.md | 352 + website/docs/services/services/rules/index.md | 462 + .../docs/services/services/services/index.md | 686 ++ .../docs/services/status_dashboards/index.md | 35 + .../service_impacts/index.md | 200 + .../status_dashboards/index.md | 253 + .../status_dashboards/url_slugs/index.md | 181 + .../url_slugs_service_impacts/index.md | 200 + website/docs/services/tags/index.md | 33 + website/docs/services/tags/tags/index.md | 627 ++ .../services/teams/audit_records/index.md | 247 + .../teams/escalation_policies/index.md | 150 + website/docs/services/teams/index.md | 36 + website/docs/services/teams/members/index.md | 266 + .../teams/notification_subscriptions/index.md | 245 + website/docs/services/teams/teams/index.md | 465 + website/docs/services/templates/index.md | 33 + .../services/templates/templates/index.md | 495 + .../services/users/audit_records/index.md | 247 + .../services/users/contact_methods/index.md | 346 + website/docs/services/users/index.md | 41 + website/docs/services/users/license/index.md | 219 + website/docs/services/users/me/index.md | 273 + .../users/notification_rules/index.md | 411 + .../users/notification_subscriptions/index.md | 245 + .../index.md | 394 + website/docs/services/users/sessions/index.md | 320 + .../status_update_notification_rules/index.md | 378 + website/docs/services/users/users/index.md | 598 ++ website/docs/services/vendors/index.md | 33 + .../docs/services/vendors/vendors/index.md | 374 + website/docs/services/webhooks/index.md | 33 + .../webhooks/webhook_subscriptions/index.md | 480 + website/docusaurus.config.js | 4 +- website/yarn.lock | 9087 +++++++++++++++++ 178 files changed, 164134 insertions(+), 195 deletions(-) create mode 100644 package-lock.json delete mode 100644 provider-dev/openapi/.gitkeep create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/provider.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/abilities.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/add_ons.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/analytics.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/audit.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/automation_actions.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/business_services.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/change_events.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/custom_fields.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/escalation_policies.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/event_orchestrations.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/extension_schemas.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/extensions.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/incident_workflows.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/incidents.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/licenses.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/log_entries.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/maintenance_windows.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/notifications.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/on_calls.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/paused_incident_reports.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/priorities.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/response_plays.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/rulesets.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/schedules.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/service_dependencies.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/services.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/status_dashboards.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/tags.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/teams.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/templates.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/users.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/vendors.yaml create mode 100644 provider-dev/openapi/src/pagerduty/v00.00.00000/services/webhooks.yaml delete mode 100644 provider-dev/scripts/.gitkeep create mode 100644 provider-dev/scripts/fix-broken-links.sh delete mode 100644 website/docs/.gitkeep create mode 100644 website/docs/index.md create mode 100644 website/docs/services/abilities/abilities/index.md create mode 100644 website/docs/services/abilities/index.md create mode 100644 website/docs/services/add_ons/addons/index.md create mode 100644 website/docs/services/add_ons/index.md create mode 100644 website/docs/services/analytics/index.md create mode 100644 website/docs/services/analytics/metrics_incidents_all/index.md create mode 100644 website/docs/services/analytics/metrics_incidents_services/index.md create mode 100644 website/docs/services/analytics/metrics_incidents_teams/index.md create mode 100644 website/docs/services/analytics/raw_incidents/index.md create mode 100644 website/docs/services/analytics/raw_incidents_responses/index.md create mode 100644 website/docs/services/audit/index.md create mode 100644 website/docs/services/audit/records/index.md create mode 100644 website/docs/services/automation_actions/actions/index.md create mode 100644 website/docs/services/automation_actions/actions_services/index.md create mode 100644 website/docs/services/automation_actions/actions_teams/index.md create mode 100644 website/docs/services/automation_actions/index.md create mode 100644 website/docs/services/automation_actions/invocations/index.md create mode 100644 website/docs/services/automation_actions/runners/index.md create mode 100644 website/docs/services/automation_actions/runners_teams/index.md create mode 100644 website/docs/services/business_services/account_subscription/index.md create mode 100644 website/docs/services/business_services/business_services/index.md create mode 100644 website/docs/services/business_services/impactors/index.md create mode 100644 website/docs/services/business_services/impacts/index.md create mode 100644 website/docs/services/business_services/index.md create mode 100644 website/docs/services/business_services/priority_thresholds/index.md create mode 100644 website/docs/services/business_services/subscribers/index.md create mode 100644 website/docs/services/business_services/supporting_services_impacts/index.md create mode 100644 website/docs/services/change_events/change_events/index.md create mode 100644 website/docs/services/change_events/incidents_related_change_events/index.md create mode 100644 website/docs/services/change_events/index.md create mode 100644 website/docs/services/change_events/services/index.md create mode 100644 website/docs/services/custom_fields/customfields_fields/index.md create mode 100644 website/docs/services/custom_fields/customfields_fields_field_options/index.md create mode 100644 website/docs/services/custom_fields/field_configurations/index.md create mode 100644 website/docs/services/custom_fields/fields_schemas/index.md create mode 100644 website/docs/services/custom_fields/index.md create mode 100644 website/docs/services/custom_fields/schema_assignments/index.md create mode 100644 website/docs/services/custom_fields/schemas/index.md create mode 100644 website/docs/services/escalation_policies/audit_records/index.md create mode 100644 website/docs/services/escalation_policies/escalation_policies/index.md create mode 100644 website/docs/services/escalation_policies/index.md create mode 100644 website/docs/services/event_orchestrations/event_orchestrations/index.md create mode 100644 website/docs/services/event_orchestrations/global/index.md create mode 100644 website/docs/services/event_orchestrations/index.md create mode 100644 website/docs/services/event_orchestrations/integrations/index.md create mode 100644 website/docs/services/event_orchestrations/router/index.md create mode 100644 website/docs/services/event_orchestrations/services/index.md create mode 100644 website/docs/services/event_orchestrations/services_active/index.md create mode 100644 website/docs/services/event_orchestrations/unrouted/index.md create mode 100644 website/docs/services/extension_schemas/extension_schemas/index.md create mode 100644 website/docs/services/extension_schemas/index.md create mode 100644 website/docs/services/extensions/extensions/index.md create mode 100644 website/docs/services/extensions/index.md create mode 100644 website/docs/services/incident_workflows/actions/index.md create mode 100644 website/docs/services/incident_workflows/incident_workflows/index.md create mode 100644 website/docs/services/incident_workflows/index.md create mode 100644 website/docs/services/incident_workflows/triggers/index.md create mode 100644 website/docs/services/incidents/alerts/index.md create mode 100644 website/docs/services/incidents/business_services_impacts/index.md create mode 100644 website/docs/services/incidents/field_values/index.md create mode 100644 website/docs/services/incidents/field_values_schema/index.md create mode 100644 website/docs/services/incidents/incidents/index.md create mode 100644 website/docs/services/incidents/index.md create mode 100644 website/docs/services/incidents/log_entries/index.md create mode 100644 website/docs/services/incidents/notes/index.md create mode 100644 website/docs/services/incidents/outlier_incident/index.md create mode 100644 website/docs/services/incidents/past_incidents/index.md create mode 100644 website/docs/services/incidents/related_incidents/index.md create mode 100644 website/docs/services/incidents/status_updates_subscribers/index.md create mode 100644 website/docs/services/licenses/index.md create mode 100644 website/docs/services/licenses/license_allocations/index.md create mode 100644 website/docs/services/licenses/licenses/index.md create mode 100644 website/docs/services/log_entries/index.md create mode 100644 website/docs/services/log_entries/log_entries/index.md create mode 100644 website/docs/services/maintenance_windows/index.md create mode 100644 website/docs/services/maintenance_windows/maintenance_windows/index.md create mode 100644 website/docs/services/notifications/index.md create mode 100644 website/docs/services/notifications/notifications/index.md create mode 100644 website/docs/services/on_calls/index.md create mode 100644 website/docs/services/on_calls/oncalls/index.md create mode 100644 website/docs/services/paused_incident_reports/alerts/index.md create mode 100644 website/docs/services/paused_incident_reports/counts/index.md create mode 100644 website/docs/services/paused_incident_reports/index.md create mode 100644 website/docs/services/priorities/index.md create mode 100644 website/docs/services/priorities/priorities/index.md create mode 100644 website/docs/services/response_plays/index.md create mode 100644 website/docs/services/response_plays/response_plays/index.md create mode 100644 website/docs/services/rulesets/index.md create mode 100644 website/docs/services/rulesets/rules/index.md create mode 100644 website/docs/services/rulesets/rulesets/index.md create mode 100644 website/docs/services/schedules/audit_records/index.md create mode 100644 website/docs/services/schedules/index.md create mode 100644 website/docs/services/schedules/overrides/index.md create mode 100644 website/docs/services/schedules/schedules/index.md create mode 100644 website/docs/services/schedules/users/index.md create mode 100644 website/docs/services/service_dependencies/business_services/index.md create mode 100644 website/docs/services/service_dependencies/index.md create mode 100644 website/docs/services/service_dependencies/technical_services/index.md create mode 100644 website/docs/services/services/audit_records/index.md create mode 100644 website/docs/services/services/index.md create mode 100644 website/docs/services/services/integrations/index.md create mode 100644 website/docs/services/services/rules/index.md create mode 100644 website/docs/services/services/services/index.md create mode 100644 website/docs/services/status_dashboards/index.md create mode 100644 website/docs/services/status_dashboards/service_impacts/index.md create mode 100644 website/docs/services/status_dashboards/status_dashboards/index.md create mode 100644 website/docs/services/status_dashboards/url_slugs/index.md create mode 100644 website/docs/services/status_dashboards/url_slugs_service_impacts/index.md create mode 100644 website/docs/services/tags/index.md create mode 100644 website/docs/services/tags/tags/index.md create mode 100644 website/docs/services/teams/audit_records/index.md create mode 100644 website/docs/services/teams/escalation_policies/index.md create mode 100644 website/docs/services/teams/index.md create mode 100644 website/docs/services/teams/members/index.md create mode 100644 website/docs/services/teams/notification_subscriptions/index.md create mode 100644 website/docs/services/teams/teams/index.md create mode 100644 website/docs/services/templates/index.md create mode 100644 website/docs/services/templates/templates/index.md create mode 100644 website/docs/services/users/audit_records/index.md create mode 100644 website/docs/services/users/contact_methods/index.md create mode 100644 website/docs/services/users/index.md create mode 100644 website/docs/services/users/license/index.md create mode 100644 website/docs/services/users/me/index.md create mode 100644 website/docs/services/users/notification_rules/index.md create mode 100644 website/docs/services/users/notification_subscriptions/index.md create mode 100644 website/docs/services/users/oncall_handoff_notification_rules/index.md create mode 100644 website/docs/services/users/sessions/index.md create mode 100644 website/docs/services/users/status_update_notification_rules/index.md create mode 100644 website/docs/services/users/users/index.md create mode 100644 website/docs/services/vendors/index.md create mode 100644 website/docs/services/vendors/vendors/index.md create mode 100644 website/docs/services/webhooks/index.md create mode 100644 website/docs/services/webhooks/webhook_subscriptions/index.md create mode 100644 website/yarn.lock diff --git a/README.md b/README.md index 5545b37..d71d159 100644 --- a/README.md +++ b/README.md @@ -1,164 +1,141 @@ -# StackQL Provider Template +Here's a README for a PagerDuty provider for StackQL, following the same structure as the previous examples: -This repository serves as a template for developing StackQL providers. It provides a structured workflow and tools to generate, test, and document StackQL providers for various cloud services and APIs. +# `pagerduty` provider for [`stackql`](https://github.com/stackql/stackql) -## What is StackQL? - -[StackQL](https://github.com/stackql/stackql) is an open-source SQL interface for cloud APIs that allows you to query and manipulate cloud resources using SQL-like syntax. With StackQL, you can: - -- Query cloud resources across multiple providers using familiar SQL syntax -- Join data from different services and providers -- Execute CRUDL operations (`SELECT`, `INSERT`, `UPDATE`, `REPLACE`, `DELETE`) on cloud resources -- Execute lifecycle operations (like starting or stopping vms) using `EXEC` -- Build custom dashboards and reports -- Automate infrastructure operations using [`stackql-deploy`](https://stackql-deploy.io/) - -## What are StackQL Providers? - -StackQL providers are extensions that connect StackQL to specific cloud services or APIs. Each provider: - -1. Defines a schema that maps API endpoints to SQL-like resources and methods -2. Implements authentication mechanisms for the target API -3. Translates SQL operations into API calls -4. Transforms API responses into tabular data that can be queried with SQL - -This template repository helps you build StackQL providers by converting OpenAPI specifications into StackQL-compatible provider schemas using the `@stackql/provider-utils` package. - -## How StackQL Providers Work - -StackQL providers bridge the gap between SQL queries and REST APIs: - -1. **Resource Mapping**: API endpoints are mapped to SQL-like tables and views -2. **Method Mapping**: API operations are mapped to SQL verbs (`SELECT`, `INSERT`, `UPDATE`, `REPLACE`, `DELETE` and `EXEC`) -3. **Parameter Mapping**: SQL query conditions are translated to API parameters -4. **Response Transformation**: API responses are converted to tabular results +This repository is used to generate and document the `pagerduty` provider for StackQL, allowing you to query and manipulate PagerDuty resources using SQL-like syntax. The provider is built using the `@stackql/provider-utils` package, which provides tools for converting OpenAPI specifications into StackQL-compatible provider schemas. ## Prerequisites -To use this template for developing a StackQL provider, you'll need: +To use the PagerDuty provider with StackQL, you'll need: -1. An OpenAPI specification for the target API -2. Node.js and `npm` installed on your system -3. StackQL CLI installed (see [StackQL Installation](https://stackql.io/docs/installing-stackql)) -4. API credentials for testing your provider +1. A PagerDuty account with appropriate API credentials +2. PagerDuty API key with sufficient permissions for the resources you want to access +3. StackQL CLI installed on your system (see [StackQL](https://github.com/stackql/stackql)) -## Development Workflow +## 1. Download the Open API Specification -### 1. Clone this Template - -Start by cloning this template repository and installing dependencies: - -```bash -git clone https://github.com/stackql/stackql-provider-template.git stackql-provider-myprovider -cd stackql-provider-myprovider -npm install -``` - -### 2. Download the OpenAPI Specification - -Obtain the OpenAPI specification for your target API. You can typically find this in the API documentation or developer portal. +First, download the PagerDuty API OpenAPI specification: ```bash -mkdir -p provider-dev/downloaded -curl -L https://api-url.example.com/openapi.yaml -o provider-dev/downloaded/provider-name.yaml +rm -rf provider-dev/downloaded/* +curl -L https://api-reference.pagerduty.com/output/openapi.json \ +-o provider-dev/downloaded/openapi.json ``` -> recommended to automate this by creating a script in the `provider-dev/scripts` folder +## 2. Split into Service Specs -### 3. Split the OpenAPI Spec into Service Specs - -Break down the OpenAPI specification into smaller, service-specific files: +Next, split the monolithic OpenAPI specification into service-specific files: ```bash +rm -rf provider-dev/source/* npm run split -- \ - --provider-name your-provider-name \ - --api-doc provider-dev/downloaded/provider-name.yaml \ - --svc-discriminator tag \ + --provider-name pagerduty \ + --api-doc provider-dev/downloaded/openapi.json \ + --svc-discriminator path \ --output-dir provider-dev/source \ --overwrite \ --svc-name-overrides "$(cat < this will vary by provider and may not be necessary in many cases +## 5. Test Provider -### 7. Test the Provider +### Starting the StackQL Server -#### Start the StackQL Server +Before running tests, start a StackQL server with your provider: ```bash PROVIDER_REGISTRY_ROOT_DIR="$(pwd)/provider-dev/openapi" -npm run start-server -- --provider your-provider-name --registry $PROVIDER_REGISTRY_ROOT_DIR +npm run start-server -- --provider pagerduty --registry $PROVIDER_REGISTRY_ROOT_DIR ``` -#### Test Metadata Routes +### Test Meta Routes + +Test all metadata routes (services, resources, methods) in the provider: ```bash -npm run test-meta-routes -- your-provider-name --verbose +npm run test-meta-routes -- pagerduty --verbose ``` -#### Run Test Queries +When you're done testing, stop the StackQL server: + +```bash +npm run stop-server +``` + +Use this command to view the server status: + +```bash +npm run server-status +``` + +### Run test queries + +Run some test queries against the provider using the `stackql shell`: ```bash PROVIDER_REGISTRY_ROOT_DIR="$(pwd)/provider-dev/openapi" @@ -166,127 +143,132 @@ REG_STR='{"url": "file://'${PROVIDER_REGISTRY_ROOT_DIR}'", "localDocRoot": "'${P ./stackql shell --registry="${REG_STR}" ``` -Example test query: -```sql -SELECT * FROM your-provider-name.service_name.resource_name LIMIT 10; -``` +Example queries to try: -When you're done testing, stop the StackQL server: -```bash -npm run stop-server +```sql +-- List all incidents +SELECT +id, +incident_number, +title, +status, +urgency, +created_at, +last_status_change_at, +service.name +FROM pagerduty.incidents.list; + +-- View on-call schedules +SELECT +id, +name, +description, +time_zone, +escalation_policies.name +FROM pagerduty.schedules.list; + +-- Check users +SELECT +id, +name, +email, +role, +job_title, +time_zone +FROM pagerduty.users.list; + +-- List services +SELECT +id, +name, +description, +status, +created_at, +escalation_policy.name, +alert_creation +FROM pagerduty.services.list; + +-- View recent alerts +SELECT +id, +alert_key, +severity, +status, +created_at, +service.name, +incident.id +FROM pagerduty.alerts.list +WHERE since = 'date_time_iso8601_minus_24h' +AND until = 'date_time_iso8601_now'; ``` -### 8. Publish the Provider +## 6. Publish the provider -To publish your provider: +To publish the provider push the `pagerduty` dir to `providers/src` in a feature branch of the [`stackql-provider-registry`](https://github.com/stackql/stackql-provider-registry). Follow the [registry release flow](https://github.com/stackql/stackql-provider-registry/blob/dev/docs/build-and-deployment.md). -1. Fork the [stackql-provider-registry](https://github.com/stackql/stackql-provider-registry) repository -2. Copy your provider directory to `providers/src` in a feature branch -3. Follow the [registry release flow](https://github.com/stackql/stackql-provider-registry/blob/dev/docs/build-and-deployment.md) +Launch the StackQL shell: -Test your published provider in the `dev` registry: ```bash export DEV_REG="{ \"url\": \"https://registry-dev.stackql.app/providers\" }" ./stackql --registry="${DEV_REG}" shell ``` -Pull and verify your provider: +Pull the latest dev `pagerduty` provider: + ```sql -registry pull your-provider-name; --- Run test queries +registry pull pagerduty; ``` -### 9. Generate Documentation +Run some test queries to verify the provider works as expected. -Provider doc microsites are built using Docusaurus and published using GitHub Pages. To genarate and publish comprehensive user docs for your provider, do the following: +## 7. Generate web docs -a. Upodate `headerContent1.txt` and `headerContent2.txt` accordingly in `provider-dev/docgen/provider-data/` +Provider doc microsites are built using Docusaurus and published using GitHub Pages. + +a. Update `headerContent1.txt` and `headerContent2.txt` accordingly in `provider-dev/docgen/provider-data/` b. Update the following in `website/docusaurus.config.js`: ```js // Provider configuration - change these for different providers -const providerName = "yourprovidername"; -const providerTitle = "Your Provider Title"; +const providerName = "pagerduty"; +const providerTitle = "PagerDuty Provider"; ``` c. Then generate docs using... ```bash +sh provider-dev/scripts/fix-broken-links.sh npm run generate-docs -- \ - --provider-name your-provider-name \ - --provider-dir ./provider-dev/openapi/src/your-provider-name/v00.00.00000 \ + --provider-name pagerduty \ + --provider-dir ./provider-dev/openapi/src/pagerduty/v00.00.00000 \ --output-dir ./website \ --provider-data-dir ./provider-dev/docgen/provider-data ``` -d. Test the documentation locally: +## 8. Test web docs locally + ```bash cd website +# test build yarn build + +# run local dev server yarn start ``` -### 10. Publish Documentation - -Remove the `.disabled` extension from `.github/workflows/test-web-deploy.yml.disabled` and `.github/workflows/prod-web-deploy.yml.disabled` +## 9. Publish web docs to GitHub Pages -Set up GitHub Pages in your repository settings, and configure DNS if needed: +Under __Pages__ in the repository, in the __Build and deployment__ section select __GitHub Actions__ as the __Source__. In Netlify DNS create the following records: -| Source Domain | Record Type | Target | -|---------------|-------------|--------| -| your-provider-name-provider.stackql.io | CNAME | stackql.github.io. | +| Source Domain | Record Type | Target | +|---------------|--------------|--------| +| pagerduty-provider.stackql.io | CNAME | stackql.github.io. | -## Authentication Configuration - -Different APIs require different authentication methods. Here are common authentication configurations: - -### API Key in Header -```json -{ - "auth": { - "credentialsenvvar": "PROVIDER_API_KEY", - "type": "header", - "headerName": "X-API-Key" - } -} -``` - -### Bearer Token -```json -{ - "auth": { - "credentialsenvvar": "PROVIDER_TOKEN", - "type": "bearer" - } -} -``` - -### Basic Authentication -```json -{ - "auth": { - "credentialsenvvar": "PROVIDER_BASIC_AUTH", - "type": "basic" - } -} -``` +## License -### OAuth (Client Credentials Flow) -```json -{ - "auth": { - "credentialsenvvar": "PROVIDER_OAUTH_CONFIG", - "type": "oauth-client-credentials", - "tokenUrl": "https://auth.example.com/token" - } -} -``` +MIT ## Contributing -Contributions are welcome! Please feel free to submit a Pull Request. - -## License - -MIT \ No newline at end of file +Contributions are welcome! Please feel free to submit a Pull Request. \ No newline at end of file diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..780b38c --- /dev/null +++ b/package-lock.json @@ -0,0 +1,527 @@ +{ + "name": "stackql-provider-digitalocean", + "version": "0.1.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "stackql-provider-digitalocean", + "version": "0.1.0", + "dependencies": { + "@stackql/pgwire-lite": "^1.0.1", + "@stackql/provider-utils": "^0.4.6" + }, + "engines": { + "node": ">=14.16.0" + } + }, + "node_modules/@apidevtools/json-schema-ref-parser": { + "version": "11.7.2", + "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-11.7.2.tgz", + "integrity": "sha512-4gY54eEGEstClvEkGnwVkTkrx0sqwemEFG5OSRRn3tD91XH0+Q8XIkYIfo7IwEWPpJZwILb9GUXeShtplRc/eA==", + "license": "MIT", + "dependencies": { + "@jsdevtools/ono": "^7.1.3", + "@types/json-schema": "^7.0.15", + "js-yaml": "^4.1.0" + }, + "engines": { + "node": ">= 16" + }, + "funding": { + "url": "https://github.com/sponsors/philsturgeon" + } + }, + "node_modules/@apidevtools/openapi-schemas": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@apidevtools/openapi-schemas/-/openapi-schemas-2.1.0.tgz", + "integrity": "sha512-Zc1AlqrJlX3SlpupFGpiLi2EbteyP7fXmUOGup6/DnkRgjP9bgMM/ag+n91rsv0U1Gpz0H3VILA/o3bW7Ua6BQ==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/@apidevtools/swagger-methods": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/@apidevtools/swagger-methods/-/swagger-methods-3.0.2.tgz", + "integrity": "sha512-QAkD5kK2b1WfjDS/UQn/qQkbwF31uqRjPTrsCs5ZG9BQGAkjwvqGFjjPqAuzac/IYzpPtRzjCP1WrTuAIjMrXg==", + "license": "MIT" + }, + "node_modules/@apidevtools/swagger-parser": { + "version": "10.1.1", + "resolved": "https://registry.npmjs.org/@apidevtools/swagger-parser/-/swagger-parser-10.1.1.tgz", + "integrity": "sha512-u/kozRnsPO/x8QtKYJOqoGtC4kH6yg1lfYkB9Au0WhYB0FNLpyFusttQtvhlwjtG3rOwiRz4D8DnnXa8iEpIKA==", + "license": "MIT", + "dependencies": { + "@apidevtools/json-schema-ref-parser": "11.7.2", + "@apidevtools/openapi-schemas": "^2.1.0", + "@apidevtools/swagger-methods": "^3.0.2", + "@jsdevtools/ono": "^7.1.3", + "ajv": "^8.17.1", + "ajv-draft-04": "^1.0.0", + "call-me-maybe": "^1.0.2" + }, + "peerDependencies": { + "openapi-types": ">=7" + } + }, + "node_modules/@colors/colors": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.6.0.tgz", + "integrity": "sha512-Ir+AOibqzrIsL6ajt3Rz3LskB7OiMVHqltZmspbW/TJuTVuyOMirVqAkjfY6JISiLHgyNqicAC8AyHHGzNd/dA==", + "license": "MIT", + "engines": { + "node": ">=0.1.90" + } + }, + "node_modules/@dabh/diagnostics": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@dabh/diagnostics/-/diagnostics-2.0.3.tgz", + "integrity": "sha512-hrlQOIi7hAfzsMqlGSFyVucrx38O+j6wiGOf//H2ecvIEqYN4ADBSS2iLMh5UFyDunCNniUIPk/q3riFv45xRA==", + "license": "MIT", + "dependencies": { + "colorspace": "1.1.x", + "enabled": "2.0.x", + "kuler": "^2.0.0" + } + }, + "node_modules/@jsdevtools/ono": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz", + "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==", + "license": "MIT" + }, + "node_modules/@stackql/deno-openapi-dereferencer": { + "name": "@jsr/stackql__deno-openapi-dereferencer", + "version": "0.3.1", + "resolved": "https://npm.jsr.io/~/11/@jsr/stackql__deno-openapi-dereferencer/0.3.1.tgz", + "integrity": "sha512-7Ucdom3SYxvzp7VwzulQMe66E+1LeCZIprFQ70PwRPIUfL90bYNQDrLfe5L1WaB+X7StWdHmoFSFxoa9RDlN7w==", + "dependencies": { + "jsonpath-plus": "7.0.0" + } + }, + "node_modules/@stackql/pgwire-lite": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@stackql/pgwire-lite/-/pgwire-lite-1.0.1.tgz", + "integrity": "sha512-jgA6ogzlXySZ1xiJzBxuvgRNu9V38Gs3qUZ4AjinlT7hj+8RH3UhYaDvyBd33QWiK3tVNkglYcnXPQ7q0+rmNA==", + "license": "MIT", + "dependencies": { + "winston": "^3.14.2" + } + }, + "node_modules/@stackql/provider-utils": { + "version": "0.4.9", + "resolved": "https://registry.npmjs.org/@stackql/provider-utils/-/provider-utils-0.4.9.tgz", + "integrity": "sha512-htO+VhdD6GbfP0fqHyuqbnSqNA/F+aBUTGXeepMDEzsaRLVkxxa/xUPBR65iaVgNF6icxlsM+dH5XpNWSJtHog==", + "license": "MIT", + "dependencies": { + "@apidevtools/swagger-parser": "^10.1.1", + "@stackql/deno-openapi-dereferencer": "npm:@jsr/stackql__deno-openapi-dereferencer@^0.3.1", + "csv-parser": "^3.2.0", + "js-yaml": "^4.1.0", + "pluralize": "^8.0.0" + }, + "engines": { + "node": ">=16.0.0" + } + }, + "node_modules/@types/json-schema": { + "version": "7.0.15", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", + "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", + "license": "MIT" + }, + "node_modules/@types/triple-beam": { + "version": "1.3.5", + "resolved": "https://registry.npmjs.org/@types/triple-beam/-/triple-beam-1.3.5.tgz", + "integrity": "sha512-6WaYesThRMCl19iryMYP7/x2OVgCtbIVflDGFpWnb9irXI3UjYE4AzmYuiUKY1AJstGijoY+MgUszMgRxIYTYw==", + "license": "MIT" + }, + "node_modules/ajv": { + "version": "8.17.1", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", + "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "fast-uri": "^3.0.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ajv-draft-04": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/ajv-draft-04/-/ajv-draft-04-1.0.0.tgz", + "integrity": "sha512-mv00Te6nmYbRp5DCwclxtt7yV/joXJPGS7nM+97GdxvuttCOfgI3K4U25zboyeX0O+myI8ERluxQe5wljMmVIw==", + "license": "MIT", + "peerDependencies": { + "ajv": "^8.5.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } + } + }, + "node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "license": "Python-2.0" + }, + "node_modules/async": { + "version": "3.2.6", + "resolved": "https://registry.npmjs.org/async/-/async-3.2.6.tgz", + "integrity": "sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA==", + "license": "MIT" + }, + "node_modules/call-me-maybe": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.2.tgz", + "integrity": "sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ==", + "license": "MIT" + }, + "node_modules/color": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/color/-/color-3.2.1.tgz", + "integrity": "sha512-aBl7dZI9ENN6fUGC7mWpMTPNHmWUSNan9tuWN6ahh5ZLNk9baLJOnSMlrQkHcrfFgz2/RigjUVAjdx36VcemKA==", + "license": "MIT", + "dependencies": { + "color-convert": "^1.9.3", + "color-string": "^1.6.0" + } + }, + "node_modules/color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "license": "MIT", + "dependencies": { + "color-name": "1.1.3" + } + }, + "node_modules/color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==", + "license": "MIT" + }, + "node_modules/color-string": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz", + "integrity": "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==", + "license": "MIT", + "dependencies": { + "color-name": "^1.0.0", + "simple-swizzle": "^0.2.2" + } + }, + "node_modules/colorspace": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/colorspace/-/colorspace-1.1.4.tgz", + "integrity": "sha512-BgvKJiuVu1igBUF2kEjRCZXol6wiiGbY5ipL/oVPwm0BL9sIpMIzM8IK7vwuxIIzOXMV3Ey5w+vxhm0rR/TN8w==", + "license": "MIT", + "dependencies": { + "color": "^3.1.3", + "text-hex": "1.0.x" + } + }, + "node_modules/csv-parser": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/csv-parser/-/csv-parser-3.2.0.tgz", + "integrity": "sha512-fgKbp+AJbn1h2dcAHKIdKNSSjfp43BZZykXsCjzALjKy80VXQNHPFJ6T9Afwdzoj24aMkq8GwDS7KGcDPpejrA==", + "license": "MIT", + "bin": { + "csv-parser": "bin/csv-parser" + }, + "engines": { + "node": ">= 10" + } + }, + "node_modules/enabled": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/enabled/-/enabled-2.0.0.tgz", + "integrity": "sha512-AKrN98kuwOzMIdAizXGI86UFBoo26CL21UM763y1h/GMSJ4/OHU9k2YlsmBpyScFo/wbLzWQJBMCW4+IO3/+OQ==", + "license": "MIT" + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "license": "MIT" + }, + "node_modules/fast-uri": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.0.tgz", + "integrity": "sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fastify" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/fastify" + } + ], + "license": "BSD-3-Clause" + }, + "node_modules/fecha": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/fecha/-/fecha-4.2.3.tgz", + "integrity": "sha512-OP2IUU6HeYKJi3i0z4A19kHMQoLVs4Hc+DPqqxI2h/DPZHTm/vjsfC6P0b4jCMy14XizLBqvndQ+UilD7707Jw==", + "license": "MIT" + }, + "node_modules/fn.name": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/fn.name/-/fn.name-1.1.0.tgz", + "integrity": "sha512-GRnmB5gPyJpAhTQdSZTSp9uaPSvl09KoYcMQtsB9rQoOmzs9dH6ffeccH+Z+cv6P68Hu5bC6JjRh4Ah/mHSNRw==", + "license": "MIT" + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "license": "ISC" + }, + "node_modules/is-arrayish": { + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.4.tgz", + "integrity": "sha512-m6UrgzFVUYawGBh1dUsWR5M2Clqic9RVXC/9f8ceNlv2IcO9j9J/z8UoCLPqtsPBFNzEpfR3xftohbfqDx8EQA==", + "license": "MIT" + }, + "node_modules/is-stream": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "license": "MIT" + }, + "node_modules/jsonpath-plus": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/jsonpath-plus/-/jsonpath-plus-7.0.0.tgz", + "integrity": "sha512-MH4UnrWrU1hJGVEyEyjvYgONkzNTO6Yol0nq18EMnUQ/ZC5cTuJheirXXIwu1b9mZ6t3XL0P79gPsu+zlTnDIQ==", + "license": "MIT", + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/kuler": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/kuler/-/kuler-2.0.0.tgz", + "integrity": "sha512-Xq9nH7KlWZmXAtodXDDRE7vs6DU1gTU8zYDHDiWLSip45Egwq3plLHzPn27NgvzL2r1LMPC1vdqh98sQxtqj4A==", + "license": "MIT" + }, + "node_modules/logform": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/logform/-/logform-2.7.0.tgz", + "integrity": "sha512-TFYA4jnP7PVbmlBIfhlSe+WKxs9dklXMTEGcBCIvLhE/Tn3H6Gk1norupVW7m5Cnd4bLcr08AytbyV/xj7f/kQ==", + "license": "MIT", + "dependencies": { + "@colors/colors": "1.6.0", + "@types/triple-beam": "^1.3.2", + "fecha": "^4.2.0", + "ms": "^2.1.1", + "safe-stable-stringify": "^2.3.1", + "triple-beam": "^1.3.0" + }, + "engines": { + "node": ">= 12.0.0" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "license": "MIT" + }, + "node_modules/one-time": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/one-time/-/one-time-1.0.0.tgz", + "integrity": "sha512-5DXOiRKwuSEcQ/l0kGCF6Q3jcADFv5tSmRaJck/OqkVFcOzutB134KRSfF0xDrL39MNnqxbHBbUUcjZIhTgb2g==", + "license": "MIT", + "dependencies": { + "fn.name": "1.x.x" + } + }, + "node_modules/openapi-types": { + "version": "12.1.3", + "resolved": "https://registry.npmjs.org/openapi-types/-/openapi-types-12.1.3.tgz", + "integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw==", + "license": "MIT", + "peer": true + }, + "node_modules/pluralize": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz", + "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/readable-stream": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", + "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", + "license": "MIT", + "dependencies": { + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/safe-stable-stringify": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/safe-stable-stringify/-/safe-stable-stringify-2.5.0.tgz", + "integrity": "sha512-b3rppTKm9T+PsVCBEOUR46GWI7fdOs00VKZ1+9c1EWDaDMvjQc6tUwuFyIprgGgTcWoVHSKrU8H31ZHA2e0RHA==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/simple-swizzle": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.4.tgz", + "integrity": "sha512-nAu1WFPQSMNr2Zn9PGSZK9AGn4t/y97lEm+MXTtUDwfP0ksAIX4nO+6ruD9Jwut4C49SB1Ws+fbXsm/yScWOHw==", + "license": "MIT", + "dependencies": { + "is-arrayish": "^0.3.1" + } + }, + "node_modules/stack-trace": { + "version": "0.0.10", + "resolved": "https://registry.npmjs.org/stack-trace/-/stack-trace-0.0.10.tgz", + "integrity": "sha512-KGzahc7puUKkzyMt+IqAep+TVNbKP+k2Lmwhub39m1AsTSkaDutx56aDCo+HLDzf/D26BIHTJWNiTG1KAJiQCg==", + "license": "MIT", + "engines": { + "node": "*" + } + }, + "node_modules/string_decoder": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", + "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", + "license": "MIT", + "dependencies": { + "safe-buffer": "~5.2.0" + } + }, + "node_modules/text-hex": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/text-hex/-/text-hex-1.0.0.tgz", + "integrity": "sha512-uuVGNWzgJ4yhRaNSiubPY7OjISw4sw4E5Uv0wbjp+OzcbmVU/rsT8ujgcXJhn9ypzsgr5vlzpPqP+MBBKcGvbg==", + "license": "MIT" + }, + "node_modules/triple-beam": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/triple-beam/-/triple-beam-1.4.1.tgz", + "integrity": "sha512-aZbgViZrg1QNcG+LULa7nhZpJTZSLm/mXnHXnbAbjmN5aSa0y7V+wvv6+4WaBtpISJzThKy+PIPxc1Nq1EJ9mg==", + "license": "MIT", + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/util-deprecate": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", + "license": "MIT" + }, + "node_modules/winston": { + "version": "3.17.0", + "resolved": "https://registry.npmjs.org/winston/-/winston-3.17.0.tgz", + "integrity": "sha512-DLiFIXYC5fMPxaRg832S6F5mJYvePtmO5G9v9IgUFPhXm9/GkXarH/TUrBAVzhTCzAj9anE/+GjrgXp/54nOgw==", + "license": "MIT", + "dependencies": { + "@colors/colors": "^1.6.0", + "@dabh/diagnostics": "^2.0.2", + "async": "^3.2.3", + "is-stream": "^2.0.0", + "logform": "^2.7.0", + "one-time": "^1.0.0", + "readable-stream": "^3.4.0", + "safe-stable-stringify": "^2.3.1", + "stack-trace": "0.0.x", + "triple-beam": "^1.3.0", + "winston-transport": "^4.9.0" + }, + "engines": { + "node": ">= 12.0.0" + } + }, + "node_modules/winston-transport": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/winston-transport/-/winston-transport-4.9.0.tgz", + "integrity": "sha512-8drMJ4rkgaPo1Me4zD/3WLfI/zPdA9o2IipKODunnGDcuqbHwjsbB79ylv04LCGGzU0xQ6vTznOMpQGaLhhm6A==", + "license": "MIT", + "dependencies": { + "logform": "^2.7.0", + "readable-stream": "^3.6.2", + "triple-beam": "^1.3.0" + }, + "engines": { + "node": ">= 12.0.0" + } + } + } +} diff --git a/provider-dev/docgen/provider-data/headerContent1.txt b/provider-dev/docgen/provider-data/headerContent1.txt index 8e95862..b9b00a6 100644 --- a/provider-dev/docgen/provider-data/headerContent1.txt +++ b/provider-dev/docgen/provider-data/headerContent1.txt @@ -1,19 +1,19 @@ --- -title: REPLACEME +title: pagerduty hide_title: false hide_table_of_contents: false keywords: - - REPLACEME + - pagerduty - stackql - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage REPLACEME resources using SQL +description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null -image: /img/stackql-REPLACEME-provider-featured-image.png +image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png id: 'provider-intro' --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -REPLACEME with description for the provider. \ No newline at end of file +Incident management platform for real-time operations and response workflows. \ No newline at end of file diff --git a/provider-dev/docgen/provider-data/headerContent2.txt b/provider-dev/docgen/provider-data/headerContent2.txt index 0eeb8c1..50beb87 100644 --- a/provider-dev/docgen/provider-data/headerContent2.txt +++ b/provider-dev/docgen/provider-data/headerContent2.txt @@ -4,10 +4,10 @@ See also: ## Installation -To pull the latest version of the `REPLACEME` provider, run the following command: +To pull the latest version of the `pagerduty` provider, run the following command: ```bash -REGISTRY PULL REPLACEME; +REGISTRY PULL pagerduty; ``` > To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry). @@ -15,7 +15,7 @@ REGISTRY PULL REPLACEME; The following system environment variables are used for authentication by default: -- - REPLACEME API token (see - PagerDuty API token (see Creating a PagerDuty API Token) These variables are sourced at runtime (from the local machine or as CI variables/secrets). @@ -27,7 +27,7 @@ To use different environment variables (instead of the defaults), use the `--aut ```bash -AUTH='{ "REPLACEME": { "type": "bearer", "credentialsenvvar": "REPLACEME" }}' +AUTH='{ "pagerduty": { "type": "bearer", "credentialsenvvar": "YOUR_PAGERDUTY_API_TOKEN_VAR" }}' stackql shell --auth="${AUTH}" ``` @@ -35,7 +35,7 @@ or using PowerShell: ```powershell -$Auth = "{ 'REPLACEME': { 'type': 'bearer', 'credentialsenvvar': 'REPLACEME' }}" +$Auth = "{ 'pagerduty': { 'type': 'bearer', 'credentialsenvvar': 'YOUR_PAGERDUTY_API_TOKEN_VAR' }}" stackql.exe shell --auth=$Auth ``` diff --git a/provider-dev/openapi/.gitkeep b/provider-dev/openapi/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/provider.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/provider.yaml new file mode 100644 index 0000000..35187be --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/provider.yaml @@ -0,0 +1,327 @@ +id: pagerduty +name: pagerduty +version: v00.00.00000 +providerServices: + abilities: + id: 'abilities:v00.00.00000' + name: abilities + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/abilities.yaml + title: PagerDuty API - Abilities + version: v00.00.00000 + description: | + This Describes Your Account'S Abilities By Feature Name. For Example `"Teams"`. + An Ability May Be Available To Your Account Based On Things Like Your Pricing Plan Or Account State. + add_ons: + id: 'add_ons:v00.00.00000' + name: add_ons + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/add_ons.yaml + title: PagerDuty API - Add Ons + version: v00.00.00000 + description: | + Developers Can Write Their Own Functionality To Insert Into PagerDuty'S UI. + analytics: + id: 'analytics:v00.00.00000' + name: analytics + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/analytics.yaml + title: PagerDuty API - Analytics + version: v00.00.00000 + description: | + Provides Enriched Incident Data. + audit: + id: 'audit:v00.00.00000' + name: audit + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/audit.yaml + title: PagerDuty API - Audit + version: v00.00.00000 + description: | + Provides Audit Record Data. + automation_actions: + id: 'automation_actions:v00.00.00000' + name: automation_actions + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/automation_actions.yaml + title: PagerDuty API - Automation Actions + version: v00.00.00000 + description: Automation Actions + business_services: + id: 'business_services:v00.00.00000' + name: business_services + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/business_services.yaml + title: PagerDuty API - Business Services + version: v00.00.00000 + description: Business Services + change_events: + id: 'change_events:v00.00.00000' + name: change_events + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/change_events.yaml + title: PagerDuty API - Change Events + version: v00.00.00000 + description: Change Events + custom_fields: + id: 'custom_fields:v00.00.00000' + name: custom_fields + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/custom_fields.yaml + title: PagerDuty API - Custom Fields + version: v00.00.00000 + description: Custom Fields + escalation_policies: + id: 'escalation_policies:v00.00.00000' + name: escalation_policies + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/escalation_policies.yaml + title: PagerDuty API - Escalation Policies + version: v00.00.00000 + description: Escalation Policies + event_orchestrations: + id: 'event_orchestrations:v00.00.00000' + name: event_orchestrations + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/event_orchestrations.yaml + title: PagerDuty API - Event Orchestrations + version: v00.00.00000 + description: Event Orchestrations + extensions: + id: 'extensions:v00.00.00000' + name: extensions + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/extensions.yaml + title: PagerDuty API - Extensions + version: v00.00.00000 + description: | + Extensions Are Representations Of Extension Schema Objects That Are Attached To Services. + extension_schemas: + id: 'extension_schemas:v00.00.00000' + name: extension_schemas + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/extension_schemas.yaml + title: PagerDuty API - Extension Schemas + version: v00.00.00000 + description: Extension Schemas + incidents: + id: 'incidents:v00.00.00000' + name: incidents + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/incidents.yaml + title: PagerDuty API - Incidents + version: v00.00.00000 + description: | + An Incident Represents A Problem Or An Issue That Needs To Be Addressed And Resolved. Incidents Trigger On A Service, Which Prompts Notifications To Go Out To On-Call Responders Per The Service'S Escalation Policy. + incident_workflows: + id: 'incident_workflows:v00.00.00000' + name: incident_workflows + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/incident_workflows.yaml + title: PagerDuty API - Incident Workflows + version: v00.00.00000 + description: Incident Workflows + licenses: + id: 'licenses:v00.00.00000' + name: licenses + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/licenses.yaml + title: PagerDuty API - Licenses + version: v00.00.00000 + description: | + Licenses Are Allocated To Users To Allow For Per-User Access To PagerDuty Functionality Within An Account. + log_entries: + id: 'log_entries:v00.00.00000' + name: log_entries + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/log_entries.yaml + title: PagerDuty API - Log Entries + version: v00.00.00000 + description: Log Entries + maintenance_windows: + id: 'maintenance_windows:v00.00.00000' + name: maintenance_windows + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/maintenance_windows.yaml + title: PagerDuty API - Maintenance Windows + version: v00.00.00000 + description: Maintenance Windows + notifications: + id: 'notifications:v00.00.00000' + name: notifications + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/notifications.yaml + title: PagerDuty API - Notifications + version: v00.00.00000 + description: | + A Notification Is Created When An Incident Is Triggered Or Escalated. + on_calls: + id: 'on_calls:v00.00.00000' + name: on_calls + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/on_calls.yaml + title: PagerDuty API - On Calls + version: v00.00.00000 + description: | + 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 + paused_incident_reports: + id: 'paused_incident_reports:v00.00.00000' + name: paused_incident_reports + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/paused_incident_reports.yaml + title: PagerDuty API - Paused Incident Reports + version: v00.00.00000 + description: Paused Incident Reports + priorities: + id: 'priorities:v00.00.00000' + name: priorities + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/priorities.yaml + title: PagerDuty API - Priorities + version: v00.00.00000 + description: | + A Priority Is A Label Representing The Importance And Impact Of An Incident. This Feature Is Only Available On Standard And Enterprise Plans. + response_plays: + id: 'response_plays:v00.00.00000' + name: response_plays + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/response_plays.yaml + title: PagerDuty API - Response Plays + version: v00.00.00000 + description: Response Plays + rulesets: + id: 'rulesets:v00.00.00000' + name: rulesets + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/rulesets.yaml + title: PagerDuty API - Rulesets + version: v00.00.00000 + description: | + 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. + schedules: + id: 'schedules:v00.00.00000' + name: schedules + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/schedules.yaml + title: PagerDuty API - Schedules + version: v00.00.00000 + description: | + A Schedule Determines The Time Periods That Users Are On-Call. + services: + id: 'services:v00.00.00000' + name: services + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/services.yaml + title: PagerDuty API - Services + version: v00.00.00000 + description: | + A Service May Represent An Application, Component, Or Team You Wish To Open Incidents Against. + service_dependencies: + id: 'service_dependencies:v00.00.00000' + name: service_dependencies + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/service_dependencies.yaml + title: PagerDuty API - Service Dependencies + version: v00.00.00000 + description: Service Dependencies + status_dashboards: + id: 'status_dashboards:v00.00.00000' + name: status_dashboards + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/status_dashboards.yaml + title: PagerDuty API - Status Dashboards + version: v00.00.00000 + description: Status Dashboards + tags: + id: 'tags:v00.00.00000' + name: tags + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/tags.yaml + title: PagerDuty API - Tags + version: v00.00.00000 + description: | + A Tag Is Applied To Escalation Policies, Teams Or Users And Can Be Used To Filter Them. + teams: + id: 'teams:v00.00.00000' + name: teams + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/teams.yaml + title: PagerDuty API - Teams + version: v00.00.00000 + description: | + A Team Is A Collection Of Users And Escalation Policies That Represent A Group Of People Within An Organization. + templates: + id: 'templates:v00.00.00000' + name: templates + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/templates.yaml + title: PagerDuty API - Templates + version: v00.00.00000 + description: | + Templates Is A New Feature Which Will Allow Customers To Create Message Templates To Be Leveraged By (But Not Limited To) Status Updates. The API Will Be Secured To Customers With The Status Updates Entitlements. + users: + id: 'users:v00.00.00000' + name: users + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/users.yaml + title: PagerDuty API - Users + version: v00.00.00000 + description: | + Users Are Members Of A PagerDuty Account That Have The Ability To Interact With Incidents And Other Data On The Account. + vendors: + id: 'vendors:v00.00.00000' + name: vendors + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/vendors.yaml + title: PagerDuty API - Vendors + version: v00.00.00000 + description: | + A PagerDuty Vendor Represents A Specific Type Of Integration. AWS Cloudwatch, Splunk, Datadog Are All Examples Of Vendors + webhooks: + id: 'webhooks:v00.00.00000' + name: webhooks + preferred: true + service: + $ref: pagerduty/v00.00.00000/services/webhooks.yaml + title: PagerDuty API - Webhooks + version: v00.00.00000 + description: | + A Webhook Is A Way To Receive Events That Occur On The PagerDuty Platform Via An HTTP POST Request. + V3 Webhooks Are Set Up By Creating A Webhook Subscription. +config: + auth: + type: api_key + valuePrefix: Token token= + credentialsenvvar: PAGERDUTY_API_TOKEN diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/abilities.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/abilities.yaml new file mode 100644 index 0000000..97a24d8 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/abilities.yaml @@ -0,0 +1,2603 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + PaymentRequired: + description: | + Account does not have the abilities to perform the action. Please review the response for the required abilities. + You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + abilities: + id: pagerduty.abilities.abilities + name: abilities + title: Abilities + methods: + list_abilities: + operation: + $ref: '#/paths/~1abilities/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.abilities + _list_abilities: + operation: + $ref: '#/paths/~1abilities/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_ability: + operation: + $ref: '#/paths/~1abilities~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/abilities/methods/list_abilities' + insert: [] + update: [] + delete: [] +paths: + /abilities: + get: + x-pd-requires-scope: abilities.read + tags: + - Abilities + operationId: listAbilities + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#abilities) + + Scoped OAuth requires: `abilities.read` + summary: List abilities + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + responses: + '200': + description: An array of ability names. + content: + application/json: + schema: + allOf: + - type: object + properties: + abilities: + type: array + description: The set of abilities your account has. + items: + type: object + properties: + ability_name: + type: string + description: 'A single ability, as a name.' + readOnly: true + required: + - abilities + examples: + response: + summary: Example Response + value: + abilities: + - teams + - read_only_users + - service_support_hours + - urgencies + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/abilities/{id}': + get: + x-pd-requires-scope: abilities.read + tags: + - Abilities + operationId: getAbility + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#abilities) + + Scoped OAuth requires: `abilities.read` + summary: Test an ability + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '204': + description: The account has the requested ability. + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/add_ons.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/add_ons.yaml new file mode 100644 index 0000000..4f33f0d --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/add_ons.yaml @@ -0,0 +1,2950 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - add_ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + AddonReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + src: + type: string + format: url + description: The URL source of the Addon + name: + type: string + description: The user entered name of the Addon. + type: + type: string + enum: + - full_page_addon_reference + - incident_show_addon_reference + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + Addon: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + type: + type: string + description: The type of Add-on. + enum: + - full_page_addon + - incident_show_addon + name: + type: string + description: The name of the Add-on. + maxLength: 100 + src: + type: string + format: url + description: The source URL to display in a frame in the PagerDuty UI. HTTPS is required. + required: + - type + - name + - src + example: + type: full_page_addon + name: Internal Status Page + src: 'https://intranet.example.com/status' + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + addons: + id: pagerduty.add_ons.addons + name: addons + title: Addons + methods: + list_addon: + operation: + $ref: '#/paths/~1addons/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.addon + _list_addon: + operation: + $ref: '#/paths/~1addons/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_addon: + operation: + $ref: '#/paths/~1addons/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_addon: + operation: + $ref: '#/paths/~1addons~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.addon + _get_addon: + operation: + $ref: '#/paths/~1addons~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_addon: + operation: + $ref: '#/paths/~1addons~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_addon: + operation: + $ref: '#/paths/~1addons~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/addons/methods/get_addon' + - $ref: '#/components/x-stackQL-resources/addons/methods/list_addon' + insert: + - $ref: '#/components/x-stackQL-resources/addons/methods/create_addon' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/addons/methods/delete_addon' +paths: + /addons: + get: + x-pd-requires-scope: addons.read + tags: + - Add-ons + operationId: listAddon + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons) + + Scoped OAuth requires: `addons.read` + summary: List installed Add-ons + parameters: + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/include_addon' + - $ref: '#/components/parameters/addon_services' + - $ref: '#/components/parameters/addon_filter' + responses: + '200': + description: A paginated array of installed Add-ons. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + addons: + type: array + items: + $ref: '#/components/schemas/AddonReference' + required: + - addons + examples: + response: + summary: Example Response + value: + addons: + - id: PKX7619 + type: full_page_addon_reference + summary: Internal Status Page + self: 'https://api.pagerduty.com/addons/PKX7619' + html_url: null + name: Internal Status Page + src: 'https://intranet.example.com/status' + limit: 25 + offset: 0 + more: false + total: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + x-pd-requires-scope: addons.write + tags: + - Add-ons + operationId: createAddon + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons) + + Scoped OAuth requires: `addons.write` + summary: Install an Add-on + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + requestBody: + content: + application/json: + schema: + type: object + properties: + addon: + $ref: '#/components/schemas/Addon' + required: + - addon + examples: + request: + summary: Request Example + value: + addon: + type: full_page_addon + name: Internal Status Page + src: 'https://intranet.example.com/status' + description: The Add-on to be installed. + responses: + '201': + description: The Add-on that was installed. + content: + application/json: + schema: + type: object + properties: + addon: + $ref: '#/components/schemas/AddonReference' + required: + - addon + examples: + response: + summary: Response Example + value: + addon: + id: PKX7619 + type: full_page_addon_reference + summary: Internal Status Page + self: 'https://api.pagerduty.com/addons/PKX7619' + html_url: null + name: Internal Status Page + src: 'https://intranet.example.com/status' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/addons/{id}': + get: + x-pd-requires-scope: addons.read + tags: + - Add-ons + operationId: getAddon + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons) + + Scoped OAuth requires: `addons.read` + summary: Get an Add-on + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: The requested Add-on. + content: + application/json: + schema: + type: object + properties: + addon: + $ref: '#/components/schemas/Addon' + required: + - addon + examples: + response: + summary: Example Response + value: + addon: + id: PKX7F81 + type: incident_show_addon + name: Service Runbook + src: 'https://intranet.example.com/runbook.html' + services: + - id: PIJ90N7 + type: service + summary: My Application Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + delete: + x-pd-requires-scope: addons.write + tags: + - Add-ons + operationId: deleteAddon + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons) + + Scoped OAuth requires: `addons.write` + summary: Delete an Add-on + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '204': + description: The Add-on was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + x-pd-requires-scope: addons.write + tags: + - Add-ons + operationId: updateAddon + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons) + + Scoped OAuth requires: `addons.write` + summary: Update an Add-on + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + addon: + $ref: '#/components/schemas/Addon' + required: + - addon + examples: + request: + summary: Request Example + value: + addon: + type: full_page_addon + name: Internal Status Page + src: 'https://intranet.example.com/status' + description: The Add-on to be updated. + responses: + '200': + description: The Add-on that was updated. + content: + application/json: + schema: + type: object + properties: + addon: + $ref: '#/components/schemas/Addon' + required: + - addon + examples: + response: + summary: Response Example + value: + addon: + id: PKX7F81 + type: incident_show_addon + name: Service Runbook + src: 'https://intranet.example.com/runbook.html' + services: + - id: PIJ90N7 + type: service + summary: My Application Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/analytics.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/analytics.yaml new file mode 100644 index 0000000..c2455e1 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/analytics.yaml @@ -0,0 +1,3643 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - analytics + description: | + Provides enriched incident data. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + AnalyticsIncidentMetrics: + title: Analytics Incident Metrics + type: object + properties: + mean_assignment_count: + type: integer + description: Mean count of instances where responders were assigned an incident (including through reassignment or escalation) or accepted a responder request. + mean_engaged_seconds: + type: integer + description: |- + Mean engaged time across all responders for incidents that match the given filters. + Engaged time is measured from the time a user engages with an incident (by + acknowledging or accepting a responder request) until the incident is resolved. + This may include periods in which the incidents was snoozed. + mean_engaged_user_count: + type: integer + description: |- + Mean number of users who engaged with an incident. *Engaged* is defined as + acknowledging an incident or accepting a responder request in it. + mean_seconds_to_engage: + type: integer + description: |- + A measure of *people response time*. This metric measures the time from + the first user engagement (acknowledge or responder accept) to the last. + This metric is only used for incidents with **multiple responders**; + for incidents with one or no engaged users, this value is null. + mean_seconds_to_first_ack: + type: integer + description: 'Mean time between the start of an incident, and the first responder to acknowledge.' + mean_seconds_to_mobilize: + type: integer + description: |- + Mean time between the start of an incident, and the last additional responder + to acknowledge. For incidents with one or no engaged users, this value is null. + mean_seconds_to_resolve: + type: integer + description: Mean time from when an incident was triggered until it was resolved. + service_id: + type: string + description: ID of the service. Only included when aggregating by service. + service_name: + type: string + description: Name of the service. Only included when aggregating by service. + team_id: + type: string + description: ID of the team the incident was assigned to. + team_name: + type: string + description: Name of the team the incident was assigned to. + total_business_hour_interruptions: + type: integer + description: |- + Total number of unique interruptions during business hours. + Business hour: 8am-6pm Mon-Fri, based on the user’s time zone. + total_engaged_seconds: + type: integer + description: |- + Total engaged time across all responders for incidents. Engaged time is measured from + the time a user engages with an incident (by acknowledging or accepting a responder request) + until the incident is resolved. This may include periods in which the incidents was snoozed. + total_escalation_count: + type: integer + description: |- + Total count of instances where an incident is escalated between responders + assigned to an escalation policy. + total_incident_count: + type: integer + description: The total number of incidents that were created. + total_off_hour_interruptions: + type: integer + description: |- + Total number of unique interruptions during off hours. + Off hour: 6pm-10pm Mon-Fri and all day Sat-Sun, based on the user’s time zone. + total_sleep_hour_interruptions: + type: integer + description: |- + Total number of unique interruptions during sleep hours. + Sleep hour: 10pm-8am every day, based on the user’s time zone. + total_snoozed_seconds: + type: integer + description: Total number of seconds incidents were snoozed. + up_time_pct: + type: number + description: |- + The percentage of time in the defined date range that the service was not interrupted + by a [major incident](https://support.pagerduty.com/docs/operational-reviews#major-incidents). + AnalyticsModel: + type: object + properties: + filters: + type: object + description: Accepts a set of filters to apply to the Incidents before aggregating. Any incidents that do not match the included filters will be omitted from the results + properties: + created_at_start: + type: string + description: Accepts an ISO8601 DateTime string. Any incidents with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with created_at_end is one year. + example: '2020-01-01T00:00:00+05:00' + created_at_end: + type: string + description: Accepts an ISO8601 DateTime string. Any incidents with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with created_at_start is one year. + example: '2020-02-01T00:00:00Z' + urgency: + type: string + description: Any incidents whose urgency does not match the provided string will be omitted from the results. + example: high + enum: + - high + - low + major: + type: boolean + description: 'A boolean flag including whether results should contain *only* [major incidents](https://support.pagerduty.com/docs/operational-reviews#major-incidents), or exclude major incidents. If no value is provided all incidents will be included.' + example: true + team_ids: + type: array + description: 'An array of team IDs. Only incidents related to these teams will be included in the results. If omitted, all teams the requestor has access to will be included in the results.' + items: + type: string + example: + - P373JQQ + - PAECHJV + - P7SYGW6 + service_ids: + type: array + description: 'An array of service IDs. Only incidents related to these services will be included in the results. If omitted, all services the requestor has access to will be included in the results.' + items: + type: string + example: + - PSEJLIN + - PSLWBL8 + - PT4KHLX + priority_ids: + type: array + description: 'An array of priority IDs. Only incidents with these priorities will be included in the results. If omitted, all services the requestor has access to will be included in the results.' + items: + type: string + example: + - PC8O0L3 + - PX01HJD + - P5FK83M + priority_names: + type: array + description: 'An array of user-defined priority names. Only incidents with these priorities will be included in the results. If omitted, all services the requestor has access to will be included in the results.' + items: + type: string + example: + - P1 + - P2 + - P3 + time_zone: + type: string + description: The time zone to use for the results and grouping. + example: Etc/UTC + aggregate_unit: + type: string + description: 'The time unit to aggregate metrics by. If no value is provided, the metrics will be aggregated for the entire period.' + nullable: true + example: day + enum: + - day + - week + - month + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + AnalyticsRawIncident: + title: Analytics Raw Incident + type: object + properties: + assignment_count: + type: integer + description: Total count of instances where responders were assigned an incident (including through reassignment or escalation) or accepted a responder request. + business_hour_interruptions: + type: integer + description: |- + Total number of unique interruptions during business hour. + Business hour: 8am-6pm Mon-Fri, based on the user’s time zone. + created_at: + type: string + description: Timestamp of when the incident was created. + description: + type: string + description: The incident description + engaged_seconds: + type: integer + description: Total engaged time across all responders for this incident. Engaged time is measured from the time a user engages with an incident (by acknowledging or accepting a responder request) until the incident is resolved. This may include periods in which the incident was snoozed. + engaged_user_count: + type: integer + description: 'Total number of users who engaged (acknowledged, accepted responder request) in the incident.' + escalation_count: + type: integer + description: Total count of instances where an incident is escalated between responders assigned to an escalation policy. + id: + type: string + description: Incident ID + incident_number: + type: integer + description: The PagerDuty incident number + major: + type: boolean + description: 'An incident is classified as a [major incident](https://support.pagerduty.com/docs/operational-reviews#major-incidents) if it has one of the two highest priorities, or if multiple responders are added and acknowledge the incident.' + off_hour_interruptions: + type: integer + description: |- + Total number of unique interruptions during off hour. + Off hour: 6pm-10pm Mon-Fri and all day Sat-Sun, based on the user’s time zone. + priority_id: + type: string + nullable: true + description: ID of the incident's priority level. + priority_name: + type: string + nullable: true + description: The user-provided short name of the priority. + resolved_at: + type: string + description: Timestamp of when the incident was resolved. + seconds_to_engage: + type: integer + description: |- + A measure of *people response time*. This metric measures the time from + the first user engagement (acknowledge or responder accept) to the last. + This metric is only used for incidents with **multiple responders**; + for incidents with one or no engaged users, this value is null. + seconds_to_first_ack: + type: integer + description: 'Time between start of an incident, and the first responder to acknowledge.' + seconds_to_mobilize: + type: integer + description: 'Time between start of an incident, and the last additional responder to acknowledge. If an incident has one or less responders, the value will be null.' + seconds_to_resolve: + type: integer + description: Time from when incident triggered until it was resolved. + service_id: + type: string + description: ID of the service that the incident triggered on. + service_name: + type: string + description: Name of the service that the incident triggered on. + sleep_hour_interruptions: + type: integer + description: |- + Total number of unique interruptions during sleep hour. + Sleep hour: 10pm-8am every day, based on the user’s time zone. + snoozed_seconds: + type: integer + description: Total seconds the incident has been snoozed for. + team_id: + type: string + nullable: true + description: ID of the team the incident was assigned to. + team_name: + type: string + nullable: true + description: Name of the team the incident was assigned to. + urgency: + type: string + description: Notification level + user_defined_effort_seconds: + type: integer + description: |- + The total response effort in seconds, + [as defined by the user](https://support.pagerduty.com/docs/editing-incidents#edit-incident-duration). + nullable: true + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + metrics_incidents_all: + id: pagerduty.analytics.metrics_incidents_all + name: metrics_incidents_all + title: Metrics Incidents All + methods: + get_analytics_metrics_incidents_all: + operation: + $ref: '#/paths/~1analytics~1metrics~1incidents~1all/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metrics_incidents_all/methods/get_analytics_metrics_incidents_all' + insert: [] + update: [] + delete: [] + metrics_incidents_services: + id: pagerduty.analytics.metrics_incidents_services + name: metrics_incidents_services + title: Metrics Incidents Services + methods: + get_analytics_metrics_incidents_service: + operation: + $ref: '#/paths/~1analytics~1metrics~1incidents~1services/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metrics_incidents_services/methods/get_analytics_metrics_incidents_service' + insert: [] + update: [] + delete: [] + metrics_incidents_teams: + id: pagerduty.analytics.metrics_incidents_teams + name: metrics_incidents_teams + title: Metrics Incidents Teams + methods: + get_analytics_metrics_incidents_team: + operation: + $ref: '#/paths/~1analytics~1metrics~1incidents~1teams/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metrics_incidents_teams/methods/get_analytics_metrics_incidents_team' + insert: [] + update: [] + delete: [] + raw_incidents: + id: pagerduty.analytics.raw_incidents + name: raw_incidents + title: Raw Incidents + methods: + get_analytics_incidents: + operation: + $ref: '#/paths/~1analytics~1raw~1incidents/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_analytics_incidents_by_id: + operation: + $ref: '#/paths/~1analytics~1raw~1incidents~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $ + _get_analytics_incidents_by_id: + operation: + $ref: '#/paths/~1analytics~1raw~1incidents~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/raw_incidents/methods/get_analytics_incidents_by_id' + - $ref: '#/components/x-stackQL-resources/raw_incidents/methods/get_analytics_incidents' + insert: [] + update: [] + delete: [] + raw_incidents_responses: + id: pagerduty.analytics.raw_incidents_responses + name: raw_incidents_responses + title: Raw Incidents Responses + methods: + get_analytics_incident_responses_by_id: + operation: + $ref: '#/paths/~1analytics~1raw~1incidents~1{id}~1responses/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.responses + _get_analytics_incident_responses_by_id: + operation: + $ref: '#/paths/~1analytics~1raw~1incidents~1{id}~1responses/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/raw_incidents_responses/methods/get_analytics_incident_responses_by_id' + insert: [] + update: [] + delete: [] +paths: + /analytics/metrics/incidents/all: + post: + x-pd-requires-scope: analytics.read + summary: Get aggregated incident data + operationId: getAnalyticsMetricsIncidentsAll + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/AnalyticsIncidentMetrics' + - $ref: '#/components/schemas/AnalyticsModel' + examples: + Example Response: + value: + aggregate_unit: day + data: + - mean_assignment_count: 1 + mean_engaged_seconds: 366 + mean_engaged_user_count: 1 + mean_seconds_to_engage: 81 + mean_seconds_to_first_ack: 63 + mean_seconds_to_mobilize: 41 + mean_seconds_to_resolve: 380 + range_start: '2020-01-01T00:00:00.000000' + total_business_hour_interruptions: 81 + total_engaged_seconds: 3591 + total_escalation_count: 5 + total_incident_count: 124 + total_off_hour_interruptions: 20 + total_sleep_hour_interruptions: 21 + total_snoozed_seconds: 78 + filters: + create_range_start: '2020-01-01T00:00:00Z' + create_range_end: '2020-02-01T00:00:00Z' + time_zone: Etc/UTC + '400': + $ref: '#/components/responses/ArgumentError' + '429': + $ref: '#/components/responses/TooManyRequests' + parameters: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnalyticsModel' + examples: + Example Request: + value: + filters: + created_at_start: '2021-01-01T00:00:00-05:00' + created_at_end: '2021-01-31T00:00:00-05:00' + urgency: high + major: true + team_ids: + - PGVXG6U + - PNVU4U4 + service_ids: + - PQVUB8D + - PU2D9X3 + aggregate_unit: day + time_zone: Etc/UTC + description: Parameters and filters to apply to the dataset. + description: | + 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. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + + > 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. + + > **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API. + + Scoped OAuth requires: `analytics.read` + tags: + - Analytics + /analytics/metrics/incidents/services: + post: + x-pd-requires-scope: analytics.read + summary: Get aggregated service data + operationId: getAnalyticsMetricsIncidentsService + responses: + '200': + description: Currently the response only returns data for services that match the filters and have data. + content: + application/json: + schema: + allOf: + - type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/AnalyticsIncidentMetrics' + - $ref: '#/components/schemas/AnalyticsModel' + examples: + Example Response: + value: + aggregate_unit: week + data: + - mean_assignment_count: 1 + mean_engaged_seconds: 366 + mean_engaged_user_count: 1 + mean_seconds_to_engage: 81 + mean_seconds_to_first_ack: 63 + mean_seconds_to_mobilize: 41 + mean_seconds_to_resolve: 380 + service_id: PPSCXAN + service_name: Critical Prod Service 1 + team_id: P3XUQ75 + team_name: Engineering + total_business_hour_interruptions: 81 + total_engaged_seconds: 3591 + total_escalation_count: 5 + total_incident_count: 124 + total_off_hour_interruptions: 20 + total_sleep_hour_interruptions: 21 + total_snoozed_seconds: 78 + up_time_pct: 99.92677595628416 + - mean_assignment_count: 1 + mean_engaged_seconds: 366 + mean_engaged_user_count: 1 + mean_seconds_to_engage: 81 + mean_seconds_to_first_ack: 63 + mean_seconds_to_mobilize: 41 + mean_seconds_to_resolve: 380 + service_id: PPSCXAN + service_name: Meme Fetcher Bot + team_id: PDN84B1 + team_name: Marketing + total_business_hour_interruptions: 81 + total_engaged_seconds: 3591 + total_escalation_count: 5 + total_incident_count: 124 + total_off_hour_interruptions: 20 + total_sleep_hour_interruptions: 21 + total_snoozed_seconds: 78 + up_time_pct: 99.98747723132969 + filters: + created_at_start: '2020-06-17T17:27:27Z' + created_at_end: '2020-06-16T17:27:27Z' + time_zone: Etc/UTC + '400': + $ref: '#/components/responses/ArgumentError' + '429': + $ref: '#/components/responses/TooManyRequests' + parameters: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnalyticsModel' + examples: + Example Request: + value: + filters: + created_at_start: '2021-01-01T00:00:00-05:00' + created_at_end: '2021-01-31T00:00:00-05:00' + urgency: high + major: true + team_ids: + - PGVXG6U + - PNVU4U4 + service_ids: + - PQVUB8D + - PU2D9X3 + priority_ids: + - PITMC5Y + - PEHBBT8 + aggregate_unit: week + time_zone: Etc/UTC + description: Parameters and filters to apply to the dataset. + description: | + 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. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics). + 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. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + + > 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. + + > **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API. + + Scoped OAuth requires: `analytics.read` + tags: + - Analytics + /analytics/metrics/incidents/teams: + post: + x-pd-requires-scope: analytics.read + summary: Get aggregated team data + operationId: getAnalyticsMetricsIncidentsTeam + responses: + '200': + description: Currently the response only returns data for teams that match the filters and have data. + content: + application/json: + schema: + allOf: + - type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/AnalyticsIncidentMetrics' + - $ref: '#/components/schemas/AnalyticsModel' + examples: + Example Response: + value: + data: + - mean_assignment_count: 1 + mean_engaged_seconds: 366 + mean_engaged_user_count: 1 + mean_seconds_to_engage: 81 + mean_seconds_to_first_ack: 63 + mean_seconds_to_mobilize: 41 + mean_seconds_to_resolve: 380 + team_id: PPSCXAN + team_name: 'Best Team A #1' + total_business_hour_interruptions: 81 + total_engaged_seconds: 3591 + total_escalation_count: 5 + total_incident_count: 124 + total_off_hour_interruptions: 20 + total_sleep_hour_interruptions: 21 + total_snoozed_seconds: 78 + up_time_pct: 99.98861566484517 + - mean_assignment_count: 1 + mean_engaged_seconds: 366 + mean_engaged_user_count: 1 + mean_seconds_to_engage: 81 + mean_seconds_to_first_ack: 63 + mean_seconds_to_mobilize: 41 + mean_seconds_to_resolve: 380 + team_id: PPSCXAN + team_name: 'Best Team A #2' + total_business_hour_interruptions: 81 + total_engaged_seconds: 3591 + total_escalation_count: 5 + total_incident_count: 124 + total_off_hour_interruptions: 20 + total_sleep_hour_interruptions: 21 + total_snoozed_seconds: 78 + up_time_pct: 99.98483728172828 + filters: + created_at_start: '2020-06-17T17:27:27Z' + created_at_end: '2020-06-16T17:27:27Z' + aggregate_unit: day + time_zone: Etc/UTC + '400': + $ref: '#/components/responses/ArgumentError' + '429': + $ref: '#/components/responses/TooManyRequests' + parameters: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnalyticsModel' + examples: + Example Request: + value: + filters: + created_at_start: '2021-01-01T00:00:00-05:00' + created_at_end: '2021-01-31T00:00:00-05:00' + urgency: high + major: true + team_ids: + - PGVXG6U + - PNVU4U4 + service_ids: + - PQVUB8D + - PU2D9X2 + priority_ids: + - PITMC5Y + - PEHBBT8 + aggregate_unit: week + time_zone: Etc/UTC + description: Parameters and filters to apply to the dataset. + description: | + 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. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics). + 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. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + + > 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. + + > **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API. + + Scoped OAuth requires: `analytics.read` + tags: + - Analytics + /analytics/raw/incidents: + post: + x-pd-requires-scope: analytics.read + summary: Get raw data - multiple incidents + operationId: getAnalyticsIncidents + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + first: + type: string + description: Cursor to identify the first object in the response. + last: + type: string + description: Cursor to identify the last object in the response. + limit: + type: integer + description: Number of results to include in the batch. + more: + type: boolean + description: Indicates if there are more resources available than were returned. + order: + type: string + description: 'The order in which the results were sorted; asc for ascending, desc for descending.' + enum: + - asc + - desc + order_by: + type: string + description: The column that was used for ordering the results. + enum: + - created_at + - seconds_to_resolve + filters: + type: object + description: A collection of filters that were applied to the results. + properties: + created_at_start: + type: string + description: The lower boundary for the created_at range filter applied to the results. + created_at_end: + type: string + description: The upper boundary for the created_at range filter applied to the results. + urgency: + type: string + description: The urgency filter applied to the results. + enum: + - high + - low + major: + type: boolean + description: 'The [major incident](https://support.pagerduty.com/docs/operational-reviews#major-incidents) filter applied to the results.' + team_ids: + type: array + description: The team_ids filter applied to the results. + items: + type: string + service_ids: + type: array + description: The service_ids filter applied to the results. + items: + type: string + priority_ids: + type: array + description: The priority_ids filter applied to the results. + maxItems: 5 + items: + type: string + priority_names: + type: array + description: The priority_names filter applied to the results. + maxItems: 5 + items: + type: string + time_zone: + type: string + description: The time zone that the results are in. + data: + type: array + items: + $ref: '#/components/schemas/AnalyticsRawIncident' + required: + - first + - last + - limit + - more + - order + - order_by + - time_zone + - data + examples: + Example Response: + value: + data: + - assignment_count: 4 + business_hour_interruptions: 5 + created_at: '2020-05-31T10:05:00' + description: The server is on fire! + engaged_seconds: 3510 + engaged_user_count: 10 + escalation_count: 1 + id: PYC0H08 + incident_number: 928 + major: false + off_hour_interruptions: 4 + priority_id: null + priority_name: null + resolved_at: '2020-05-31T10:15:00' + seconds_to_engage: 70 + seconds_to_first_ack: 5 + seconds_to_mobilize: 19 + seconds_to_resolve: 3305 + service_id: PPSCXAN + service_name: Engineering + sleep_hour_interruptions: 3 + snoozed_seconds: 604 + team_id: null + team_name: null + urgency: low + user_defined_effort_seconds: null + - assignment_count: 1 + business_hour_interruptions: 2 + created_at: '2020-05-31T10:05:00' + description: Reply on social media + engaged_seconds: 521 + engaged_user_count: 6 + escalation_count: 1 + id: PCOOHCY + incident_number: 929 + major: false + off_hour_interruptions: 3 + priority_id: POTCOTX + priority_name: SEV-2 + resolved_at: '2020-05-31T10:15:00' + seconds_to_engage: 24 + seconds_to_first_ack: 48 + seconds_to_mobilize: 122 + seconds_to_resolve: 2029 + service_id: PPSCXAN + service_name: Social media tracking + sleep_hour_interruptions: 1 + snoozed_seconds: 698 + team_id: null + team_name: Marketing + urgency: low + user_defined_effort_seconds: null + ending_before: null + filters: {} + first: PYC0H08 + last: PCOOHCY + limit: 10 + more: true + order: desc + order_by: created_at + starting_after: null + time_zone: Etc/UTC + '400': + $ref: '#/components/responses/ArgumentError' + '429': + $ref: '#/components/responses/TooManyRequests' + parameters: [] + requestBody: + content: + application/json: + schema: + type: object + properties: + filters: + type: object + description: 'Filters the result, only show incidents that match the conditions passed in the filter.' + properties: + created_at_start: + type: string + description: 'Filters the result, showing only the incidents where the creation timestamp is greater than the filter value.' + example: '2020-05-01T00:00:00-04:00' + created_at_end: + type: string + description: 'Filters the result, showing only the incidents where the creation timestamp is less than the filter value.' + example: '2020-06-01T00:00:00-04:00' + urgency: + type: string + description: 'Filters the result, showing only the incidents where urgency matches the filter value.' + example: high + major: + type: boolean + description: 'An incident is classified as a [major incident](https://support.pagerduty.com/docs/operational-reviews#major-incidents) if it has one of the two highest priorities, or if multiple responders are added and acknowledge the incident.' + example: true + team_ids: + type: array + description: An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter. + items: + type: string + example: + - P373JQQ + - PAECHJV + - P7SYGW6 + service_ids: + type: array + description: An array of service IDs. Only results related to these services will be returned. + items: + type: string + example: + - PC8O0L3 + - PX01HJD + - P5FK83M + priority_ids: + type: array + description: The priority_ids filter applied to the results. + items: + type: string + example: + - PITMC5Y + - PEHBBT8 + - PB8QADI + priority_names: + type: array + description: The priority_names filter applied to the results. + items: + type: string + example: + - P1 + - P2 + - P3 + starting_after: + type: string + description: A cursor to indicate the reference point that the results should follow + ending_before: + type: string + description: A cursor to indicate the reference point that the results should precede + order: + type: string + description: 'The order the results; asc for ascending, desc for descending. Defaults to ''desc''.' + enum: + - asc + - desc + order_by: + type: string + description: The column to use for ordering the results. Defaults to 'created_at'. + enum: + - created_at + - seconds_to_resolve + limit: + type: integer + description: |- + Number of results to include in each batch. + Limits between 1 to 1000 are accepted. + example: 20 + minimum: 0 + exclusiveMinimum: true + maximum: 1000 + exclusiveMaximum: false + time_zone: + type: string + description: The time zone to use for the results. + example: Etc/UTC + examples: + Example Request: + value: + filters: + created_at_start: '2021-01-01T00:00:00-05:00' + created_at_end: '2021-01-31T00:00:00-05:00' + urgency: high + major: true + team_ids: + - PGVXG6U + - PNVU4U4 + service_ids: + - PQVUB8D + - PU2D9X3 + priority_names: + - P1 + - P2 + limit: 20 + order: desc + order_by: created_at + time_zone: Etc/UTC + description: Parameters and filters to apply to the dataset. + description: | + Provides enriched incident data and metrics for multiple incidents. + + Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics). + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + + > 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. + + > **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API. + + Scoped OAuth requires: `analytics.read` + tags: + - Analytics + '/analytics/raw/incidents/{id}': + get: + x-pd-requires-scope: analytics.read + summary: Get raw data - single incident + tags: + - Analytics + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/AnalyticsRawIncident' + examples: + Example Response: + value: + time_zone: Etc/UTC + data: + assignment_count: 0 + business_hour_interruptions: 0 + created_at: '2019-12-01T21:00:00Z' + description: The server is on fire! + engaged_seconds: 75 + engaged_user_count: 2 + escalation_count: 0 + id: PJASD33 + incident_number: 924 + major: true + off_hour_interruptions: 2 + priority_id: PZOZQXA + priority_name: SEV-1 + resolved_at: '2019-12-01T21:01:00Z' + seconds_to_engage: 30 + seconds_to_first_ack: 15 + seconds_to_mobilize: 15 + seconds_to_resolve: 60 + service_id: PAQTPI2 + service_name: Engineering + sleep_hour_interruptions: 0 + snoozed_seconds: 0 + team_id: PNVU4UR + team_name: Engineering team 7 + urgency: high + user_defined_effort_seconds: null + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + operationId: getAnalyticsIncidentsById + description: | + 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. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics). + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + + > **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API. + + Scoped OAuth requires: `analytics.read` + parameters: + - $ref: '#/components/parameters/id' + '/analytics/raw/incidents/{id}/responses': + get: + x-pd-requires-scope: analytics.read + summary: Get raw responses from a single incident + tags: + - Analytics + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + incident_id: + type: string + description: The Incident ID passed in to the request. + limit: + type: integer + description: Number of results to include in the batch. + order: + type: string + description: 'The order in which the results were sorted; asc for ascending, desc for descending.' + enum: + - asc + - desc + order_by: + type: string + description: The column that was used for ordering the results. + enum: + - requested_at + time_zone: + type: string + description: The time zone that the results are in. + responses: + type: array + items: + title: Analytics Raw Incident Responses + type: object + properties: + responder_name: + type: string + description: Name of the user associated with the Incident Response. + responder_id: + type: string + description: ID of the user associated with the Incident Response. + response_status: + type: string + description: Status of the user's interaction with the Incident notification. + enum: + - joined + - pending + - declined + responder_type: + type: string + description: |- + Type of responder, where `assigned` means the user was added to the Incident via Assignment at Incident creation, + `reassigned` means the user was added to the Incident via Reassignment, `escalated` means the user was added via Escalation, + and `added_responder` means the user was added via Responder Reqeuest. + enum: + - assigned + - reassigned + - escalated + - added_responder + requested_at: + type: string + description: Timestamp of when the user was requested. + responded_at: + type: string + description: Timestamp of when the user responded to the request. + time_to_respond_seconds: + type: integer + description: 'Measures the time it took for the user to respond to the Incident request. In other words, `responded_at - requested_at`.' + examples: + Example Response: + value: + incident_id: ABCDEFGHIJKLMN + limit: 100 + order: asc + order_by: requested_at + time_zone: Etc/UTC + responses: + responder_name: Earline Greenholt + responder_id: PXPGF42 + response_status: accepted + responder_type: added_responder + requested_at: '2023-01-05T10:15:00' + responded_at: '2023-01-05T10:18:00' + time_to_respond_seconds: 180 + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + requestBody: + content: + application/json: + schema: + type: object + properties: + limit: + type: integer + description: |- + Number of results to include in each batch. + Limits between 1 to 1000 are accepted. + example: 20 + minimum: 0 + exclusiveMinimum: true + maximum: 1000 + exclusiveMaximum: false + order: + type: string + description: 'The order the results; asc for ascending, desc for descending. Defaults to `desc`.' + enum: + - asc + - desc + order_by: + type: string + description: The column to use for ordering the results. + enum: + - requested_at + time_zone: + type: string + description: The time zone to use for the results. + example: Etc/UTC + examples: + Example Request: + value: + limit: 20 + order: desc + order_by: requested_at + time_zone: America/Los_Angeles + description: Parameters to apply to the dataset. + operationId: getAnalyticsIncidentResponsesById + description: | + Provides enriched responder data for a single incident. + + Example metrics include Time to Respond, Responder Type, and Response Status. See metric definitions below. + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + + > **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incident responses appear in the Analytics API. + Scoped OAuth requires: `analytics.read` + parameters: + - $ref: '#/components/parameters/id' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/audit.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/audit.yaml new file mode 100644 index 0000000..6fa0234 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/audit.yaml @@ -0,0 +1,2812 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - audit + description: | + Provides audit record data. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + AuditRecordResponseSchema: + allOf: + - type: object + properties: + records: + type: array + items: + $ref: '#/components/schemas/AuditRecord' + response_metadata: + nullable: true + anyOf: + - $ref: '#/components/schemas/AuditMetadata' + required: + - records + - $ref: '#/components/schemas/CursorPagination' + AuditRecord: + type: object + readOnly: true + description: An Audit Trail record + properties: + id: + type: string + self: + type: string + nullable: true + description: Record URL. + execution_time: + type: string + format: date-time + description: 'The date/time the action executed, in ISO8601 format and millisecond precision.' + execution_context: + type: object + description: Action execution context + properties: + request_id: + type: string + nullable: true + description: Request Id + remote_address: + type: string + nullable: true + description: remote address + nullable: true + actors: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + method: + type: object + description: The method information + properties: + description: + type: string + nullable: true + truncated_token: + description: Truncated token containing the last 4 chars of the token's actual value. + type: string + nullable: true + example: 3xyz + type: + $ref: '#/components/parameters/audit_method_type/schema' + required: + - type + root_resource: + $ref: '#/components/schemas/Reference' + action: + type: string + example: create + details: + type: object + nullable: true + description: | + Additional details to provide further information about the action or + the resource that has been audited. + properties: + resource: + $ref: '#/components/schemas/Reference' + fields: + description: | + A set of fields that have been affected. + The fields that have not been affected MAY be returned. + type: array + nullable: true + items: + type: object + description: | + Information about the affected field. + When available, field's before and after values are returned: + + #### Resource creation + - `value` MAY be returned + + #### Resource update + - `value` MAY be returned + - `before_value` MAY be returned + + #### Resource deletion + - `before_value` MAY be returned + properties: + name: + type: string + description: Name of the resource field + example: name + description: + type: string + nullable: true + description: Human readable description of the resource field + example: First and Last name + value: + type: string + nullable: true + description: new or updated value of the field + example: Jonathan + before_value: + type: string + nullable: true + description: previous or deleted value of the field + example: John + required: + - name + references: + description: A set of references that have been affected. + type: array + nullable: true + items: + type: object + properties: + name: + type: string + description: Name of the reference field + example: team_members + description: + type: string + nullable: true + description: Human readable description of the references field + example: First and Last name + added: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + removed: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + required: + - name + required: + - resource + required: + - id + - execution_time + - method + - root_resource + - action + AuditMetadata: + type: object + properties: + messages: + type: array + nullable: true + items: + type: string + example: Message about the result + CursorPagination: + type: object + properties: + limit: + type: integer + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + readOnly: true + next_cursor: + type: string + description: | + An opaque string than will deliver the next set of results when provided as the `cursor` parameter in a subsequent request. A `null` value for this field indicates that there are no additional results. + example: dXNlcjaVMzc5V0ZYTlo= + nullable: true + readOnly: true + required: + - limit + - next_cursor + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + PaymentRequired: + description: | + Account does not have the abilities to perform the action. Please review the response for the required abilities. + You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + InternalServerError: + description: Internal Server Error the PagerDuty server experienced an error. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + records: + id: pagerduty.audit.records + name: records + title: Records + methods: + list_audit_records: + operation: + $ref: '#/paths/~1audit~1records/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.records + _list_audit_records: + operation: + $ref: '#/paths/~1audit~1records/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/records/methods/list_audit_records' + insert: [] + update: [] + delete: [] +paths: + /audit/records: + get: + x-pd-requires-scope: audit_records.read + summary: List audit records + tags: + - Audit + operationId: listAuditRecords + description: | + 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` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/cursor_limit' + - $ref: '#/components/parameters/cursor_cursor' + - $ref: '#/components/parameters/audit_since' + - $ref: '#/components/parameters/audit_until' + - $ref: '#/components/parameters/audit_root_resource_types' + - $ref: '#/components/parameters/audit_actor_type' + - $ref: '#/components/parameters/audit_actor_id' + - $ref: '#/components/parameters/audit_method_type' + - $ref: '#/components/parameters/audit_method_truncated_token' + - $ref: '#/components/parameters/audit_actions' + responses: + '200': + description: Records matching the query criteria. + content: + application/json: + schema: + $ref: '#/components/schemas/AuditRecordResponseSchema' + examples: + response: + $ref: '#/components/examples/AuditRecordResponse' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/automation_actions.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/automation_actions.yaml new file mode 100644 index 0000000..d6b095e --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/automation_actions.yaml @@ -0,0 +1,4946 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - automation_actions + description: Automation_Actions +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + AutomationActionsScriptActionPostBody: + allOf: + - $ref: '#/components/schemas/AutomationActionsAbstractActionPostBody' + - type: object + properties: + action_data_reference: + $ref: '#/components/schemas/AutomationActionsScriptActionDataReference' + required: + - action_data_reference + AutomationActionsProcessAutomationJobActionPostBody: + allOf: + - $ref: '#/components/schemas/AutomationActionsAbstractActionPostBody' + - type: object + properties: + action_data_reference: + $ref: '#/components/schemas/AutomationActionsProcessAutomationJobActionDataReference' + required: + - action_data_reference + AutomationActionsScriptActionWithTeams: + allOf: + - $ref: '#/components/schemas/AutomationActionsScriptAction' + - type: object + properties: + teams: + type: array + items: + $ref: '#/components/schemas/TeamReference' + AutomationActionsProcessAutomationJobActionWithTeams: + allOf: + - $ref: '#/components/schemas/AutomationActionsProcessAutomationJobAction' + - type: object + properties: + teams: + type: array + items: + $ref: '#/components/schemas/TeamReference' + AutomationActionsAbstractActionPostBody: + type: object + properties: + name: + type: string + example: Restart apache + maxLength: 255 + description: + type: string + example: Restarts apache on the us-west-2-shopping-cart host + maxLength: 1024 + action_classification: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + action_type: + $ref: '#/components/parameters/automation_actions_action_type/schema' + runner: + type: string + example: 1a6763bd-b1ad-458f-a347-6c8a9bea2d70 + maxLength: 36 + services: + nullable: false + type: array + items: + $ref: '#/components/schemas/ServiceReference' + teams: + nullable: false + type: array + items: + $ref: '#/components/schemas/TeamReference' + required: + - name + - description + - action_type + AutomationActionsScriptActionDataReference: + type: object + properties: + script: + type: string + description: 'Body of the script to be executed on the Runner. To execute it, the Runner will write the content of the property into a temp file, make the file executable and execute it. It is assumed that the Runner has a properly configured environment to run the script as an executable file. This behaviour can be altered by providing the `invocation_command` property. The maxLength value is specified in bytes.' + example: print("Hello from a Python script!") + maxLength: 16777215 + invocation_command: + type: string + description: 'The command to executed a script with. With the body of the script written into a temp file, the Runner will execute the ` ` command. The maxLength value is specified in bytes.' + example: /usr/local/bin/python3 + maxLength: 65535 + required: + - script + AutomationActionsProcessAutomationJobActionDataReference: + type: object + properties: + process_automation_job_id: + type: string + example: 79c199bba1aff6e519f198457f5ec0fc + maxLength: 36 + process_automation_job_arguments: + type: string + description: Arguments to pass to the Process Automation job. The maxLength value is specified in bytes. + example: '-env production' + maxLength: 1024 + process_automation_node_filter: + type: string + description: 'Node filter for the Process Automation job. The maxLength value is specified in bytes. Filter syntax: https://docs.rundeck.com/docs/manual/11-node-filters.html#node-filter-syntax' + example: 'mynode1 !nodename: mynode2' + maxLength: 1024 + required: + - process_automation_job_id + AutomationActionsScriptAction: + allOf: + - $ref: '#/components/schemas/AutomationActionsAbstractAction' + - type: object + properties: + action_data_reference: + $ref: '#/components/schemas/AutomationActionsScriptActionDataReference' + required: + - action_data_reference + TeamReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - team_reference + AutomationActionsProcessAutomationJobAction: + allOf: + - $ref: '#/components/schemas/AutomationActionsAbstractAction' + - type: object + properties: + action_data_reference: + $ref: '#/components/schemas/AutomationActionsProcessAutomationJobActionDataReference' + required: + - action_data_reference + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + ServiceReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - service_reference + AutomationActionsAbstractAction: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + description: 'A unit of work to be executed on runner. At most, an account can have 10,000 actions. If action maximum is exceeded, a 400 reponse is returned with error message.' + properties: + name: + type: string + example: Restart apache + description: + type: string + example: Restarts apache on the us-west-2-shopping-cart host + action_type: + $ref: '#/components/parameters/automation_actions_action_type/schema' + action_classification: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + runner: + type: string + maxLength: 36 + runner_type: + $ref: '#/components/schemas/AutomationActionsRunnerTypeEnum' + services: + type: array + items: + $ref: '#/components/schemas/ServiceReference' + privileges: + $ref: '#/components/schemas/AutomationActionsUserPermissions' + metadata: + type: object + creation_time: + type: string + format: date-time + description: The date/time + modify_time: + type: string + format: date-time + description: The date/time + last_run: + type: string + format: date-time + description: The date/time + last_run_by: + oneOf: + - $ref: '#/components/schemas/UserReference' + - type: object + properties: + id: + type: string + example: /5471da24-eecd-42e2-ac38-a32b2d907406/service/P000000 + type: + type: string + example: event_orchestration_reference + required: + - type + - id + - $ref: '#/components/schemas/Template/allOf/1/properties/created_by/oneOf/1' + required: + - id + - type + - action_type + - name + - creation_time + - modify_time + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + AutomationActionsRunnerTypeEnum: + description: | + sidecar -- The runner is backed by an external sidecar that polls for invocations. + runbook -- The runner communicates directly with a runbook instance. + type: string + enum: + - sidecar + - runbook + example: runbook + AutomationActionsUserPermissions: + type: object + properties: + permissions: + nullable: false + type: array + items: + type: string + enum: + - create + - update + - delete + - invoke + example: + - update + - delete + required: + - permissions + UserReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - user_reference + Template: + allOf: + - $ref: '#/components/schemas/EditableTemplate' + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + type: + type: string + enum: + - template + created_by: + description: User/Account object reference of the creator + oneOf: + - $ref: '#/components/schemas/UserReference' + - allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - account_reference + updated_by: + description: User/Account object reference of the updator + oneOf: + - $ref: '#/components/schemas/UserReference' + - $ref: '#/components/schemas/Template/allOf/1/properties/created_by/oneOf/1' + EditableTemplate: + type: object + properties: + template_type: + type: string + description: The type of template (`status_update` is the only supported template at this time) + enum: + - status_update + name: + type: string + description: The name of the template + description: + type: string + nullable: true + description: Description of the template + templated_fields: + type: object + properties: + email_subject: + type: string + nullable: true + description: The subject of the e-mail + email_body: + type: string + nullable: true + description: The HTML body of the e-mail message + message: + type: string + nullable: true + description: |- + The short-message of the template (SMS, Push notification, Slack, + etc) + CursorPagination: + type: object + properties: + limit: + type: integer + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + readOnly: true + next_cursor: + type: string + description: | + An opaque string than will deliver the next set of results when provided as the `cursor` parameter in a subsequent request. A `null` value for this field indicates that there are no additional results. + example: dXNlcjaVMzc5V0ZYTlo= + nullable: true + readOnly: true + required: + - limit + - next_cursor + AutomationActionsScriptActionPutBody: + allOf: + - $ref: '#/components/schemas/AutomationActionsAbstractActionPutBody' + - type: object + properties: + action_data_reference: + $ref: '#/components/schemas/AutomationActionsScriptActionDataReference' + required: + - action_data_reference + AutomationActionsProcessAutomationJobActionPutBody: + allOf: + - $ref: '#/components/schemas/AutomationActionsAbstractActionPutBody' + - type: object + properties: + action_data_reference: + $ref: '#/components/schemas/AutomationActionsProcessAutomationJobActionDataReference' + required: + - action_data_reference + AutomationActionsAbstractActionPutBody: + type: object + properties: + name: + type: string + example: Restart apache + maxLength: 255 + description: + type: string + example: Restarts apache on the us-west-2-shopping-cart host + maxLength: 1024 + action_classification: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + action_type: + $ref: '#/components/parameters/automation_actions_action_type/schema' + runner: + type: string + maxLength: 36 + required: + - name + - description + - action_type + AutomationActionsInvocation: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + action_snapshot: + allOf: + - type: object + properties: + name: + type: string + example: Restart apache + action_type: + $ref: '#/components/parameters/automation_actions_action_type/schema' + required: + - action_type + - name + - type: object + properties: + action_data_reference: + oneOf: + - $ref: '#/components/schemas/AutomationActionsProcessAutomationJobActionDataReference' + - $ref: '#/components/schemas/AutomationActionsScriptActionDataReference' + runner_id: + type: string + timing: + description: A list of state transitions with timestamps. Only the 'created' transition is guaranteed to exist at any time. + type: array + items: + type: object + properties: + timestamp: + type: string + format: date-time + description: The date/time + state: + $ref: '#/components/parameters/automation_actions_invocation_state/schema' + required: + - timestamp + - state + duration: + description: The duration of the invocation's execution time. + example: 23 + type: integer + state: + $ref: '#/components/parameters/automation_actions_invocation_state/schema' + action_id: + type: string + metadata: + type: object + properties: + agent: + oneOf: + - $ref: '#/components/schemas/UserReference' + - $ref: '#/components/schemas/AutomationActionsAbstractAction/allOf/1/properties/last_run_by/oneOf/1' + - $ref: '#/components/schemas/Template/allOf/1/properties/created_by/oneOf/1' + incident: + $ref: '#/components/schemas/IncidentReference' + required: + - agent + required: + - id + - type + - action_snapshot + - runner_id + - timing + - state + - action_id + - metadata + IncidentReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - incident_reference + AutomationActionsRunnerSidecarPostBody: + allOf: + - $ref: '#/components/schemas/AutomationActionsRunnerSidecarBody' + - type: object + properties: + runner_type: + $ref: '#/components/schemas/AutomationActionsRunnerTypeEnum' + teams: + type: array + description: The list of teams associated with the Runner + items: + $ref: '#/components/schemas/TeamReference' + required: + - runner_type + AutomationActionsRunnerRunbookPostBody: + allOf: + - $ref: '#/components/schemas/AutomationActionsRunnerRunbookBody' + - type: object + properties: + runner_type: + $ref: '#/components/schemas/AutomationActionsRunnerTypeEnum' + teams: + type: array + description: The list of teams associated with the Runner + items: + $ref: '#/components/schemas/TeamReference' + required: + - runner_type + - runbook_base_uri + - runbook_api_key + AutomationActionsRunner: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + description: 'A remote entity capable of executing work specified by an action. At maximum, an account can have 1000 runners. If runner maximum is exceeded, a 400 response is returned with error message.' + properties: + runner_type: + $ref: '#/components/schemas/AutomationActionsRunnerTypeEnum' + name: + type: string + example: us-west-2 prod runner + description: + type: string + example: us-west-2 runner provisioned in the production environment by the SRE team + last_seen: + type: string + format: date-time + status: + $ref: '#/components/schemas/AutomationActionsRunnerStatusEnum' + creation_time: + type: string + format: date-time + runbook_base_uri: + $ref: '#/components/schemas/AutomationActionsRunbookBaseURI' + teams: + type: array + readOnly: true + description: The list of teams associated with the Runner + items: + $ref: '#/components/schemas/TeamReference' + privileges: + $ref: '#/components/schemas/AutomationActionsUserPermissions' + associated_actions: + description: References to at most 3 actions associated with the Runner. Use appropriate endpoints to retrieve the full list of associated actions. + allOf: + - type: object + properties: + actions: + nullable: false + type: array + items: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - action_reference + required: + - actions + - type: object + required: + - more + properties: + more: + type: boolean + description: Indicates whether more actions exist for the Runner. + metadata: + type: object + description: Additional metadata + required: + - id + - type + - name + - runner_type + - status + - creation_time + AutomationActionsRunnerSidecarBody: + allOf: + - $ref: '#/components/schemas/AutomationActionsRunnerBody' + AutomationActionsRunnerRunbookBody: + allOf: + - $ref: '#/components/schemas/AutomationActionsRunnerBody' + - type: object + properties: + runbook_base_uri: + type: string + description: 'The base URI of the Runbook server to connect to. May only contain alphanumeric characters, periods, underscores and dashes. If omitted, the previously stored value will remain unchanged.' + maxLength: 255 + example: subdomain + runbook_api_key: + type: string + maxLength: 64 + description: 'The API key to connect to the Runbook server with. If omitted, the previously stored value will remain unchanged.' + AutomationActionsRunnerStatusEnum: + description: | + Configured -- Runner has connected to the backend at least once + NotConfigured -- Runner has never connected to backend + type: string + enum: + - Configured + - NotConfigured + example: Configured + AutomationActionsRunbookBaseURI: + type: string + description: 'The base URI of the Runbook server to connect to. May only contain alphanumeric characters, periods, underscores and dashes.' + maxLength: 255 + example: subdomain + AutomationActionsRunnerBody: + type: object + properties: + name: + type: string + maxLength: 255 + example: us-west-2 prod runner + description: + type: string + maxLength: 1024 + example: us-west-2 runner provisioned in the production environment by the SRE team + required: + - name + - description + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + PaymentRequired: + description: | + Account does not have the abilities to perform the action. Please review the response for the required abilities. + You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + InternalServerError: + description: Internal Server Error the PagerDuty server experienced an error. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + actions: + id: pagerduty.automation_actions.actions + name: actions + title: Actions + methods: + create_automation_action: + operation: + $ref: '#/paths/~1automation_actions~1actions/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_all_automation_actions: + operation: + $ref: '#/paths/~1automation_actions~1actions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.actions + _get_all_automation_actions: + operation: + $ref: '#/paths/~1automation_actions~1actions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_automation_action: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.action + _get_automation_action: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_automation_action: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_automation_action: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create_automation_action_invocation: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}~1invocations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/actions/methods/get_automation_action' + - $ref: '#/components/x-stackQL-resources/actions/methods/get_all_automation_actions' + insert: + - $ref: '#/components/x-stackQL-resources/actions/methods/create_automation_action_invocation' + - $ref: '#/components/x-stackQL-resources/actions/methods/create_automation_action' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/actions/methods/delete_automation_action' + actions_services: + id: pagerduty.automation_actions.actions_services + name: actions_services + title: Actions Services + methods: + get_automation_actions_action_service_associations: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}~1services/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.services + _get_automation_actions_action_service_associations: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}~1services/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_automation_action_service_assocation: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}~1services/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_automation_actions_action_service_association: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}~1services~1{service_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.service + _get_automation_actions_action_service_association: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}~1services~1{service_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_automation_action_service_association: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}~1services~1{service_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/actions_services/methods/get_automation_actions_action_service_association' + - $ref: '#/components/x-stackQL-resources/actions_services/methods/get_automation_actions_action_service_associations' + insert: + - $ref: '#/components/x-stackQL-resources/actions_services/methods/create_automation_action_service_assocation' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/actions_services/methods/delete_automation_action_service_association' + actions_teams: + id: pagerduty.automation_actions.actions_teams + name: actions_teams + title: Actions Teams + methods: + create_automation_action_team_association: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}~1teams/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_automation_actions_action_team_associations: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}~1teams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.teams + _get_automation_actions_action_team_associations: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}~1teams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_automation_action_team_association: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}~1teams~1{team_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + get_automation_actions_action_team_association: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}~1teams~1{team_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.team + _get_automation_actions_action_team_association: + operation: + $ref: '#/paths/~1automation_actions~1actions~1{id}~1teams~1{team_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/actions_teams/methods/get_automation_actions_action_team_association' + - $ref: '#/components/x-stackQL-resources/actions_teams/methods/get_automation_actions_action_team_associations' + insert: + - $ref: '#/components/x-stackQL-resources/actions_teams/methods/create_automation_action_team_association' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/actions_teams/methods/delete_automation_action_team_association' + invocations: + id: pagerduty.automation_actions.invocations + name: invocations + title: Invocations + methods: + list_automation_action_invocations: + operation: + $ref: '#/paths/~1automation_actions~1invocations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.invocations + _list_automation_action_invocations: + operation: + $ref: '#/paths/~1automation_actions~1invocations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_automation_actions_invocation: + operation: + $ref: '#/paths/~1automation_actions~1invocations~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.invocation + _get_automation_actions_invocation: + operation: + $ref: '#/paths/~1automation_actions~1invocations~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/invocations/methods/get_automation_actions_invocation' + - $ref: '#/components/x-stackQL-resources/invocations/methods/list_automation_action_invocations' + insert: [] + update: [] + delete: [] + runners: + id: pagerduty.automation_actions.runners + name: runners + title: Runners + methods: + create_automation_actions_runner: + operation: + $ref: '#/paths/~1automation_actions~1runners/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_automation_actions_runners: + operation: + $ref: '#/paths/~1automation_actions~1runners/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.runners + _get_automation_actions_runners: + operation: + $ref: '#/paths/~1automation_actions~1runners/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_automation_actions_runner: + operation: + $ref: '#/paths/~1automation_actions~1runners~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.runner + _get_automation_actions_runner: + operation: + $ref: '#/paths/~1automation_actions~1runners~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_automation_actions_runner: + operation: + $ref: '#/paths/~1automation_actions~1runners~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_automation_actions_runner: + operation: + $ref: '#/paths/~1automation_actions~1runners~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/runners/methods/get_automation_actions_runner' + - $ref: '#/components/x-stackQL-resources/runners/methods/get_automation_actions_runners' + insert: + - $ref: '#/components/x-stackQL-resources/runners/methods/create_automation_actions_runner' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/runners/methods/delete_automation_actions_runner' + runners_teams: + id: pagerduty.automation_actions.runners_teams + name: runners_teams + title: Runners Teams + methods: + create_automation_actions_runner_team_association: + operation: + $ref: '#/paths/~1automation_actions~1runners~1{id}~1teams/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_automation_actions_runner_team_associations: + operation: + $ref: '#/paths/~1automation_actions~1runners~1{id}~1teams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.teams + _get_automation_actions_runner_team_associations: + operation: + $ref: '#/paths/~1automation_actions~1runners~1{id}~1teams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_automation_actions_runner_team_association: + operation: + $ref: '#/paths/~1automation_actions~1runners~1{id}~1teams~1{team_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + get_automation_actions_runner_team_association: + operation: + $ref: '#/paths/~1automation_actions~1runners~1{id}~1teams~1{team_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.team + _get_automation_actions_runner_team_association: + operation: + $ref: '#/paths/~1automation_actions~1runners~1{id}~1teams~1{team_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/runners_teams/methods/get_automation_actions_runner_team_association' + - $ref: '#/components/x-stackQL-resources/runners_teams/methods/get_automation_actions_runner_team_associations' + insert: + - $ref: '#/components/x-stackQL-resources/runners_teams/methods/create_automation_actions_runner_team_association' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/runners_teams/methods/delete_automation_actions_runner_team_association' +paths: + /automation_actions/actions: + post: + summary: Create an Automation Action + tags: + - Automation Actions + description: | + Create a Script, Process Automation, or Runbook Automation action + operationId: createAutomationAction + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + requestBody: + content: + application/json: + schema: + type: object + properties: + action: + oneOf: + - $ref: '#/components/schemas/AutomationActionsScriptActionPostBody' + - $ref: '#/components/schemas/AutomationActionsProcessAutomationJobActionPostBody' + discriminator: + propertyName: action_type + mapping: + script: models/automationActions/ScriptActionPostBody.yaml + process_automation: models/automationActions/ProcessAutomationJobActionPostBody.yaml + required: + - action + examples: + request: + value: + action: + name: Restart apache + description: Restarts apache on the us-west-2-shopping-cart host + action_type: script + action_data_reference: + script: java --version + teams: + - id: PQ9K7I8 + type: team_reference + services: + - id: PRDRWUJ + type: service_reference + required: true + responses: + '201': + description: Action information + content: + application/json: + schema: + type: object + properties: + action: + oneOf: + - $ref: '#/components/schemas/AutomationActionsScriptActionWithTeams' + - $ref: '#/components/schemas/AutomationActionsProcessAutomationJobActionWithTeams' + discriminator: + propertyName: action_type + mapping: + script: models/automationActions/ScriptActionWithTeams.yaml + process_automation: models/automationActions/ProcessAutomationJobActionWithTeams.yaml + required: + - action + examples: + response: + summary: Response Example + value: + action: + action_data_reference: + script: java --version + action_type: script + type: action + creation_time: '2022-11-08T14:54:02.267989Z' + description: Restarts apache on the us-west-2-shopping-cart host + id: 01DA2MLYN0J5EFC1LKWXUKDDKT + modify_time: '2022-11-08T14:54:02.267989Z' + name: Restart apache + privileges: + permissions: + - read + - update + - delete + - invoke + services: + - id: PRDRWUJ + type: service_reference + teams: + - id: PQ9K7I8 + type: team_reference + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + get: + summary: List Automation Actions + tags: + - Automation Actions + operationId: getAllAutomationActions + description: | + 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. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/cursor_limit' + - $ref: '#/components/parameters/cursor_cursor' + - $ref: '#/components/parameters/automation_actions_name' + - $ref: '#/components/parameters/automation_actions_runner_id' + - $ref: '#/components/parameters/automation_actions_classification' + - $ref: '#/components/parameters/automation_actions_team_id' + - $ref: '#/components/parameters/automation_actions_service_id' + - $ref: '#/components/parameters/automation_actions_action_type' + responses: + '200': + description: An array of actions + content: + application/json: + schema: + allOf: + - type: object + properties: + actions: + type: array + items: + oneOf: + - $ref: '#/components/schemas/AutomationActionsScriptAction' + - $ref: '#/components/schemas/AutomationActionsProcessAutomationJobAction' + discriminator: + propertyName: action_type + mapping: + script: models/automationActions/ScriptAction.yaml + process_automation: models/automationActions/ProcessAutomationJobAction.yaml + required: + - actions + - type: object + properties: + privileges: + $ref: '#/components/schemas/AutomationActionsUserPermissions' + - $ref: '#/components/schemas/CursorPagination' + examples: + response: + summary: Response Example + value: + actions: + - action_data_reference: + script: java --version + action_type: script + type: action + creation_time: '2022-11-08T14:54:02.267989Z' + description: Restarts apache on the us-west-2-shopping-cart host + id: 01DA2MLYN0J5EFC1LKWXUKDDKT + modify_time: '2022-11-08T14:54:02.267989Z' + name: Restart apache + privileges: + permissions: + - read + - update + - delete + - invoke + services: + - id: PRDRWUJ + type: service_reference + - action_data_reference: + script: java --version + action_type: script + type: action + creation_time: '2022-11-08T14:54:02.267989Z' + description: Restarts apache on the us-west-2-shopping-cart host + id: 01DACKMP6Q3Y5YG51ENA26CX2I + modify_time: '2022-11-08T14:54:02.267989Z' + name: Restart apache + privileges: + permissions: + - read + - update + limit: 2 + next_cursor: null + privileges: + permissions: + - read + - update + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '/automation_actions/actions/{id}': + get: + summary: Get an Automation Action + tags: + - Automation Actions + operationId: getAutomationAction + description: | + Get an Automation Action + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: Action information + content: + application/json: + schema: + type: object + properties: + action: + oneOf: + - $ref: '#/components/schemas/AutomationActionsScriptActionWithTeams' + - $ref: '#/components/schemas/AutomationActionsProcessAutomationJobActionWithTeams' + discriminator: + propertyName: action_type + mapping: + script: models/automationActions/ScriptActionWithTeams.yaml + process_automation: models/automationActions/ProcessAutomationJobActionWithTeams.yaml + required: + - action + examples: + response: + value: + action: + action_data_reference: + script: java --version + action_type: script + type: action + creation_time: '2022-11-08T14:54:02.267989Z' + description: Restarts apache on the us-west-2-shopping-cart host + id: 01DA2MLYN0J5EFC1LKWXUKDDKT + modify_time: '2022-11-08T14:54:02.267989Z' + name: Restart apache + privileges: + permissions: + - read + - update + - delete + - invoke + services: + - id: PRDRWUJ + type: service_reference + teams: + - id: PQ9K7I8 + type: team_reference + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + delete: + summary: Delete an Automation Action + tags: + - Automation Actions + operationId: deleteAutomationAction + description: | + Delete an Automation Action + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '204': + description: Deleted successfully. + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + put: + summary: Update an Automation Action + tags: + - Automation Actions + operationId: updateAutomationAction + description: | + Updates an Automation Action + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + action: + oneOf: + - $ref: '#/components/schemas/AutomationActionsScriptActionPutBody' + - $ref: '#/components/schemas/AutomationActionsProcessAutomationJobActionPutBody' + discriminator: + propertyName: action_type + mapping: + script: models/automationActions/ScriptActionPutBody.yaml + process_automation: models/automationActions/ProcessAutomationJobActionPutBody.yaml + required: + - action + required: true + responses: + '200': + description: Action information + content: + application/json: + schema: + type: object + properties: + action: + oneOf: + - $ref: '#/components/schemas/AutomationActionsScriptActionWithTeams' + - $ref: '#/components/schemas/AutomationActionsProcessAutomationJobActionWithTeams' + discriminator: + propertyName: action_type + mapping: + script: models/automationActions/ScriptActionWithTeams.yaml + process_automation: models/automationActions/ProcessAutomationJobActionWithTeams.yaml + required: + - action + examples: + response: + value: + action: + action_data_reference: + script: java --version + action_type: script + type: action + creation_time: '2022-11-08T14:54:02.267989Z' + description: Restarts apache on the us-west-2-shopping-cart host + id: 01DA2MLYN0J5EFC1LKWXUKDDKT + modify_time: '2022-11-08T14:54:02.267989Z' + name: Restart apache + privileges: + permissions: + - read + - update + - delete + - invoke + services: + - id: PRDRWUJ + type: service_reference + teams: + - id: PQ9K7I8 + type: team_reference + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '/automation_actions/actions/{id}/invocations': + post: + summary: Create an Invocation + tags: + - Automation Actions + description: | + Invokes an Action + operationId: createAutomationActionInvocation + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + invocation: + type: object + properties: + metadata: + type: object + properties: + incident_id: + type: string + required: + - incident_id + required: + - metadata + required: + - invocation + examples: + request: + value: + metadata: + incident_id: Q2LAR4ADCXC8IB + required: true + responses: + '201': + description: Created invocation + content: + application/json: + schema: + type: object + properties: + invocation: + allOf: + - $ref: '#/components/schemas/AutomationActionsInvocation' + - type: object + required: + - invocation + examples: + response: + summary: Response Example + value: + invocation: + id: 01DBYD4A25RCXAXQDC9ZX0678V + type: invocation + action_snapshot: + name: Restart apache + action_type: script + action_data_reference: + script: print(\Hello from a Python script!\) + invocation_command: /usr/local/bin/python3 + runner_id: 01COQFFNVWIONSLY8C66YTU2O5 + timing: + - timestamp: '2022-11-08T22:57:14.756Z' + state: sent + duration: 23 + state: sent + action_id: 01DAW70HK24JZORNE0P9C2V1L9 + metadata: + agent: + id: PT4KHLK + type: user_reference + incident: + id: Q2LAR4ADCXC8IB + type: incident_reference + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '/automation_actions/actions/{id}/services': + get: + summary: Get all service references associated with an Automation Action + tags: + - Automation Actions + operationId: getAutomationActionsActionServiceAssociations + description: Gets all service references associated with an Automation Action + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: An array of service references + content: + application/json: + schema: + type: object + properties: + services: + type: array + items: + $ref: '#/components/schemas/ServiceReference' + examples: + response: + value: + services: + - id: PQ9K7I8 + type: service_reference + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + post: + summary: Associate an Automation Action with a service + tags: + - Automation Actions + operationId: createAutomationActionServiceAssocation + description: | + Associate an Automation Action with a service + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + service: + $ref: '#/components/schemas/ServiceReference' + required: + - service + examples: + request: + value: + service: + id: PRDRWUJ + type: service_reference + required: true + responses: + '201': + description: The action-service association was created + content: + application/json: + schema: + type: object + properties: + service: + $ref: '#/components/schemas/ServiceReference' + required: + - service + examples: + response: + value: + service: + id: PRDRWUJ + type: service_reference + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '/automation_actions/actions/{id}/services/{service_id}': + get: + summary: Get the details of an Automation Action / service relation + tags: + - Automation Actions + operationId: getAutomationActionsActionServiceAssociation + description: Gets the details of a Automation Action / service relation + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/service_id' + responses: + '200': + description: Service reference + content: + application/json: + schema: + type: object + properties: + service: + $ref: '#/components/schemas/ServiceReference' + examples: + response: + value: + service: + id: PQ9K7I8 + type: service_reference + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + delete: + summary: Disassociate an Automation Action from a service + tags: + - Automation Actions + operationId: deleteAutomationActionServiceAssociation + description: | + Disassociate an Automation Action from a service + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/service_id' + responses: + '204': + description: Ok. + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '/automation_actions/actions/{id}/teams': + post: + summary: Associate an Automation Action with a team + tags: + - Automation Actions + operationId: createAutomationActionTeamAssociation + description: | + Associate an Automation Action with a team + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + team: + $ref: '#/components/schemas/TeamReference' + required: + - team + examples: + request: + value: + team: + id: PQ9K7I8 + type: team_reference + required: true + responses: + '201': + description: The action-team association was created + content: + application/json: + schema: + type: object + properties: + team: + $ref: '#/components/schemas/TeamReference' + required: + - team + examples: + response: + value: + team: + id: PQ9K7I8 + type: team_reference + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + get: + summary: Get all team references associated with an Automation Action + tags: + - Automation Actions + operationId: getAutomationActionsActionTeamAssociations + description: Gets all team references associated with an Automation Action + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + teams: + type: array + items: + $ref: '#/components/schemas/TeamReference' + examples: + response: + value: + teams: + - id: PQ9K7I8 + type: team_reference + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '/automation_actions/actions/{id}/teams/{team_id}': + delete: + summary: Disassociate an Automation Action from a team + tags: + - Automation Actions + operationId: deleteAutomationActionTeamAssociation + description: | + Disassociate an Automation Action from a team + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/team_id' + responses: + '204': + description: Ok. + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + get: + summary: Get the details of an Automation Action / team relation + tags: + - Automation Actions + operationId: getAutomationActionsActionTeamAssociation + description: Gets the details of an Automation Action / team relation + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/team_id' + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + team: + $ref: '#/components/schemas/TeamReference' + examples: + response: + value: + team: + id: PQ9K7I8 + type: team_reference + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + /automation_actions/invocations: + get: + summary: List Invocations + tags: + - Automation Actions + description: | + List Invocations + operationId: listAutomationActionInvocations + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/automation_actions_invocation_state' + - $ref: '#/components/parameters/automation_actions_incident_id' + responses: + '200': + description: Invocations matching the criteria + content: + application/json: + schema: + allOf: + - type: object + properties: + invocations: + type: array + description: List of invocations sorted by creation_time in reverse chronological order (newest invocations first). At most 25 invocations are returned. + items: + $ref: '#/components/schemas/AutomationActionsInvocation' + required: + - invocations + examples: + response: + summary: Response Example + value: + invocations: + - id: 01DBYD4A25RCXAXQDC9ZX0678V + type: invocation + action_id: 01DAW70HK24JZORNE0P9C2V1L9 + action_snapshot: + name: Restart Apache + action_type: process_automation + action_data_reference: + process_automation_job_arguments: prod-datapipe + process_automation_node_filter: 'mynode1 !nodename: mynode2' + process_automation_job_id: 79c199bba1aff6e519f198457f5ec0fc + duration: 5 + metadata: + agent: + id: PRJ94S1 + type: user_reference + incident: + id: Q2LAR4ADCXC8IB + type: incident_reference + runner_id: 01COQFFNVWIONSLY8C66YTU2O5 + state: completed + timing: + - creation_timestamp: '2022-11-08T06:30:05.018949Z' + state: created + - creation_timestamp: '2022-11-08T06:30:10.069000Z' + state: running + - creation_timestamp: '2022-11-08T06:30:10.083000Z' + state: completed + - creation_timestamp: '2022-11-08T06:30:10.066000Z' + state: queued + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '/automation_actions/invocations/{id}': + get: + summary: Get an Invocation + tags: + - Automation Actions + operationId: getAutomationActionsInvocation + description: | + Get an Automation Action Invocation + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: Invocation information + content: + application/json: + schema: + type: object + properties: + invocation: + $ref: '#/components/schemas/AutomationActionsInvocation' + required: + - invocation + examples: + response: + summary: Response Example + value: + invocation: + id: 01DBYD4A25RCXAXQDC9ZX0678V + type: invocation + action_id: 01DAW70HK24JZORNE0P9C2V1L9 + action_snapshot: + name: Restart Apache + action_type: process_automation + action_data_reference: + process_automation_job_arguments: prod-datapipe + process_automation_node_filter: 'mynode1 !nodename: mynode2' + process_automation_job_id: 79c199bba1aff6e519f198457f5ec0fc + duration: 5 + metadata: + agent: + id: PRJ94S1 + type: user_reference + incident: + id: Q2LAR4ADCXC8IB + type: incident_reference + runner_id: 01COQFFNVWIONSLY8C66YTU2O5 + state: completed + timing: + - creation_timestamp: '2022-11-08T06:30:05.018949Z' + state: created + - creation_timestamp: '2022-11-08T06:30:10.069000Z' + state: running + - creation_timestamp: '2022-11-08T06:30:10.083000Z' + state: completed + - creation_timestamp: '2022-11-08T06:30:10.066000Z' + state: queued + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + /automation_actions/runners: + post: + summary: Create an Automation Action runner. + tags: + - Automation Actions + description: | + Create a Process Automation or a Runbook Automation runner. + operationId: createAutomationActionsRunner + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + requestBody: + content: + application/json: + schema: + type: object + properties: + runner: + oneOf: + - $ref: '#/components/schemas/AutomationActionsRunnerSidecarPostBody' + - $ref: '#/components/schemas/AutomationActionsRunnerRunbookPostBody' + discriminator: + propertyName: runner_type + required: + - runner + examples: + request: + value: + runner: + name: us-west-2 prod sidecar runner + description: us-west-2 prod sidecar runner provisioned by SRE + runner_type: sidecar + teams: + - id: PQ9K7I8 + type: team_reference + required: true + responses: + '201': + description: Runner information + content: + application/json: + schema: + type: object + properties: + runner: + allOf: + - $ref: '#/components/schemas/AutomationActionsRunner' + - type: object + properties: + secret: + description: Secret used for authentication of sidecar runner_types + type: string + required: + - runner + examples: + response: + summary: Response Example + value: + runner: + id: 01DA2MLYN0J5EFC1LKWXUKDDKT + name: us-west-2 prod sidecar runner + summary: us-west-2 prod sidecar runner + type: runner + description: us-west-2 prod sidecar runner provisioned by SRE + creation_time: '2022-10-21T19:42:52.127369Z' + runner_type: sidecar + status: Configured + secret: 01DAZ9ZJ97OE23JUI6WH9XN7BK + teams: + - id: PQ9K7I8 + type: team_reference + privileges: + permissions: + - read + - update + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + get: + summary: List Automation Action runners + tags: + - Automation Actions + operationId: getAutomationActionsRunners + description: | + 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. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/cursor_limit' + - $ref: '#/components/parameters/cursor_cursor' + - $ref: '#/components/parameters/automation_actions_name' + - $ref: '#/components/parameters/automation_actions_runners_include' + responses: + '200': + description: Runners matching the criteria. + content: + application/json: + schema: + allOf: + - type: object + properties: + runners: + type: array + items: + $ref: '#/components/schemas/AutomationActionsRunner' + - type: object + properties: + privileges: + $ref: '#/components/schemas/AutomationActionsUserPermissions' + - $ref: '#/components/schemas/CursorPagination' + examples: + response: + summary: Response Example + value: + runners: + - id: 01DACKMP6Q3Y5YG51ENA26CX2I + name: us-west-2 prod runbook runner + description: us-west-2 prod runbook runner provisioned by SRE + creation_time: '2022-10-21T19:42:52.127369Z' + type: runner + runner_type: runbook + runbook_base_uri: acme.prod + status: Configured + teams: + - id: PQ9K7I8 + type: team_reference + privileges: + permissions: + - read + - update + - delete + - id: 01DA2MLYN0J5EFC1LKWXUKDDKT + name: us-west-2 prod sidecar runner + description: us-west-2 prod sidecar runner provisioned by SRE + creation_time: '2022-10-21T19:42:52.127369Z' + type: runner + runner_type: sidecar + status: Configured + privileges: + permissions: + - read + - update + privileges: + permissions: + - create + limit: 2 + next_cursor: eyJjMiI6IjAxREEyTUxZTjBKNUVGQzFMS1dYVUtEREtUIiwiYzEiOiJSQkEgU2hhcmVkIFN0YWdpbmcgSW5zdGFuY2UifQ== + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '/automation_actions/runners/{id}': + get: + summary: Get an Automation Action runner + tags: + - Automation Actions + operationId: getAutomationActionsRunner + description: | + Get an Automation Action runner + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: Runner information + content: + application/json: + schema: + type: object + properties: + runner: + $ref: '#/components/schemas/AutomationActionsRunner' + required: + - runner + examples: + response: + summary: Response Example + value: + runner: + id: 01DA2MLYN0J5EFC1LKWXUKDDKT + name: us-west-2 prod sidecar runner + summary: us-west-2 prod sidecar runner + type: runner + description: us-west-2 prod sidecar runner provisioned by SRE + creation_time: '2022-10-21T19:42:52.127369Z' + runner_type: sidecar + status: Configured + teams: + - id: PQ9K7I8 + type: team_reference + privileges: + permissions: + - read + - update + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + put: + summary: Update an Automation Action runner + tags: + - Automation Actions + operationId: updateAutomationActionsRunner + description: | + Update an Automation Action runner + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + runner: + oneOf: + - $ref: '#/components/schemas/AutomationActionsRunnerSidecarBody' + - $ref: '#/components/schemas/AutomationActionsRunnerRunbookBody' + discriminator: + propertyName: runner_type + required: + - runner + examples: + request: + value: + runner: + name: us-west-2 prod sidecar runner + description: us-west-2 prod sidecar runner provisioned by SRE + required: true + responses: + '200': + description: Runner information + content: + application/json: + schema: + type: object + properties: + runner: + $ref: '#/components/schemas/AutomationActionsRunner' + required: + - runner + examples: + response: + summary: Response Example + value: + runner: + id: 01DA2MLYN0J5EFC1LKWXUKDDKT + name: us-west-2 prod sidecar runner + summary: us-west-2 prod sidecar runner + type: runner + description: us-west-2 prod sidecar runner provisioned by SRE + creation_time: '2022-10-21T19:42:52.127369Z' + runner_type: sidecar + status: Configured + teams: + - id: PQ9K7I8 + type: team_reference + privileges: + permissions: + - read + - update + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + delete: + summary: Delete an Automation Action runner + tags: + - Automation Actions + operationId: deleteAutomationActionsRunner + description: | + Delete an Automation Action runner + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '204': + description: Deleted successfully. + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '/automation_actions/runners/{id}/teams': + post: + summary: Associate a runner with a team + tags: + - Automation Actions + operationId: createAutomationActionsRunnerTeamAssociation + description: | + Associate a runner with a team + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + team: + $ref: '#/components/schemas/TeamReference' + required: + - team + examples: + request: + value: + team: + id: PQ9K7I8 + type: team_reference + required: true + responses: + '201': + description: The runner-team association that was created. + content: + application/json: + schema: + type: object + properties: + team: + $ref: '#/components/schemas/TeamReference' + required: + - team + examples: + response: + summary: Response Example + value: + team: + id: PQ9K7I8 + type: team_reference + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + get: + summary: Get all team references associated with a runner + tags: + - Automation Actions + operationId: getAutomationActionsRunnerTeamAssociations + description: Gets all team references associated with a runner + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + teams: + type: array + items: + $ref: '#/components/schemas/TeamReference' + examples: + response: + value: + teams: + - id: PQ9K7I8 + type: team_reference + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '/automation_actions/runners/{id}/teams/{team_id}': + delete: + summary: Disassociate a runner from a team + tags: + - Automation Actions + operationId: deleteAutomationActionsRunnerTeamAssociation + description: | + Disassociates a runner from a team + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/team_id' + responses: + '204': + description: Ok. + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + get: + summary: Get the details of a runner / team relation + tags: + - Automation Actions + operationId: getAutomationActionsRunnerTeamAssociation + description: Gets the details of a runner / team relation + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/team_id' + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + team: + $ref: '#/components/schemas/TeamReference' + examples: + response: + value: + team: + id: PQ9K7I8 + type: team_reference + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/business_services.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/business_services.yaml new file mode 100644 index 0000000..2afd683 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/business_services.yaml @@ -0,0 +1,3922 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - business_services + description: Business_Services +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + BusinessService: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + name: + type: string + description: The name of the business service. + description: + type: string + description: The user-provided description of the business service. + point_of_contact: + type: string + description: The point of contact assigned to this service. + team: + type: object + nullable: true + title: Team + description: Reference to the team that owns the business service. + properties: + id: + type: string + type: + type: string + description: A string that determines the schema of the object. + readOnly: true + self: + type: string + format: url + description: The API show URL at which the object is accessible. + readOnly: true + required: + - id + example: + id: P3X2XX3 + type: business_service + name: Self-serve mobile checkout + description: Checkout service for our mobile clients + point_of_contact: PagerDuty Admin + team: + type: team_reference + self: 'https://api.pagerduty.com/teams/P3ZQXDF' + id: P3ZQXDF + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + NotificationSubscriber: + title: NotificationSubscriber + description: A reference of a subscriber entity. + type: object + properties: + subscriber_id: + type: string + description: The ID of the entity being subscribed + subscriber_type: + type: string + description: The type of the entity being subscribed + enum: + - user + - team + example: + subscriber_id: PD1234 + subscriber_type: user + NotificationSubscriptionWithContext: + title: NotificationSubscriptionWithContext + type: object + description: An object describing the relationship of a NotificationSubscriber and a NotificationSubscribable with additional context on status of subscription attempt. + x-examples: + example-1: + subscriber_id: string + subscriber_type: user + subscribable_id: string + subscribable_type: incident + account_id: string + result: success + properties: + subscriber_id: + type: string + description: The ID of the entity being subscribed + subscriber_type: + type: string + enum: + - user + - team + description: The type of the entity being subscribed + subscribable_id: + type: string + description: The ID of the entity being subscribed to + subscribable_type: + type: string + enum: + - incident + - business_service + description: The type of the entity being subscribed to + account_id: + type: string + description: The type of the entity being subscribed to + result: + type: string + enum: + - success + - duplicate + - unauthorized + description: The resulting status of the subscription + LiveListResponse: + type: object + properties: + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + Impact: + title: Impact + type: object + properties: + id: + type: string + readOnly: true + name: + type: string + readOnly: true + type: + type: string + description: The kind of object that has been impacted + enum: + - business_service + status: + type: string + description: The current impact status of the object + enum: + - impacted + - not_impacted + additional_fields: + type: object + properties: + highest_impacting_priority: + type: object + nullable: true + description: Priority information for the highest priority level that is affecting the impacted object. + properties: + id: + type: string + readOnly: true + order: + type: integer + readOnly: true + Impactor: + title: Impactor + type: object + properties: + id: + type: string + readOnly: true + type: + type: string + description: The kind of object that is impacting + enum: + - incident + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + UnprocessableEntity: + description: Unprocessable Entity. Some arguments failed validation checks. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + business_services: + id: pagerduty.business_services.business_services + name: business_services + title: Business Services + methods: + list_business_services: + operation: + $ref: '#/paths/~1business_services/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.services + _list_business_services: + operation: + $ref: '#/paths/~1business_services/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_business_service: + operation: + $ref: '#/paths/~1business_services/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_business_service: + operation: + $ref: '#/paths/~1business_services~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.business_service + _get_business_service: + operation: + $ref: '#/paths/~1business_services~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_business_service: + operation: + $ref: '#/paths/~1business_services~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_business_service: + operation: + $ref: '#/paths/~1business_services~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/business_services/methods/get_business_service' + - $ref: '#/components/x-stackQL-resources/business_services/methods/list_business_services' + insert: + - $ref: '#/components/x-stackQL-resources/business_services/methods/create_business_service' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/business_services/methods/delete_business_service' + account_subscription: + id: pagerduty.business_services.account_subscription + name: account_subscription + title: Account Subscription + methods: + create_business_service_account_subscription: + operation: + $ref: '#/paths/~1business_services~1{id}~1account_subscription/post' + response: + mediaType: application/json + openAPIDocKey: '200' + remove_business_service_account_subscription: + operation: + $ref: '#/paths/~1business_services~1{id}~1account_subscription/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + remove_business_service_notification_subscriber: + operation: + $ref: '#/paths/~1business_services~1{id}~1unsubscribe/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/account_subscription/methods/create_business_service_account_subscription' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/account_subscription/methods/remove_business_service_account_subscription' + subscribers: + id: pagerduty.business_services.subscribers + name: subscribers + title: Subscribers + methods: + get_business_service_subscribers: + operation: + $ref: '#/paths/~1business_services~1{id}~1subscribers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.subscribers + _get_business_service_subscribers: + operation: + $ref: '#/paths/~1business_services~1{id}~1subscribers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_business_service_notification_subscribers: + operation: + $ref: '#/paths/~1business_services~1{id}~1subscribers/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subscribers/methods/get_business_service_subscribers' + insert: + - $ref: '#/components/x-stackQL-resources/subscribers/methods/create_business_service_notification_subscribers' + update: [] + delete: [] + supporting_services_impacts: + id: pagerduty.business_services.supporting_services_impacts + name: supporting_services_impacts + title: Supporting Services Impacts + methods: + get_business_service_supporting_service_impacts: + operation: + $ref: '#/paths/~1business_services~1{id}~1supporting_services~1impacts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.services + _get_business_service_supporting_service_impacts: + operation: + $ref: '#/paths/~1business_services~1{id}~1supporting_services~1impacts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/supporting_services_impacts/methods/get_business_service_supporting_service_impacts' + insert: [] + update: [] + delete: [] + impactors: + id: pagerduty.business_services.impactors + name: impactors + title: Impactors + methods: + get_business_service_top_level_impactors: + operation: + $ref: '#/paths/~1business_services~1impactors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.impactors + _get_business_service_top_level_impactors: + operation: + $ref: '#/paths/~1business_services~1impactors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/impactors/methods/get_business_service_top_level_impactors' + insert: [] + update: [] + delete: [] + impacts: + id: pagerduty.business_services.impacts + name: impacts + title: Impacts + methods: + get_business_service_impacts: + operation: + $ref: '#/paths/~1business_services~1impacts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.services + _get_business_service_impacts: + operation: + $ref: '#/paths/~1business_services~1impacts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/impacts/methods/get_business_service_impacts' + insert: [] + update: [] + delete: [] + priority_thresholds: + id: pagerduty.business_services.priority_thresholds + name: priority_thresholds + title: Priority Thresholds + methods: + get_business_service_priority_thresholds: + operation: + $ref: '#/paths/~1business_services~1priority_thresholds/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.global_threshold + _get_business_service_priority_thresholds: + operation: + $ref: '#/paths/~1business_services~1priority_thresholds/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_business_service_priority_thresholds: + operation: + $ref: '#/paths/~1business_services~1priority_thresholds/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + put_business_service_priority_thresholds: + operation: + $ref: '#/paths/~1business_services~1priority_thresholds/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/priority_thresholds/methods/get_business_service_priority_thresholds' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/priority_thresholds/methods/delete_business_service_priority_thresholds' +paths: + /business_services: + get: + x-pd-requires-scope: services.read + tags: + - Business Services + operationId: listBusinessServices + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services) + + Scoped OAuth requires: `services.read` + summary: List Business Services + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + responses: + '200': + description: A paginated array of services. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + business_services: + type: array + items: + $ref: '#/components/schemas/BusinessService' + required: + - business_services + examples: + response: + summary: Response Example + value: + business_services: + - type: business_service + self: 'https://api.pagerduty.com/business_services/P3U7V58' + html_url: null + point_of_contact: PagerDuty Admin + name: stand-alone node + team: null + id: P3U7V58 + description: Very important business function + summary: stand-alone node + - type: business_service + self: 'https://api.pagerduty.com/business_services/P1L1YEE' + html_url: null + point_of_contact: PagerDuty Admin + name: Cross-tier business service + id: P1L1YEE + summary: Cross-tier business service + team: + id: PQ9K7I8 + type: team_reference + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + limit: 100 + offset: 0 + total: null + more: false + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + post: + x-pd-requires-scope: services.write + tags: + - Business Services + operationId: createBusinessService + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services) + + Scoped OAuth requires: `services.write` + summary: Create a Business Service + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + requestBody: + content: + application/json: + schema: + type: object + properties: + business_service: + type: object + description: The Business Service to be created + properties: + name: + type: string + description: The name of the Business Service. + description: + type: string + description: The description of the Business Service. + point_of_contact: + type: string + description: The owner of the Business Service. + team: + type: object + title: Team + description: Reference to the team that owns the Business Service. + properties: + id: + type: string + description: The Team ID + examples: + request: + summary: Request Example + value: + business_service: + name: Self-serve mobile checkout + description: Checkout service for our mobile clients + point_of_contact: PagerDuty Admin + team: + id: P3ZQXDF + responses: + '200': + description: The Business Service that was created. + content: + application/json: + schema: + type: object + properties: + business_service: + $ref: '#/components/schemas/BusinessService' + required: + - business_service + examples: + response: + summary: Response Example + value: + business_service: + id: P1L1YEE + type: business_service + self: 'https://api.pagerduty.com/business_services/P1L1YEE' + html_url: null + point_of_contact: PagerDuty Admin + name: Self-serve mobile checkout + description: Checkout service for our mobile clients. + summary: Self-serve mobile checkout + team: + id: P3ZQXDF + type: team_reference + self: 'https://api.pagerduty.com/teams/P3ZQXDF' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '/business_services/{id}': + get: + x-pd-requires-scope: services.read + tags: + - Business Services + operationId: getBusinessService + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services) + + Scoped OAuth requires: `services.read` + summary: Get a Business Service + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: The service business requested. + content: + application/json: + schema: + type: object + properties: + business_service: + $ref: '#/components/schemas/BusinessService' + required: + - business_service + examples: + response: + summary: Response Example + value: + business_service: + id: P1L1YEE + type: business_service + self: 'https://api.pagerduty.com/business_services/P1L1YEE' + html_url: null + name: Cross-tier business service + description: Business service affected by multiple teams + point_of_contact: PagerDuty Admin + summary: Cross-tier business services + team: + id: PQ9K7I8 + type: team_reference + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + delete: + x-pd-requires-scope: services.write + tags: + - Business Services + operationId: deleteBusinessService + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services) + + Scoped OAuth requires: `services.write` + summary: Delete a Business Service + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '204': + description: The Business Service was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + put: + x-pd-requires-scope: services.write + tags: + - Business Services + operationId: updateBusinessService + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services) + + Scoped OAuth requires: `services.write` + summary: Update a Business Service + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + business_service: + type: object + description: The Business Service to be created + properties: + name: + type: string + description: The name of the Business Service. + description: + type: string + description: The description of the Business Service. + point_of_contact: + type: string + description: The owner of the Business Service. + team: + type: object + title: Team + description: Reference to the team that owns the Business Service. + properties: + id: + type: string + description: The team ID + examples: + request: + summary: Request Example + value: + business_service: + name: Self-serve mobile checkout + description: Checkout service for our mobile clients + point_of_contact: PagerDuty Admin + team: + id: P3ZQXDF + responses: + '200': + description: The Business Service that was updated. + content: + application/json: + schema: + type: object + properties: + business_service: + $ref: '#/components/schemas/BusinessService' + required: + - business_service + examples: + response: + summary: Response Example + value: + business_service: + id: P1L1YEE + type: business_service + self: 'https://api.pagerduty.com/business_services/P1L1YEE' + html_url: null + point_of_contact: PagerDuty Admin + name: Self-serve mobile checkout + description: Checkout service for our mobile clients. + summary: Self-serve mobile checkout + team: + id: P3ZQXDF + type: team_reference + self: 'https://api.pagerduty.com/teams/P3ZQXDF' + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '/business_services/{id}/account_subscription': + post: + x-pd-requires-scope: subscribers.write + summary: Create Business Service Account Subscription + tags: + - Business Services + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + account_is_subscribed: + type: boolean + required: + - account_is_subscribed + examples: + response: + summary: Response Example + value: + account_is_subscribed: true + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '422': + $ref: '#/components/responses/UnprocessableEntity' + operationId: createBusinessServiceAccountSubscription + description: | + Subscribe your Account to a Business Service. + + Scoped OAuth requires: `subscribers.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + delete: + x-pd-requires-scope: subscribers.write + summary: Delete Business Service Account Subscription + tags: + - Business Services + operationId: removeBusinessServiceAccountSubscription + responses: + '204': + description: The account was unsubscribed successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '422': + $ref: '#/components/responses/UnprocessableEntity' + description: | + Unsubscribe your Account from a Business Service. + + Scoped OAuth requires: `subscribers.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + '/business_services/{id}/subscribers': + get: + x-pd-requires-scope: subscribers.read + summary: List Business Service Subscribers + tags: + - Business Services + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + subscribers: + type: array + items: + $ref: '#/components/schemas/NotificationSubscriber' + - type: object + properties: + account_id: + type: string + description: The ID of the account belonging to the subscriber entity + examples: + response: + summary: Response Example + value: + limit: 100 + more: false + offset: 0 + subscribers: + - subscriber_id: PD1234 + subscriber_type: user + - subscriber_id: PD1234 + subscriber_type: team + account_id: PD1234 + total: 2 + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '429': + $ref: '#/components/responses/TooManyRequests' + operationId: getBusinessServiceSubscribers + description: | + Retrieve a list of Notification Subscribers on the Business Service. + + + > Users must be added through `POST /business_services/{id}/subscribers` to be returned from this endpoint. + Scoped OAuth requires: `subscribers.read` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + post: + x-pd-requires-scope: subscribers.write + summary: Create Business Service Subscribers + tags: + - Business Services + operationId: createBusinessServiceNotificationSubscribers + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + subscriptions: + type: array + items: + $ref: '#/components/schemas/NotificationSubscriptionWithContext' + examples: + response: + summary: Response Example + value: + subscriptions: + - account_id: PD1234 + subscribable_id: PD1234 + subscribable_type: business_service + subscriber_id: PD1234 + subscriber_type: user + result: success + - account_id: PD1234 + subscribable_id: PD1234 + subscribable_type: business_service + subscriber_id: PD1234 + subscriber_type: team + result: duplicate + - account_id: PD1234 + subscribable_id: PD1235 + subscribable_type: business_service + subscriber_id: PD1234 + subscriber_type: team + result: unauthorized + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + description: | + Subscribe the given entities to the given Business Service. + + Scoped OAuth requires: `subscribers.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + subscribers: + type: array + uniqueItems: true + minItems: 1 + items: + $ref: '#/components/schemas/NotificationSubscriber' + required: + - subscribers + examples: + request: + summary: Request Example + value: + subscribers: + - subscriber_id: PD1234 + subscriber_type: team + - subscriber_id: PD1235 + subscriber_type: team + - subscriber_id: PD1234 + subscriber_type: user + description: The entities to subscribe. + '/business_services/{id}/supporting_services/impacts': + get: + summary: 'List the supporting Business Services for the given Business Service Id, sorted by impacted status.' + tags: + - Business Services + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/LiveListResponse' + - type: object + properties: + services: + type: array + items: + $ref: '#/components/schemas/Impact' + - type: object + properties: + additional_fields: + type: object + properties: + total_impacted_count: + type: integer + examples: + response: + summary: Response Example + value: + limit: 100 + more: false + services: + - id: PD1234 + name: Web API + type: business_service + status: impacted + additional_fields: + highest_impacting_priority: + id: PQOMK4S + order: 128 + - id: PF9KMXH + name: Analytics Backend + type: business_service + status: not_impacted + additional_fields: + highest_impacting_priority: null + additional_fields: + total_impacted_count: 1 + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '429': + $ref: '#/components/responses/TooManyRequests' + operationId: getBusinessServiceSupportingServiceImpacts + description: |- + 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. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/early_access_bis' + - $ref: '#/components/parameters/impacts_additional_fields' + - $ref: '#/components/parameters/ids' + '/business_services/{id}/unsubscribe': + post: + x-pd-requires-scope: subscribers.write + summary: Remove Business Service Subscribers + tags: + - Business Services + operationId: removeBusinessServiceNotificationSubscriber + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + deleted_count: + type: number + unauthorized_count: + type: number + non_existent_count: + type: number + required: + - deleted_count + - unauthorized_count + - non_existent_count + examples: + response: + summary: Response Example + value: + deleted_count: 1 + unauthorized_count: 1 + non_existent_count: 0 + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '422': + $ref: '#/components/responses/UnprocessableEntity' + description: | + Unsubscribes the matching Subscribers from a Business Service. + + Scoped OAuth requires: `subscribers.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + subscribers: + type: array + uniqueItems: true + minItems: 1 + items: + $ref: '#/components/schemas/NotificationSubscriber' + required: + - subscribers + examples: + request: + summary: Request Example + value: + subscribers: + - subscriber_id: PD1234 + subscriber_type: team + - subscriber_id: PD1234 + subscriber_type: user + description: The entities to unsubscribe. + /business_services/impactors: + get: + summary: List Impactors affecting Business Services + tags: + - Business Services + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/LiveListResponse' + - type: object + properties: + impactors: + type: array + items: + $ref: '#/components/schemas/Impactor' + examples: + response: + summary: Response Example + value: + limit: 100 + more: false + impactors: + - id: PD1234 + type: incident + - id: PF9KMXH + type: incident + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '429': + $ref: '#/components/responses/TooManyRequests' + operationId: getBusinessServiceTopLevelImpactors + description: |- + 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. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/early_access_bis' + - $ref: '#/components/parameters/ids' + /business_services/impacts: + get: + summary: List Business Services sorted by impacted status + tags: + - Business Services + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/LiveListResponse' + - type: object + properties: + services: + type: array + items: + $ref: '#/components/schemas/Impact' + - type: object + properties: + additional_fields: + type: object + properties: + total_impacted_count: + type: integer + examples: + response: + summary: Response Example + value: + limit: 100 + more: false + services: + - id: PD1234 + name: Web API + type: business_service + status: impacted + additional_fields: + highest_impacting_priority: + id: PQOMK4S + order: 128 + - id: PF9KMXH + name: Analytics Backend + type: business_service + status: not_impacted + additional_fields: + highest_impacting_priority: null + additional_fields: + total_impacted_count: 1 + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '429': + $ref: '#/components/responses/TooManyRequests' + operationId: getBusinessServiceImpacts + description: |- + 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. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/early_access_bis' + - $ref: '#/components/parameters/impacts_additional_fields' + - $ref: '#/components/parameters/ids' + /business_services/priority_thresholds: + get: + summary: Get the global priority threshold for a Business Service to be considered impacted by an Incident + tags: + - Business Services + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + global_threshold: + type: object + nullable: true + properties: + id: + type: string + order: + type: integer + examples: + response: + summary: Response Example + value: + limit: 100 + more: false + global_threshold: null + type: object + properties: + id: string + order: integer + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '429': + $ref: '#/components/responses/TooManyRequests' + operationId: getBusinessServicePriorityThresholds + description: |- + 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. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/early_access_bis' + delete: + summary: Deletes the account-level priority threshold for Business Service impact + tags: + - Business Services + responses: + '204': + description: The Priority Threshold for the account was successfully cleared. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + operationId: deleteBusinessServicePriorityThresholds + description: |- + 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. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/early_access_bis' + put: + summary: Set the Account-level priority threshold for Business Service impact. + tags: + - Business Services + responses: + '200': + description: OK + content: + application/json: + schema: + description: '' + type: object + properties: + global_threshold: + type: object + properties: + id: + type: string + order: + type: number + required: + - id + - order + required: + - global_threshold + examples: + response: + summary: Response Example + value: + global_threshold: + id: PTLNKGF + order: 256 + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + description: Internal Server Error + operationId: putBusinessServicePriorityThresholds + description: |- + Set the Account-level priority threshold for Business Service. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/early_access_bis' + requestBody: + content: + application/json: + schema: + description: '' + type: object + properties: + global_threshold: + type: object + properties: + id: + type: string + minLength: 1 + order: + type: number + required: + - id + - order + required: + - global_threshold + examples: + example: + value: + global_threshold: + id: PTLNKGF + order: 256 + description: |- + Set the `id` and `order` of the global Priority Threshold. These values can be obtained by calling the `/priorities` endpoint. + + Once set, Incidents must be at or above the specified level in order to impact Business Services. An exception to this rule is if the Incident has been added to the incident directly using the `PUT /incidents/{id}/business_services/{business_service_id}/impacts` endpoint. diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/change_events.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/change_events.yaml new file mode 100644 index 0000000..ba288bb --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/change_events.yaml @@ -0,0 +1,3155 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - change_events + description: Change_Events +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + ChangeEvent: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + timestamp: + type: string + format: date-time + readOnly: true + description: The time at which the emitting tool detected or generated the event. + type: + type: string + readOnly: true + default: change_event + description: The type of object being created. + enum: + - change_event + services: + type: array + readOnly: true + description: An array containing Service objects that this change event is associated with. + items: + $ref: '#/components/schemas/ServiceReference' + integration: + allOf: + - readOnly: true + - $ref: '#/components/schemas/IntegrationReference' + routing_key: + readOnly: true + title: Routing Key + description: This is the 32 character Integration Key for an Integration on a Service. The same Integration Key can be used for both alert and change events. + type: string + summary: + type: string + description: A brief text summary of the event. Displayed in PagerDuty to provide information about the change. The maximum permitted length of this property is 1024 characters. + source: + type: string + readOnly: true + description: The unique name of the location where the Change Event occurred. + links: + type: array + readOnly: true + description: List of links to include. + items: + type: object + properties: + href: + type: string + text: + type: string + images: + type: array + readOnly: true + items: + type: object + properties: + src: + type: string + href: + type: string + alt: + type: string + custom_details: + type: object + description: Additional details about the change event. + title: Custom Details + example: + summary: Build Success - Increase snapshot create timeout to 30 seconds + timestamp: '2020-07-17T08:42:58Z' + type: change_event + source: acme-build-pipeline-tool-default-i-9999 + integration: + id: PEYSGVF + type: inbound_integration_reference + services: + - id: PEYSGRV + type: service_reference + custom_details: + build_state: passed + build_number: '2' + run_time: 1236s + links: + - href: 'https://acme.pagerduty.dev/build/2' + text: View more details in Acme! + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + ServiceReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - service_reference + IntegrationReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - aws_cloudwatch_inbound_integration_reference + - cloudkick_inbound_integration_reference + - event_transformer_api_inbound_integration_reference + - generic_email_inbound_integration_reference + - generic_events_api_inbound_integration_reference + - keynote_inbound_integration_reference + - nagios_inbound_integration_reference + - pingdom_inbound_integration_reference + - sql_monitor_inbound_integration_reference + - events_api_v2_inbound_integration_reference + - inbound_integration_reference + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + change_events: + id: pagerduty.change_events.change_events + name: change_events + title: Change Events + methods: + list_change_events: + operation: + $ref: '#/paths/~1change_events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.change_events + _list_change_events: + operation: + $ref: '#/paths/~1change_events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_change_event: + operation: + $ref: '#/paths/~1change_events/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_change_event: + operation: + $ref: '#/paths/~1change_events~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.change_event + _get_change_event: + operation: + $ref: '#/paths/~1change_events~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_change_event: + operation: + $ref: '#/paths/~1change_events~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/change_events/methods/get_change_event' + - $ref: '#/components/x-stackQL-resources/change_events/methods/list_change_events' + insert: + - $ref: '#/components/x-stackQL-resources/change_events/methods/create_change_event' + update: [] + delete: [] + incidents_related_change_events: + id: pagerduty.change_events.incidents_related_change_events + name: incidents_related_change_events + title: Incidents Related Change Events + methods: + list_incident_related_change_events: + operation: + $ref: '#/paths/~1incidents~1{id}~1related_change_events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.change_events + _list_incident_related_change_events: + operation: + $ref: '#/paths/~1incidents~1{id}~1related_change_events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/incidents_related_change_events/methods/list_incident_related_change_events' + insert: [] + update: [] + delete: [] + services: + id: pagerduty.change_events.services + name: services + title: Services + methods: + list_service_change_events: + operation: + $ref: '#/paths/~1services~1{id}~1change_events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.change_events + _list_service_change_events: + operation: + $ref: '#/paths/~1services~1{id}~1change_events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/services/methods/list_service_change_events' + insert: [] + update: [] + delete: [] +paths: + /change_events: + get: + x-pd-requires-scope: change_events.read + tags: + - Change Events + operationId: listChangeEvents + description: | + List all of the existing Change Events. + + Scoped OAuth requires: `change_events.read` + summary: List Change Events + parameters: + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/team_ids' + - $ref: '#/components/parameters/integration_ids' + - $ref: '#/components/parameters/change_since' + - $ref: '#/components/parameters/change_until' + responses: + '200': + description: The array of Change Events returned by the query. + content: + application/json: + schema: + type: object + properties: + change_events: + type: array + items: + $ref: '#/components/schemas/ChangeEvent' + examples: + response: + summary: Response Example + value: + change_events: + - summary: Build Success - Increase snapshot create timeout to 30 seconds + id: 01BBYA6PEVW6A852BUO6QYUE7O + timestamp: '2020-07-17T08:42:58Z' + type: change_event + source: acme-build-pipeline-tool-default-i-9999 + integration: + id: PEYSGVF + type: inbound_integration_reference + services: + - id: PEYSGRV + type: service_reference + custom_details: + build_state: passed + build_number: '2' + run_time: 1236s + links: + - href: 'https://acme.pagerduty.dev/build/2' + text: View more details in Acme! + - summary: Build Success - Increase snapshot create timeout to 15 seconds + id: 01BBYA6PDIXPL8KO1HPIUL9CZN + timestamp: '2020-07-17T07:42:58Z' + type: change_event + source: acme-build-pipeline-tool-default-i-9999 + integration: + id: PEYSGVF + type: inbound_integration_reference + services: + - id: PEYSGRV + type: service_reference + custom_details: + build_state: passed + build_number: '1' + run_time: 1233s + links: + - href: 'https://acme.pagerduty.dev/build/1' + text: View more details in Acme! + limit: null + offset: null + total: null + more: false + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + post: + summary: Create a Change Event + description: | + 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). + operationId: createChangeEvent + tags: + - Change Events + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + responses: + '202': + description: 'See [`Send Change Event`](https://developer.pagerduty.com/api-reference/b3A6Mjc0ODI2Ng-send-change-events-to-the-pager-duty-events-api) in the V2 Events API reference.' + '/change_events/{id}': + get: + x-pd-requires-scope: change_events.read + tags: + - Change Events + operationId: getChangeEvent + description: | + Get details about an existing Change Event. + + Scoped OAuth requires: `change_events.read` + summary: Get a Change Event + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: The Change Event requested. + content: + application/json: + schema: + type: object + properties: + change_event: + $ref: '#/components/schemas/ChangeEvent' + examples: + response: + summary: Response Example + value: + change_event: + summary: Build Success - Increase snapshot create timeout to 30 seconds + timestamp: '2020-07-17T08:42:58Z' + type: change_event + source: acme-build-pipeline-tool-default-i-9999 + integration: + id: PEYSGVF + type: inbound_integration_reference + services: + - id: PEYSGRV + type: service_reference + custom_details: + build_state: passed + build_number: '2' + run_time: 1236s + links: + - href: 'https://acme.pagerduty.dev/build/2' + text: View more details in Acme! + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + put: + x-pd-requires-scope: change_events.write + summary: Update a Change Event + description: | + Update an existing Change Event + + Scoped OAuth requires: `change_events.write` + tags: + - Change Events + operationId: updateChangeEvent + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + change_event: + $ref: '#/components/schemas/ChangeEvent' + required: + - change_event + examples: + request: + summary: Request Example + value: + change_event: + summary: Build Success - Increase snapshot create timeout to 30 seconds + type: change_event + custom_details: + build_state: passed + build_number: '2' + run_time: 1236s + description: The Change Event to be updated. + responses: + '200': + description: The Change Event that was updated. + content: + application/json: + schema: + type: object + properties: + change_event: + $ref: '#/components/schemas/ChangeEvent' + examples: + response: + summary: Response Example + value: + change_event: + summary: Build Success - Increase snapshot create timeout to 30 seconds + timestamp: '2020-07-17T08:42:58Z' + type: change_event + source: acme-build-pipeline-tool-default-i-9999 + integration: + id: PEYSGVF + type: inbound_integration_reference + services: + - id: PEYSGRV + type: service_reference + custom_details: + build_state: passed + build_number: '2' + run_time: 1236s + links: + - href: 'https://acme.pagerduty.dev/build/2' + text: View more details in Acme! + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '/incidents/{id}/related_change_events': + get: + x-pd-requires-scope: incidents.read + tags: + - Change Events + operationId: listIncidentRelatedChangeEvents + description: | + 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` + summary: List related Change Events for an Incident + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + responses: + '200': + description: The array of Change Events returned by the query. + content: + application/json: + schema: + type: object + properties: + change_events: + type: array + items: + allOf: + - $ref: '#/components/schemas/ChangeEvent' + - type: object + properties: + correlation_reason: + type: object + properties: + reason: + type: string + enum: + - most_recent + - related_service + - intelligent + readOnly: true + description: The reason a change event was determined to be related to the given incident. + examples: + response: + summary: Response Example + value: + change_events: + - summary: Build Success - Increase snapshot create timeout to 30 seconds + id: 01BBYA6PEVW6A852BUO6QYUE7O + timestamp: '2020-07-17T08:42:58Z' + type: change_event + source: acme-build-pipeline-tool-default-i-9999 + integration: + id: PEYSGVF + type: inbound_integration_reference + services: + - id: PEYSGRV + type: service_reference + custom_details: + build_state: passed + build_number: '2' + run_time: 1236s + links: + - href: 'https://acme.pagerduty.dev/build/2' + text: View more details in Acme! + correlation_reason: + reason: most_recent + - summary: Build Success - Increase snapshot create timeout to 15 seconds + id: 01BBYA6PDIXPL8KO1HPIUL9CZN + timestamp: '2020-07-17T07:42:58Z' + type: change_event + source: acme-build-pipeline-tool-default-i-9999 + integration: + id: PEYSGVF + type: inbound_integration_reference + services: + - id: PEYSGRV + type: service_reference + custom_details: + build_state: passed + build_number: '1' + run_time: 1233s + links: + - href: 'https://acme.pagerduty.dev/build/1' + text: View more details in Acme! + correlation_reason: + reason: related_service + limit: null + offset: null + total: null + more: false + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '/services/{id}/change_events': + get: + x-pd-requires-scope: services.read + tags: + - Change Events + operationId: listServiceChangeEvents + description: | + List all of the existing Change Events for a service. + + Scoped OAuth requires: `services.read` + summary: List Change Events for a service + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/change_since' + - $ref: '#/components/parameters/change_until' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/team_ids' + - $ref: '#/components/parameters/integration_ids' + responses: + '200': + description: The array of Change Events returned by the query. + content: + application/json: + schema: + type: object + properties: + change_events: + type: array + items: + $ref: '#/components/schemas/ChangeEvent' + examples: + response: + summary: Response Example + value: + change_events: + - summary: Build Success - Increase snapshot create timeout to 30 seconds + id: 01BBYA6PEVW6A852BUO6QYUE7O + timestamp: '2020-07-17T08:42:58Z' + type: change_event + source: acme-build-pipeline-tool-default-i-9999 + integration: + id: PEYSGVF + type: inbound_integration_reference + services: + - id: PEYSGRV + type: service_reference + custom_details: + build_state: passed + build_number: '2' + run_time: 1236s + links: + - href: 'https://acme.pagerduty.dev/build/2' + text: View more details in Acme! + - summary: Build Success - Increase snapshot create timeout to 15 seconds + id: 01BBYA6PDIXPL8KO1HPIUL9CZN + timestamp: '2020-07-17T07:42:58Z' + type: change_event + source: acme-build-pipeline-tool-default-i-9999 + integration: + id: PEYSGVF + type: inbound_integration_reference + services: + - id: PEYSGRV + type: service_reference + custom_details: + build_state: passed + build_number: '1' + run_time: 1233s + links: + - href: 'https://acme.pagerduty.dev/build/1' + text: View more details in Acme! + limit: null + offset: null + total: null + more: false + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/custom_fields.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/custom_fields.yaml new file mode 100644 index 0000000..719c28c --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/custom_fields.yaml @@ -0,0 +1,4934 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - custom_fields + description: Custom_Fields +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + CustomFieldsFieldWithOptions: + allOf: + - $ref: '#/components/schemas/CustomFieldsField' + - type: object + properties: + field_options: + type: array + description: The fixed list of value options that may be stored in this field. + items: + $ref: '#/components/schemas/CustomFieldsFieldOption' + nullable: true + CustomFieldsField: + allOf: + - $ref: '#/components/schemas/CustomFieldsEditableField' + - type: object + properties: + id: + type: string + readOnly: true + description: The ID of the resource. + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + self: + type: string + nullable: true + readOnly: true + format: url + description: The API show URL at which the object is accessible + type: + type: string + enum: + - field + created_at: + type: string + format: date-time + description: The date/time the object was created at. + readOnly: true + updated_at: + type: string + format: date-time + description: The date/time the object was last updated. + readOnly: true + datatype: + $ref: '#/components/schemas/CustomFieldsFieldValue/properties/datatype' + multi_value: + $ref: '#/components/schemas/CustomFieldsFieldValue/properties/multi_value' + fixed_options: + $ref: '#/components/schemas/CustomFieldsFieldValue/properties/fixed_options' + required: + - id + - summary + - self + - type + - created_at + - updated_at + - datatype + - namespace + - name + - display_name + - multi_value + - fixed_options + CustomFieldsFieldOption: + allOf: + - $ref: '#/components/schemas/CustomFieldsEditableFieldOption' + - type: object + required: + - id + - type + - data + - created_at + - updated_at + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + CustomFieldsEditableField: + type: object + properties: + display_name: + $ref: '#/components/schemas/CustomFieldsFieldValue/properties/display_name' + description: + $ref: '#/components/schemas/CustomFieldsFieldValue/properties/description' + CustomFieldsFieldValue: + type: object + properties: + id: + type: string + description: Id of the field. + name: + type: string + description: 'The name of the field. May include ASCII characters, specifically lowercase letters, digits, and underescores. The `name` for a Field must be unique.' + maxLength: 50 + type: + type: string + description: Determines the type of the reference. + enum: + - field_value + display_name: + type: string + description: The human-readable name of the field. This must be unique across an account. + maxLength: 50 + multi_value: + type: boolean + description: 'If `true`, allows the custom field to store a set of multiple values. Must be `false` if `datatype` is not "string" or "url"' + datatype: + type: string + description: The kind of data the custom field is allowed to contain. + enum: + - boolean + - integer + - float + - string + - datetime + - url + description: + type: string + nullable: true + description: A description of the data this field contains. + maxLength: 1000 + fixed_options: + type: boolean + description: 'If `true`, restricts the values allowed to be stored in the custom field to a limited set of options (configured via the Field Option sub-resource). Must be `false` if `datatype` is "boolean", "url", or "datetime"' + value: + oneOf: + - type: object + properties: + value: + type: boolean + nullable: true + - type: object + properties: + value: + type: number + nullable: true + - type: object + properties: + value: + type: integer + nullable: true + - type: object + properties: + value: + oneOf: + - type: string + maxLength: 200 + nullable: true + - type: array + items: + type: string + maxLength: 200 + maxItems: 10 + uniqueItems: true + nullable: true + - type: object + properties: + value: + type: string + nullable: true + format: date-time + - type: object + properties: + value: + oneOf: + - type: string + format: uri + maxLength: 200 + nullable: true + - type: array + items: + type: string + format: uri + maxLength: 200 + maxItems: 10 + uniqueItems: true + nullable: true + required: + - id + - type + - name + - value + - display_name + - datatype + - multi_value + - description + - fixed_options + CustomFieldsEditableFieldOption: + type: object + properties: + id: + type: string + readOnly: true + description: The ID of the resource. + type: + type: string + enum: + - field_option + created_at: + type: string + format: date-time + description: The date/time the object was created at. + readOnly: true + updated_at: + type: string + format: date-time + description: The date/time the object was last updated. + readOnly: true + data: + oneOf: + - type: object + properties: + datatype: + type: string + description: The kind of data represented by this option. Must match the Field's `datatype`. + enum: + - integer + value: + type: integer + required: + - datatype + - value + - type: object + properties: + datatype: + type: string + description: The kind of data represented by this option. Must match the Field's `datatype`. + enum: + - float + value: + type: number + required: + - datatype + - value + - type: object + properties: + datatype: + type: string + description: The kind of data represented by this option. Must match the Field's `datatype`. + enum: + - string + value: + type: string + maxLength: 200 + required: + - datatype + - value + discriminator: + propertyName: datatype + mapping: + integer: ./IntegerFixedOptionValue.yaml + float: ./FloatFixedOptionValue.yaml + string: ./StringFixedOptionValue.yaml + required: + - id + - type + - created_at + - updated_at + description: '' + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + CustomFieldsSchemaWithTimestamps: + allOf: + - $ref: '#/components/schemas/CustomFieldsIncidentSchema/allOf/0' + - type: object + properties: + created_at: + type: string + format: date-time + description: The date/time the object was created at. + readOnly: true + updated_at: + type: string + format: date-time + description: The date/time the object was last updated. + readOnly: true + required: + - created_at + - updated_at + CustomFieldsIncidentSchema: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + description: The ID of the resource. + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + self: + type: string + nullable: true + readOnly: true + format: url + description: The API show URL at which the object is accessible + type: + type: string + readOnly: true + enum: + - schema + title: + description: The name of the schema. + type: string + maxLength: 100 + description: + description: A description of this schema. + type: string + nullable: true + maxLength: 1000 + required: + - id + - type + - summary + - self + - type: object + properties: + field_configurations: + type: array + readOnly: true + items: + allOf: + - $ref: '#/components/schemas/CustomFieldsFieldConfigurationWithFieldReference/allOf/0' + - type: object + properties: + field: + $ref: '#/components/schemas/CustomFieldsFieldWithOptions' + maxItems: 20 + uniqueItems: true + required: + - title + - description + CustomFieldsFieldConfigurationWithFieldReference: + allOf: + - allOf: + - $ref: '#/components/schemas/CustomFieldsEditableFieldConfiguration' + - type: object + properties: + type: + type: string + enum: + - field_configuration + required: + - id + - type + - created_at + - updated_at + - field + - required + - type: object + properties: + field: + description: The Field to be included in this schema. Each Field may only be used in one Field Configuration per schema. + allOf: + - type: object + properties: + type: + type: string + description: 'A string that determines the type of the reference. This must be the standard name for the entity, suffixed by `_reference`.' + enum: + - field_reference + id: + type: string + description: The ID of the resource. + required: + - type + - id + CustomFieldsEditableFieldConfiguration: + type: object + properties: + default_value: + type: object + description: The value to use for this field if none is provided. It must be specified if `required` is `true`. + allOf: + - oneOf: + - allOf: + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/0' + - type: object + properties: + datatype: + type: string + enum: + - boolean + required: + - datatype + - value + - allOf: + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/2' + - type: object + properties: + datatype: + type: string + enum: + - integer + required: + - datatype + - value + - allOf: + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/1' + - type: object + properties: + datatype: + type: string + enum: + - float + required: + - datatype + - value + - allOf: + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/3' + - type: object + properties: + datatype: + type: string + enum: + - string + required: + - datatype + - value + - allOf: + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/4' + - type: object + properties: + datatype: + type: string + enum: + - datetime + required: + - datatype + - value + - allOf: + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/5' + - type: object + properties: + datatype: + type: string + enum: + - url + required: + - datatype + - value + - type: object + properties: + datatype: + type: string + enum: + - field_option + value: + oneOf: + - type: object + properties: + type: + type: string + enum: + - field_option_reference + id: + type: string + description: 'The ID of the field option. If value is not provided, an ID must be provided.' + value: + type: string + description: 'The value of the field option. If ID is not provided, an value must be provided.' + required: + - type + - id + - value + - type: array + items: + type: object + properties: + type: + type: string + enum: + - field_option_reference + id: + type: string + description: 'The ID of the field option. If value is not provided, an ID must be provided.' + value: + type: string + description: 'The value of the field option. If ID is not provided, an value must be provided.' + required: + - type + - id + - value + maxItems: 10 + uniqueItems: true + nullable: true + required: + - datatype + - value + discriminator: + propertyName: datatype + mapping: + boolean: ./BooleanFieldValue.yaml + integer: ./IntegerFieldValue.yaml + float: ./FloatFieldValue.yaml + string: ./StringFieldValue.yaml + datetime: ./DatetimeFieldValue.yaml + url: ./UrlFieldValue.yaml + field_option: ./FieldOptionFieldValue.yaml + - type: object + properties: + multi_value: + type: boolean + description: 'If `true`, allows the custom field to store a set of values. Must match the Field''s `multi_value` setting.' + required: + - multi_value + id: + type: string + readOnly: true + description: The ID of the resource. + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + created_at: + type: string + format: date-time + description: The date/time the object was created at. + readOnly: true + updated_at: + type: string + format: date-time + description: The date/time the object was last updated. + readOnly: true + required: + description: 'If `true`, this Field must always have a value set for objects using this schema.' + type: boolean + CustomFieldsEditableSchemaAssignment: + type: object + properties: + schema: + type: object + properties: + id: + type: string + description: The schema ID + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + description: 'A string that determines the type of the reference. This must be the standard name for the entity, suffixed by `_reference`.' + enum: + - schema_reference + self: + type: string + nullable: true + readOnly: true + format: url + description: The API show URL at which the object is accessible + required: + - id + - type + service: + type: object + properties: + id: + type: string + description: The service ID + type: + type: string + description: 'A string that determines the type of the reference. This must be the standard name for the entity, suffixed by `_reference`.' + enum: + - service_reference + required: + - id + - type + CustomFieldsSchemaAssignment: + allOf: + - $ref: '#/components/schemas/CustomFieldsEditableSchemaAssignment' + - type: object + properties: + id: + type: string + readOnly: true + description: The ID of the resource. + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + enum: + - schema_assignment + created_at: + type: string + format: date-time + description: The date/time the object was created at. + readOnly: true + updated_at: + type: string + format: date-time + description: The date/time the object was last updated. + readOnly: true + required: + - id + - type + - created_at + - updated_at + CustomFieldsCreatableSchema: + allOf: + - $ref: '#/components/schemas/CustomFieldsEditableSchema' + required: + - title + CustomFieldsSchemaWithConfigurations: + allOf: + - $ref: '#/components/schemas/CustomFieldsSchemaWithTimestamps' + - type: object + properties: + field_configurations: + type: array + readOnly: true + items: + allOf: + - $ref: '#/components/schemas/CustomFieldsFieldConfigurationWithFieldReference/allOf/0' + - type: object + properties: + field: + description: The Field to be included in this schema. Each Field may only be used in one Field Configuration per schema. + allOf: + - $ref: '#/components/schemas/CustomFieldsField' + maxItems: 20 + uniqueItems: true + required: + - title + - description + CustomFieldsEditableSchema: + allOf: + - $ref: '#/components/schemas/CustomFieldsSchemaWithTimestamps' + - type: object + properties: + field_configurations: + type: array + items: + $ref: '#/components/schemas/CustomFieldsFieldConfigurationWithFieldReference' + maxItems: 20 + uniqueItems: true + CustomFieldsFieldConfigurationWithFieldOrFieldReference: + allOf: + - $ref: '#/components/schemas/CustomFieldsFieldConfigurationWithFieldReference/allOf/0' + - type: object + properties: + field: + description: The Field to be included in this schema. Each Field may only be used in one Field Configuration per schema. + oneOf: + - $ref: '#/components/schemas/CustomFieldsField' + - $ref: '#/components/schemas/CustomFieldsFieldConfigurationWithFieldReference/allOf/1/properties/field/allOf/0' + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + InternalServerError: + description: Internal Server Error the PagerDuty server experienced an error. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + customfields_fields: + id: pagerduty.custom_fields.customfields_fields + name: customfields_fields + title: Customfields Fields + methods: + create_custom_fields_field: + operation: + $ref: '#/paths/~1customfields~1fields/post' + response: + mediaType: application/json + openAPIDocKey: '201' + list_custom_fields_fields: + operation: + $ref: '#/paths/~1customfields~1fields/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.fields + _list_custom_fields_fields: + operation: + $ref: '#/paths/~1customfields~1fields/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_custom_fields_field: + operation: + $ref: '#/paths/~1customfields~1fields~1{field_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.field + _get_custom_fields_field: + operation: + $ref: '#/paths/~1customfields~1fields~1{field_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_custom_fields_field: + operation: + $ref: '#/paths/~1customfields~1fields~1{field_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_custom_fields_field: + operation: + $ref: '#/paths/~1customfields~1fields~1{field_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/customfields_fields/methods/get_custom_fields_field' + - $ref: '#/components/x-stackQL-resources/customfields_fields/methods/list_custom_fields_fields' + insert: + - $ref: '#/components/x-stackQL-resources/customfields_fields/methods/create_custom_fields_field' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/customfields_fields/methods/delete_custom_fields_field' + customfields_fields_field_options: + id: pagerduty.custom_fields.customfields_fields_field_options + name: customfields_fields_field_options + title: Customfields Fields Field Options + methods: + create_custom_fields_field_option: + operation: + $ref: '#/paths/~1customfields~1fields~1{field_id}~1field_options/post' + response: + mediaType: application/json + openAPIDocKey: '201' + list_custom_fields_field_options: + operation: + $ref: '#/paths/~1customfields~1fields~1{field_id}~1field_options/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.field_options + _list_custom_fields_field_options: + operation: + $ref: '#/paths/~1customfields~1fields~1{field_id}~1field_options/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_custom_fields_field_option: + operation: + $ref: '#/paths/~1customfields~1fields~1{field_id}~1field_options~1{field_option_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.field_option + _get_custom_fields_field_option: + operation: + $ref: '#/paths/~1customfields~1fields~1{field_id}~1field_options~1{field_option_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_custom_fields_field_option: + operation: + $ref: '#/paths/~1customfields~1fields~1{field_id}~1field_options~1{field_option_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_custom_fields_field_option: + operation: + $ref: '#/paths/~1customfields~1fields~1{field_id}~1field_options~1{field_option_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/customfields_fields_field_options/methods/get_custom_fields_field_option' + - $ref: '#/components/x-stackQL-resources/customfields_fields_field_options/methods/list_custom_fields_field_options' + insert: + - $ref: '#/components/x-stackQL-resources/customfields_fields_field_options/methods/create_custom_fields_field_option' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/customfields_fields_field_options/methods/delete_custom_fields_field_option' + fields_schemas: + id: pagerduty.custom_fields.fields_schemas + name: fields_schemas + title: Fields Schemas + methods: + list_custom_fields_schemas_using_field: + operation: + $ref: '#/paths/~1customfields~1fields~1{field_id}~1schemas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.schemas + _list_custom_fields_schemas_using_field: + operation: + $ref: '#/paths/~1customfields~1fields~1{field_id}~1schemas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/fields_schemas/methods/list_custom_fields_schemas_using_field' + insert: [] + update: [] + delete: [] + schema_assignments: + id: pagerduty.custom_fields.schema_assignments + name: schema_assignments + title: Schema Assignments + methods: + create_custom_fields_schema_assignment: + operation: + $ref: '#/paths/~1customfields~1schema_assignments/post' + response: + mediaType: application/json + openAPIDocKey: '201' + list_schema_assignments: + operation: + $ref: '#/paths/~1customfields~1schema_assignments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.schema_assignments + _list_schema_assignments: + operation: + $ref: '#/paths/~1customfields~1schema_assignments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_schema_assignment: + operation: + $ref: '#/paths/~1customfields~1schema_assignments~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schema_assignments/methods/list_schema_assignments' + insert: + - $ref: '#/components/x-stackQL-resources/schema_assignments/methods/create_custom_fields_schema_assignment' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/schema_assignments/methods/delete_schema_assignment' + schemas: + id: pagerduty.custom_fields.schemas + name: schemas + title: Schemas + methods: + create_custom_fields_schema: + operation: + $ref: '#/paths/~1customfields~1schemas/post' + response: + mediaType: application/json + openAPIDocKey: '201' + list_custom_fields_schemas: + operation: + $ref: '#/paths/~1customfields~1schemas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.schemas + _list_custom_fields_schemas: + operation: + $ref: '#/paths/~1customfields~1schemas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_custom_fields_schema: + operation: + $ref: '#/paths/~1customfields~1schemas~1{schema_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.schema + _get_custom_fields_schema: + operation: + $ref: '#/paths/~1customfields~1schemas~1{schema_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_custom_fields_schema: + operation: + $ref: '#/paths/~1customfields~1schemas~1{schema_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_custom_fields_schema: + operation: + $ref: '#/paths/~1customfields~1schemas~1{schema_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schemas/methods/get_custom_fields_schema' + - $ref: '#/components/x-stackQL-resources/schemas/methods/list_custom_fields_schemas' + insert: + - $ref: '#/components/x-stackQL-resources/schemas/methods/create_custom_fields_schema' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/schemas/methods/delete_custom_fields_schema' + field_configurations: + id: pagerduty.custom_fields.field_configurations + name: field_configurations + title: Field Configurations + methods: + create_custom_fields_field_configuration: + operation: + $ref: '#/paths/~1customfields~1schemas~1{schema_id}~1field_configurations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + list_custom_fields_field_configurations: + operation: + $ref: '#/paths/~1customfields~1schemas~1{schema_id}~1field_configurations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.field_configurations + _list_custom_fields_field_configurations: + operation: + $ref: '#/paths/~1customfields~1schemas~1{schema_id}~1field_configurations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_custom_fields_field_configuration: + operation: + $ref: '#/paths/~1customfields~1schemas~1{schema_id}~1field_configurations~1{field_configuration_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.field_configuration + _get_custom_fields_field_configuration: + operation: + $ref: '#/paths/~1customfields~1schemas~1{schema_id}~1field_configurations~1{field_configuration_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_custom_fields_field_configuration: + operation: + $ref: '#/paths/~1customfields~1schemas~1{schema_id}~1field_configurations~1{field_configuration_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_custom_fields_field_configuration: + operation: + $ref: '#/paths/~1customfields~1schemas~1{schema_id}~1field_configurations~1{field_configuration_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/field_configurations/methods/get_custom_fields_field_configuration' + - $ref: '#/components/x-stackQL-resources/field_configurations/methods/list_custom_fields_field_configurations' + insert: + - $ref: '#/components/x-stackQL-resources/field_configurations/methods/create_custom_fields_field_configuration' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/field_configurations/methods/delete_custom_fields_field_configuration' +paths: + /customfields/fields: + post: + tags: + - Custom Fields + operationId: createCustomFieldsField + description: | + Create a new Field, along with the Field Options if provided. An account may have up to 1000 Fields. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Create a Field + parameters: + - $ref: '#/components/parameters/early_access_customfields' + requestBody: + content: + application/json: + schema: + type: object + properties: + field: + $ref: '#/components/schemas/CustomFieldsFieldWithOptions' + required: + - field + examples: + request1: + summary: 'Example: With field_options' + value: + field: + datatype: string + name: environment + display_name: Environment + fixed_options: true + multi_value: false + description: The environment that the issue occurred in + field_options: + - data: + datatype: string + value: production + request2: + summary: 'Example: Without field_options' + value: + field: + datatype: string + name: environment + display_name: Environment + fixed_options: true + multi_value: false + description: The environment that the issue occurred in + responses: + '201': + description: 'The field object created, along with the Field Options if provided.' + content: + application/json: + schema: + type: object + properties: + field: + $ref: '#/components/schemas/CustomFieldsFieldWithOptions' + required: + - field + examples: + response1: + summary: 'Example: With field_options' + value: + field: + id: P5IYCNZ + type: field + summary: environment + self: 'https://api.pagerduty.com/customfields/fields/P5IYCNZ' + datatype: string + name: environment + display_name: Environment + multi_value: false + fixed_options: true + description: The environment that the issue occurred in + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + field_options: + - id: PT4KHEE + type: field_option + data: + datatype: string + value: production + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + response2: + summary: 'Example: Without field_options' + value: + field: + id: P5IYCNZ + type: field + summary: environment + self: 'https://api.pagerduty.com/customfields/fields/P5IYCNZ' + datatype: string + name: environment + display_name: Environment + multi_value: false + fixed_options: false + description: The environment that the issue occurred in + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '500': + $ref: '#/components/responses/InternalServerError' + get: + tags: + - Custom Fields + operationId: listCustomFieldsFields + description: | + List fields. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: List Fields + parameters: + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/include_customfields_field' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '200': + description: A paginated list of fields. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + fields: + type: array + items: + $ref: '#/components/schemas/CustomFieldsFieldWithOptions' + required: + - fields + examples: + response: + summary: Response Example + value: + fields: + - id: P5IYCNZ + type: field + summary: environment + self: 'https://api.pagerduty.com/customfields/fields/P5IYCNZ' + datatype: string + name: environment + display_name: Environment + description: The environment that the issue occurred in + multi_value: false + fixed_options: true + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + field_options: + - id: PT4KHEE + type: field_option + data: + datatype: string + value: abc + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + limit: 1 + offset: 0 + more: true + '400': + $ref: '#/components/responses/ArgumentError' + '500': + $ref: '#/components/responses/InternalServerError' + '/customfields/fields/{field_id}': + get: + tags: + - Custom Fields + operationId: getCustomFieldsField + description: | + Show detailed information about a field. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Get a Field + parameters: + - $ref: '#/components/parameters/field_id' + - $ref: '#/components/parameters/include_customfields_field' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '200': + description: The field requested. + content: + application/json: + schema: + type: object + properties: + field: + $ref: '#/components/schemas/CustomFieldsFieldWithOptions' + required: + - field + examples: + response1: + summary: 'Example: No query parameters' + value: + field: + id: P5IYCNZ + type: field + summary: environment + self: 'https://api.pagerduty.com/customfields/fields/P5IYCNZ' + datatype: string + name: environment + display_name: Environment + description: The environment that the issue occurred in + multi_value: false + fixed_options: true + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + response2: + summary: 'Example: Using include[]=field_options' + value: + field: + id: P5IYCNZ + type: field + summary: environment + self: 'https://api.pagerduty.com/customfields/fields/P5IYCNZ' + datatype: string + name: environment + display_name: Environment + description: The environment that the issue occurred in + multi_value: false + fixed_options: true + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + field_options: + - id: PT4KHEE + type: field_option + data: + datatype: string + value: abc + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + put: + tags: + - Custom Fields + operationId: updateCustomFieldsField + description: | + Update a field. + + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Update a Field + parameters: + - $ref: '#/components/parameters/field_id' + - $ref: '#/components/parameters/early_access_customfields' + requestBody: + content: + application/json: + schema: + type: object + properties: + field: + $ref: '#/components/schemas/CustomFieldsEditableField' + required: + - field + examples: + request: + summary: Request Example + value: + field: + display_name: New Display Name! + description: New description! + responses: + '200': + description: The field object updated. + content: + application/json: + schema: + type: object + properties: + field: + $ref: '#/components/schemas/CustomFieldsField' + required: + - field + examples: + response: + summary: Response Example + value: + field: + id: P5IYCNZ + type: field + summary: old_name + self: 'https://api.pagerduty.com/customfields/fields/P5IYCNZ' + datatype: string + name: old_name + display_name: New Display Name! + description: New description! + multi_value: false + fixed_options: false + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + delete: + tags: + - Custom Fields + operationId: deleteCustomFieldsField + description: | + Delete a Field. Fields may not be deleted if they are used by a Field Schema. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Delete a Field + parameters: + - $ref: '#/components/parameters/field_id' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '204': + description: The field was deleted successfully. + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + '/customfields/fields/{field_id}/field_options': + post: + tags: + - Custom Fields + operationId: createCustomFieldsFieldOption + description: | + Create a new Field Option. Field Options may only be created for Fields where `fixed_options` is `true`. A Field may have no more than 10 enabled options. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Create a Field Option + parameters: + - $ref: '#/components/parameters/field_id' + - $ref: '#/components/parameters/early_access_customfields' + requestBody: + content: + application/json: + schema: + type: object + properties: + field_option: + $ref: '#/components/schemas/CustomFieldsFieldOption' + required: + - field_option + examples: + request: + summary: Request Example + value: + field_option: + data: + datatype: string + value: production + responses: + '201': + description: The field option created. + content: + application/json: + schema: + type: object + properties: + field_option: + $ref: '#/components/schemas/CustomFieldsFieldOption' + required: + - field_option + examples: + response: + summary: Response Example + value: + field_option: + id: PQ9K7I8 + type: field_option + data: + datatype: string + value: production + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + get: + tags: + - Custom Fields + operationId: listCustomFieldsFieldOptions + description: | + List all enabled Field Options for a Field. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: List Field Options + parameters: + - $ref: '#/components/parameters/field_id' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '200': + description: A list of field options. + content: + application/json: + schema: + type: object + properties: + field_options: + type: array + items: + $ref: '#/components/schemas/CustomFieldsFieldOption' + required: + - field_options + examples: + response: + summary: Response Example + value: + field_options: + - id: PQ9K7I8 + type: field_option + data: + datatype: string + value: production + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + '/customfields/fields/{field_id}/field_options/{field_option_id}': + get: + tags: + - Custom Fields + operationId: getCustomFieldsFieldOption + description: | + Get a Field Option. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Get Field Option + parameters: + - $ref: '#/components/parameters/field_id' + - $ref: '#/components/parameters/field_option_id' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '200': + description: The field option requested. + content: + application/json: + schema: + type: object + properties: + field_option: + $ref: '#/components/schemas/CustomFieldsFieldOption' + required: + - field_option + examples: + response: + summary: Response Example + value: + field_option: + id: PQ9K7I8 + type: field_option + data: + datatype: string + value: prod + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + put: + tags: + - Custom Fields + operationId: updateCustomFieldsFieldOption + description: | + Update Field Option for a Field. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Update a Field Option + parameters: + - $ref: '#/components/parameters/field_id' + - $ref: '#/components/parameters/field_option_id' + - $ref: '#/components/parameters/early_access_customfields' + requestBody: + content: + application/json: + schema: + type: object + properties: + field_option: + $ref: '#/components/schemas/CustomFieldsEditableFieldOption' + required: + - field_option + examples: + request: + summary: Request Example + value: + field_option: + data: + datatype: string + value: prod + responses: + '200': + description: The field option object updated. + content: + application/json: + schema: + type: object + properties: + field_option: + $ref: '#/components/schemas/CustomFieldsFieldOption' + required: + - field_option + examples: + response: + summary: Response Example + value: + field_option: + id: PQ9K7I8 + type: field_option + data: + datatype: string + value: prod + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + delete: + tags: + - Custom Fields + operationId: deleteCustomFieldsFieldOption + description: | + Delete a Field Option. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Delete a Field Option + parameters: + - $ref: '#/components/parameters/field_id' + - $ref: '#/components/parameters/field_option_id' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '204': + description: The field option was deleted successfully. + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + '/customfields/fields/{field_id}/schemas': + get: + tags: + - Custom Fields + operationId: listCustomFieldsSchemasUsingField + description: | + List all Schemas using the Field. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: List Schemas using Field + parameters: + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/field_id' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '200': + description: A paginated list of schemas using the field. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + schemas: + type: array + readOnly: true + items: + $ref: '#/components/schemas/CustomFieldsSchemaWithTimestamps' + required: + - schemas + examples: + response: + summary: Response Example + value: + schemas: + - id: PT20YPA + type: schema + self: 'https://api.pagerduty.com/customfields/schemas/PT20YPA' + summary: Security Incident + title: Security Incident + description: Default schema to use for security incidents + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + limit: 1 + offset: 0 + more: true + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + /customfields/schema_assignments: + post: + tags: + - Custom Fields + operationId: createCustomFieldsSchemaAssignment + description: | + Assign a new Schema to a service + + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Create a Schema Assignment + parameters: + - $ref: '#/components/parameters/early_access_customfields' + requestBody: + content: + application/json: + schema: + type: object + properties: + schema_assignment: + $ref: '#/components/schemas/CustomFieldsEditableSchemaAssignment' + required: + - schema_assignment + examples: + request: + summary: Request Example + value: + schema_assignment: + service: + id: PT4KHLX + type: service_reference + schema: + id: PT4KHEE + type: schema_reference + responses: + '201': + description: The schema assignment created. + content: + application/json: + schema: + type: object + properties: + schema_assignment: + $ref: '#/components/schemas/CustomFieldsSchemaAssignment' + required: + - schema_assignment + examples: + response: + summary: Response Example + value: + schema_assignment: + id: P9CBJS2 + type: schema_assignment + service: + id: PT4KHLX + type: service_refence + schema: + id: PT4KHEE + type: schema_reference + summary: The schema summary + self: 'https://api.pagerduty.com/customfields/schemas/PT20YPA' + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '500': + $ref: '#/components/responses/InternalServerError' + get: + tags: + - Custom Fields + operationId: listSchemaAssignments + description: | + List Schema Assignments by `service_id` or `schema_id` + + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: List Schema Assignments + parameters: + - $ref: '#/components/parameters/customfields_query_schema_assignments_filter' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '200': + description: The list of Assignments + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + schema_assignments: + type: array + items: + $ref: '#/components/schemas/CustomFieldsSchemaAssignment' + required: + - schema_assignments + examples: + response: + summary: Response Example + value: + schema_assignments: + - id: P9CBJS2 + type: schema_assignment + service: + id: PT4KHLX + type: service_reference + schema: + id: PT4KHEE + type: schema_reference + summary: The schema summary + self: 'https://api.pagerduty.com/customfields/schemas/PT20YPA' + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + limit: 1 + offset: 0 + more: true + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + '/customfields/schema_assignments/{id}': + delete: + tags: + - Custom Fields + operationId: deleteSchemaAssignment + description: | + Remove the Schema assigned to a service + + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Remove a Schema Assignment + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '204': + description: The schema assignment was deleted successfully. + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '500': + $ref: '#/components/responses/InternalServerError' + /customfields/schemas: + post: + tags: + - Custom Fields + operationId: createCustomFieldsSchema + description: | + Create a new Schema, along with the Field Configurations if provided. An account may have up to 100 Schemas. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Create a Schema + parameters: + - $ref: '#/components/parameters/early_access_customfields' + requestBody: + content: + application/json: + schema: + type: object + properties: + schema: + $ref: '#/components/schemas/CustomFieldsCreatableSchema' + required: + - schema + examples: + request1: + summary: 'Example: With field_configurations' + value: + schema: + title: Security Incident + description: Default schema to use for security incidents + field_configurations: + - field: + id: PT4KZZZ + type: field_reference + required: false + request2: + summary: 'Example: Without field_configurations' + value: + schema: + title: Security Incident + description: Default schema to use for security incidents + responses: + '201': + description: 'The schema object created, along with the Field Configurations if provided.' + content: + application/json: + schema: + type: object + properties: + schema: + $ref: '#/components/schemas/CustomFieldsSchemaWithConfigurations' + required: + - schema + examples: + response1: + summary: 'Example: With field_configurations' + value: + schema: + id: PT20YPA + type: schema + summary: Security Incident + self: 'https://api.pagerduty.com/customfields/schemas/PT20YPA' + title: Security Incident + description: Default schema to use for security incidents + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + field_configurations: + - id: PT4KHEE + type: field_configuration + required: false + default_value: null + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + field: + id: PT4KZZZ + type: field + self: 'https://api.pagerduty.com/customfields/fields/PT4KZZZ' + summary: environment + name: environment + display_name: Environment + description: null + datatype: string + multi_value: true + fixed_options: false + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + response2: + summary: 'Example: Without field_configurations' + value: + schema: + id: PT20YPA + type: schema + summary: Security Incident + self: 'https://api.pagerduty.com/customfields/schemas/PT20YPA' + title: Security Incident + description: Default schema to use for security incidents + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '500': + $ref: '#/components/responses/InternalServerError' + get: + tags: + - Custom Fields + operationId: listCustomFieldsSchemas + description: | + List all Schemas. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: List Schemas + parameters: + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '200': + description: A paginated list of schemas. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + schemas: + type: array + readOnly: true + items: + $ref: '#/components/schemas/CustomFieldsSchemaWithTimestamps' + required: + - schemas + examples: + response: + summary: Response Example + value: + schemas: + - id: PT20YPA + type: schema + self: 'https://api.pagerduty.com/customfields/schemas/PT20YPA' + summary: Security Incident + title: Security Incident + description: Default schema to use for security incidents + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + limit: 1 + offset: 0 + more: true + '400': + $ref: '#/components/responses/ArgumentError' + '500': + $ref: '#/components/responses/InternalServerError' + '/customfields/schemas/{schema_id}': + get: + tags: + - Custom Fields + operationId: getCustomFieldsSchema + description: | + Get detailed information about a Schema. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Get a Schema + parameters: + - $ref: '#/components/parameters/schema_id' + - $ref: '#/components/parameters/include_customfields_schema' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '200': + description: The schema requested. + content: + application/json: + schema: + type: object + properties: + schema: + $ref: '#/components/schemas/CustomFieldsSchemaWithConfigurations' + required: + - schema + examples: + response1: + summary: 'Example: No query parameters' + value: + schema: + id: PT20YPA + type: schema + self: 'https://api.pagerduty.com/customfields/schemas/PT20YPA' + summary: Security Incident + title: Security Incident + description: Default schema to use for security incidents + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + response2: + summary: 'Example: Using include[]=field_configurations' + value: + schema: + id: PT20YPA + type: schema + self: 'https://api.pagerduty.com/customfields/schemas/PT20YPA' + summary: Security Incident + title: Security Incident + description: Default schema to use for security incidents + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + field_configurations: + - id: PT4KHEE + type: field_configuration + field: + id: PT4KZZZ + type: field + self: 'https://api.pagerduty.com/customfields/fields/PT4KZZZ' + summary: environment + name: environment + description: null + display_name: Environment + datatype: string + multi_value: true + fixed_options: false + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + required: true + default_value: + datatype: string + multi_value: true + value: + - prod + - stg + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + put: + tags: + - Custom Fields + operationId: updateCustomFieldsSchema + description: | + Update a Schema, along with the Field Configurations if provided. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Update a Schema + parameters: + - $ref: '#/components/parameters/schema_id' + - $ref: '#/components/parameters/early_access_customfields' + requestBody: + content: + application/json: + schema: + type: object + properties: + schema: + $ref: '#/components/schemas/CustomFieldsEditableSchema' + required: + - schema + examples: + request1: + summary: 'Example: With field_configurations' + value: + schema: + title: New title! + field_configurations: + - field: + id: PT4KZZZ + type: field_reference + required: false + request2: + summary: 'Example: Without field_configurations' + value: + schema: + title: New title! + responses: + '200': + description: 'The schema object updated, along with the Field Configurations if provided.' + content: + application/json: + schema: + type: object + properties: + schema: + $ref: '#/components/schemas/CustomFieldsSchemaWithConfigurations' + required: + - schema + examples: + response1: + summary: 'Example: With field_configurations' + value: + schema: + id: PT20YPA + type: schema + self: 'https://api.pagerduty.com/customfields/schemas/PT20YPA' + summary: Security Incident + title: New title! + description: Default schema to use for security incidents + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + field_configurations: + - id: PT4KHEE + type: field_configuration + required: false + default_value: null + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + field: + id: PT4KZZZ + type: field + self: 'https://api.pagerduty.com/customfields/fields/PT4KZZZ' + summary: environment + name: environment + display_name: Environment + description: null + datatype: string + multi_value: true + fixed_options: false + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + response2: + summary: 'Example: Without field_configurations' + value: + schema: + id: PT20YPA + type: schema + self: 'https://api.pagerduty.com/customfields/schemas/PT20YPA' + summary: Security Incident + title: New title! + description: Default schema to use for security incidents + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + delete: + tags: + - Custom Fields + operationId: deleteCustomFieldsSchema + description: | + Delete a Schema. Schemas may not be deleted if they are in use by any Service. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Delete a Schema + parameters: + - $ref: '#/components/parameters/schema_id' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '204': + description: The schema was deleted successfully. + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '409': + $ref: '#/components/responses/Conflict' + '500': + $ref: '#/components/responses/InternalServerError' + '/customfields/schemas/{schema_id}/field_configurations': + post: + tags: + - Custom Fields + operationId: createCustomFieldsFieldConfiguration + description: | + Add a new Field Configuration to an existing Schema. A Schema may use at most 20 Fields, and so may have at most 20 Field Configurations. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Create a Field Configuration + parameters: + - $ref: '#/components/parameters/schema_id' + - $ref: '#/components/parameters/early_access_customfields' + requestBody: + content: + application/json: + schema: + type: object + properties: + field_configuration: + $ref: '#/components/schemas/CustomFieldsFieldConfigurationWithFieldReference' + required: + - field_configuration + examples: + request: + summary: Request Example + value: + field_configuration: + field: + id: PT20YPA + type: field_reference + required: true + default_value: + datatype: string + multi_value: true + value: + - prod + - stg + responses: + '201': + description: The field configuration object created. + content: + application/json: + schema: + type: object + properties: + field_configuration: + $ref: '#/components/schemas/CustomFieldsFieldConfigurationWithFieldReference' + required: + - field_configuration + examples: + response: + summary: Response Example + value: + id: PT4KHEE + type: field_configuration + field: + id: PT20YPA + type: field_reference + required: true + default_value: + datatype: string + multi_value: true + value: + - prod + - stg + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + get: + tags: + - Custom Fields + operationId: listCustomFieldsFieldConfigurations + description: | + List all Field Configurations for the given Schema. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: List Field Configurations + parameters: + - $ref: '#/components/parameters/schema_id' + - $ref: '#/components/parameters/include_customfields_field_configuration' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '200': + description: A list of field configurations in the schema. + content: + application/json: + schema: + type: object + properties: + field_configurations: + type: array + items: + $ref: '#/components/schemas/CustomFieldsFieldConfigurationWithFieldOrFieldReference' + required: + - field_configurations + examples: + response1: + summary: 'Example: No query parameters' + value: + field_configurations: + - id: PT4KHEE + type: field_configuration + field: + id: PT20YPA + type: field_reference + required: true + default_value: + datatype: string + multi_value: true + value: + - prod + - stg + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + response2: + summary: 'Example: Using include[]=fields' + value: + field_configurations: + - id: PT4KHEE + type: field_configuration + field: + id: PT20YPA + type: field + self: 'https://api.pagerduty.com/customfields/fields/PT4KZZZ' + summary: environment + name: environment + display_name: Environment + description: null + datatype: string + multi_value: true + fixed_options: false + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + required: true + default_value: + datatype: string + multi_value: true + value: + - prod + - stg + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + '/customfields/schemas/{schema_id}/field_configurations/{field_configuration_id}': + get: + tags: + - Custom Fields + operationId: getCustomFieldsFieldConfiguration + description: | + Show detailed information about a Field Configuration. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Get a Field Configuration + parameters: + - $ref: '#/components/parameters/schema_id' + - $ref: '#/components/parameters/field_configuration_id' + - $ref: '#/components/parameters/include_customfields_field_configuration' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '200': + description: The field configuration requested. + content: + application/json: + schema: + type: object + properties: + field_configuration: + $ref: '#/components/schemas/CustomFieldsFieldConfigurationWithFieldOrFieldReference' + required: + - field_configuration + examples: + response1: + summary: 'Example: No query parameters' + value: + field_configuration: + id: PT4KHEE + type: field_configuration + field: + id: PT20YPA + type: field_reference + required: true + default_value: + datatype: string + multi_value: true + value: + - prod + - stg + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + response2: + summary: 'Example: Using include[]=fields' + value: + field_configuration: + id: PT4KHEE + type: field_configuration + field: + id: PT20YPA + type: field + self: 'https://api.pagerduty.com/customfields/fields/PT4KZZZ' + summary: environment + name: environment + display_name: Environment + description: null + datatype: string + multi_value: true + fixed_options: false + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + required: true + default_value: + datatype: string + multi_value: true + value: + - prod + - stg + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + put: + tags: + - Custom Fields + operationId: updateCustomFieldsFieldConfiguration + description: | + Update settings for Field Configuration in Schema. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Update a Field Configuration + parameters: + - $ref: '#/components/parameters/schema_id' + - $ref: '#/components/parameters/field_configuration_id' + - $ref: '#/components/parameters/early_access_customfields' + requestBody: + content: + application/json: + schema: + type: object + properties: + field_configuration: + $ref: '#/components/schemas/CustomFieldsEditableFieldConfiguration' + required: + - field_configuration + examples: + request: + summary: Request Example + value: + field_configuration: + required: false + default_value: null + responses: + '200': + description: The field configuration that was updated. + content: + application/json: + schema: + type: object + properties: + field_configuration: + $ref: '#/components/schemas/CustomFieldsFieldConfigurationWithFieldReference' + required: + - field_configuration + examples: + response: + summary: Response Example + value: + field_configuration: + id: PT4KHEE + type: field_configuration + field: + id: PT20YPA + type: field_reference + required: false + default_value: null + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + delete: + tags: + - Custom Fields + operationId: deleteCustomFieldsFieldConfiguration + description: | + Remove a Field Configuration and its associated Field from a Schema. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Delete a Field Configuration + parameters: + - $ref: '#/components/parameters/schema_id' + - $ref: '#/components/parameters/field_configuration_id' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '204': + description: The field configuration was deleted successfully from the schema. + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/escalation_policies.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/escalation_policies.yaml new file mode 100644 index 0000000..2005227 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/escalation_policies.yaml @@ -0,0 +1,3424 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - escalation_policies + description: Escalation_Policies +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + EscalationPolicy: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + type: + type: string + description: The type of object being created. + default: escalation_policy + enum: + - escalation_policy + name: + type: string + description: The name of the escalation policy. + description: + type: string + description: Escalation policy description. + num_loops: + type: integer + description: The number of times the escalation policy will repeat after reaching the end of its escalation. + default: 0 + minimum: 0 + on_call_handoff_notifications: + type: string + description: Determines how on call handoff notifications will be sent for users on the escalation policy. Defaults to "if_has_services". + enum: + - if_has_services + - always + escalation_rules: + type: array + items: + $ref: '#/components/schemas/EscalationRule' + services: + type: array + items: + $ref: '#/components/schemas/ServiceReference' + minLength: 0 + readOnly: true + teams: + type: array + description: Team associated with the policy. Account must have the `teams` ability to use this parameter. Only one team may be associated with the policy. + items: + $ref: '#/components/schemas/TeamReference' + minLength: 0 + required: + - type + - name + - escalation_rules + example: + id: PQIL2IX + type: escalation_policy + name: Engineering Escalation Policy + escalation_rules: + - escalation_delay_in_minutes: 30 + targets: + - id: PEYSGVF + type: user_reference + services: + - id: PIJ90N7 + type: service_reference + num_loops: 2 + on_call_handoff_notifications: if_has_services + teams: + - id: PQ9K7I8 + type: team_reference + description: Here is the ep for the engineering team. + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + EscalationRule: + type: object + properties: + id: + type: string + readOnly: true + escalation_delay_in_minutes: + type: integer + description: The number of minutes before an unacknowledged incident escalates away from this rule. + targets: + type: array + minItems: 1 + maxItems: 10 + description: The targets an incident should be assigned to upon reaching this rule. + items: + $ref: '#/components/schemas/EscalationTargetReference' + required: + - escalation_delay_in_minutes + - targets + example: + escalation_delay_in_minutes: 30 + targets: + - id: PAM4FGS + type: user_reference + - id: PI7DH85 + type: schedule_reference + ServiceReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - service_reference + TeamReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - team_reference + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + EscalationTargetReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + description: The escalation target is the entity that will be assigned an incident upon escalation. + properties: + type: + enum: + - user + - schedule + - user_reference + - schedule_reference + type: string + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + AuditRecordResponseSchema: + allOf: + - type: object + properties: + records: + type: array + items: + $ref: '#/components/schemas/AuditRecord' + response_metadata: + nullable: true + anyOf: + - $ref: '#/components/schemas/AuditMetadata' + required: + - records + - $ref: '#/components/schemas/CursorPagination' + AuditRecord: + type: object + readOnly: true + description: An Audit Trail record + properties: + id: + type: string + self: + type: string + nullable: true + description: Record URL. + execution_time: + type: string + format: date-time + description: 'The date/time the action executed, in ISO8601 format and millisecond precision.' + execution_context: + type: object + description: Action execution context + properties: + request_id: + type: string + nullable: true + description: Request Id + remote_address: + type: string + nullable: true + description: remote address + nullable: true + actors: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + method: + type: object + description: The method information + properties: + description: + type: string + nullable: true + truncated_token: + description: Truncated token containing the last 4 chars of the token's actual value. + type: string + nullable: true + example: 3xyz + type: + $ref: '#/components/parameters/audit_method_type/schema' + required: + - type + root_resource: + $ref: '#/components/schemas/Reference' + action: + type: string + example: create + details: + type: object + nullable: true + description: | + Additional details to provide further information about the action or + the resource that has been audited. + properties: + resource: + $ref: '#/components/schemas/Reference' + fields: + description: | + A set of fields that have been affected. + The fields that have not been affected MAY be returned. + type: array + nullable: true + items: + type: object + description: | + Information about the affected field. + When available, field's before and after values are returned: + + #### Resource creation + - `value` MAY be returned + + #### Resource update + - `value` MAY be returned + - `before_value` MAY be returned + + #### Resource deletion + - `before_value` MAY be returned + properties: + name: + type: string + description: Name of the resource field + example: name + description: + type: string + nullable: true + description: Human readable description of the resource field + example: First and Last name + value: + type: string + nullable: true + description: new or updated value of the field + example: Jonathan + before_value: + type: string + nullable: true + description: previous or deleted value of the field + example: John + required: + - name + references: + description: A set of references that have been affected. + type: array + nullable: true + items: + type: object + properties: + name: + type: string + description: Name of the reference field + example: team_members + description: + type: string + nullable: true + description: Human readable description of the references field + example: First and Last name + added: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + removed: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + required: + - name + required: + - resource + required: + - id + - execution_time + - method + - root_resource + - action + AuditMetadata: + type: object + properties: + messages: + type: array + nullable: true + items: + type: string + example: Message about the result + CursorPagination: + type: object + properties: + limit: + type: integer + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + readOnly: true + next_cursor: + type: string + description: | + An opaque string than will deliver the next set of results when provided as the `cursor` parameter in a subsequent request. A `null` value for this field indicates that there are no additional results. + example: dXNlcjaVMzc5V0ZYTlo= + nullable: true + readOnly: true + required: + - limit + - next_cursor + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + PaymentRequired: + description: | + Account does not have the abilities to perform the action. Please review the response for the required abilities. + You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + InternalServerError: + description: Internal Server Error the PagerDuty server experienced an error. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + escalation_policies: + id: pagerduty.escalation_policies.escalation_policies + name: escalation_policies + title: Escalation Policies + methods: + list_escalation_policies: + operation: + $ref: '#/paths/~1escalation_policies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.escalation_policies + _list_escalation_policies: + operation: + $ref: '#/paths/~1escalation_policies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_escalation_policy: + operation: + $ref: '#/paths/~1escalation_policies/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_escalation_policy: + operation: + $ref: '#/paths/~1escalation_policies~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.escalation_policy + _get_escalation_policy: + operation: + $ref: '#/paths/~1escalation_policies~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_escalation_policy: + operation: + $ref: '#/paths/~1escalation_policies~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_escalation_policy: + operation: + $ref: '#/paths/~1escalation_policies~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/escalation_policies/methods/get_escalation_policy' + - $ref: '#/components/x-stackQL-resources/escalation_policies/methods/list_escalation_policies' + insert: + - $ref: '#/components/x-stackQL-resources/escalation_policies/methods/create_escalation_policy' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/escalation_policies/methods/delete_escalation_policy' + audit_records: + id: pagerduty.escalation_policies.audit_records + name: audit_records + title: Audit Records + methods: + list_escalation_policy_audit_records: + operation: + $ref: '#/paths/~1escalation_policies~1{id}~1audit~1records/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.records + _list_escalation_policy_audit_records: + operation: + $ref: '#/paths/~1escalation_policies~1{id}~1audit~1records/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/audit_records/methods/list_escalation_policy_audit_records' + insert: [] + update: [] + delete: [] +paths: + /escalation_policies: + get: + tags: + - Escalation Policies + x-pd-requires-scope: escalation_policies.read + operationId: listEscalationPolicies + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies) + + Scoped OAuth requires: `escalation_policies.read` + summary: List escalation policies + parameters: + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/user_ids_escalation_policies' + - $ref: '#/components/parameters/team_ids' + - $ref: '#/components/parameters/include_escalation_policy' + - $ref: '#/components/parameters/sort_by_escalation_policy' + responses: + '200': + description: A paginated array of escalation policy objects. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + escalation_policies: + type: array + items: + $ref: '#/components/schemas/EscalationPolicy' + required: + - escalation_policies + examples: + response: + summary: Response Example + value: + escalation_policies: + - id: PANZZEQ + type: escalation_policy + summary: Engineering Escalation Policy + on_call_handoff_notifications: if_has_services + self: 'https://api.pagerduty.com/escalation_policies/PANZZEQ' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PANZZEQ' + name: Engineering Escalation Policy + escalation_rules: + - id: PANZZEQ + escalation_delay_in_minutes: 30 + targets: + - id: PEYSGVF + summary: PagerDuty Admin + type: user_reference + self: 'https://api.pagerduty.com/users/PEYSGVF' + html_url: 'https://subdomain.pagerduty.com/users/PEYSGVF' + - id: PI7DH85 + summary: Daily Engineering Rotation + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PI7DH85' + html_url: 'https://subdomain.pagerduty.com/schedules/PI7DH85' + services: + - id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + num_loops: 0 + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + limit: 25 + offset: 0 + more: false + total: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + tags: + - Escalation Policies + x-pd-requires-scope: escalation_policies.write + operationId: createEscalationPolicy + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies) + + Scoped OAuth requires: `escalation_policies.write` + summary: Create an escalation policy + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/optional_from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + escalation_policy: + $ref: '#/components/schemas/EscalationPolicy' + required: + - escalation_policy + examples: + request: + summary: Request Example + value: + escalation_policy: + type: escalation_policy + name: Engineering Escalation Policy + escalation_rules: + - escalation_delay_in_minutes: 30 + targets: + - id: PEYSGVF + type: user_reference + services: + - id: PIJ90N7 + type: service_reference + num_loops: 2 + on_call_handoff_notifications: if_has_services + teams: + - id: PQ9K7I8 + type: team_reference + description: Here is the ep for the engineering team. + description: The escalation policy to be created. + responses: + '201': + description: The escalation policy that was created. + content: + application/json: + schema: + type: object + properties: + escalation_policy: + $ref: '#/components/schemas/EscalationPolicy' + required: + - escalation_policy + examples: + response: + summary: Response Example + value: + escalation_policy: + id: PT20YPA + type: escalation_policy + summary: Engineering Escalation Policy + on_call_handoff_notifications: if_has_services + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + name: Engineering Escalation Policy + escalation_rules: + - id: PT20YPA + escalation_delay_in_minutes: 22 + targets: + - id: PXPGF42 + summary: Earline Greenholt + type: user_reference + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + - id: PI7DH85 + summary: Daily Engineering Rotation + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PI7DH85' + html_url: 'https://subdomain.pagerduty.com/schedules/PI7DH85' + services: + - id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + num_loops: 2 + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/escalation_policies/{id}': + get: + tags: + - Escalation Policies + x-pd-requires-scope: escalation_policies.read + operationId: getEscalationPolicy + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies) + + Scoped OAuth requires: `escalation_policies.read` + summary: Get an escalation policy + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/include_escalation_policy' + responses: + '200': + description: The escalation policy object. + content: + application/json: + schema: + type: object + properties: + escalation_policy: + $ref: '#/components/schemas/EscalationPolicy' + required: + - escalation_policy + examples: + response: + summary: Response Example + value: + escalation_policy: + id: PT20YPA + type: escalation_policy + summary: Another Escalation Policy + on_call_handoff_notifications: if_has_services + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + name: Another Escalation Policy + escalation_rules: + - id: PGHDV41 + escalation_delay_in_minutes: 30 + targets: + - id: PAM4FGS + summary: Kyler Kuhn + type: user_reference + self: 'https://api.pagerduty.com/users/PAM4FGS' + html_url: 'https://subdomain.pagerduty.com/users/PAM4FGS' + - id: PI7DH85 + summary: Daily Engineering Rotation + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PI7DH85' + html_url: 'https://subdomain.pagerduty.com/schedules/PI7DH85' + services: + - id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + num_loops: 2 + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + description: This is yet another escalation policy + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + delete: + tags: + - Escalation Policies + x-pd-requires-scope: escalation_policies.write + operationId: deleteEscalationPolicy + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies) + + Scoped OAuth requires: `escalation_policies.write` + summary: Delete an escalation policy + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '204': + description: The escalation policy was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + tags: + - Escalation Policies + x-pd-requires-scope: escalation_policies.write + operationId: updateEscalationPolicy + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies) + + Scoped OAuth requires: `escalation_policies.write` + summary: Update an escalation policy + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + escalation_policy: + $ref: '#/components/schemas/EscalationPolicy' + required: + - escalation_policy + examples: + request: + summary: Request Example + value: + escalation_policy: + type: escalation_policy + name: Engineering Escalation Policy + escalation_rules: + - escalation_delay_in_minutes: 30 + targets: + - id: PEYSGVF + type: user_reference + services: + - id: PIJ90N7 + type: service_reference + num_loops: 2 + on_call_handoff_notifications: if_has_services + teams: + - id: PQ9K7I8 + type: team_reference + description: Here is the ep for the engineering team. + description: The escalation policy to be updated. + responses: + '200': + description: The escalation policy that was updated. + content: + application/json: + schema: + type: object + properties: + escalation_policy: + $ref: '#/components/schemas/EscalationPolicy' + required: + - escalation_policy + examples: + response: + summary: Response Example + value: + escalation_policy: + id: PT20YPA + type: escalation_policy + summary: Another Escalation Policy + on_call_handoff_notifications: if_has_services + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + name: Another Escalation Policy + escalation_rules: + - id: PGHDV41 + escalation_delay_in_minutes: 30 + targets: + - id: PAM4FGS + summary: Kyler Kuhn + type: user_reference + self: 'https://api.pagerduty.com/users/PAM4FGS' + html_url: 'https://subdomain.pagerduty.com/users/PAM4FGS' + - id: PI7DH85 + summary: Daily Engineering Rotation + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PI7DH85' + html_url: 'https://subdomain.pagerduty.com/schedules/PI7DH85' + services: + - id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + num_loops: 2 + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + description: This is yet another escalation policy + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/escalation_policies/{id}/audit/records': + get: + x-pd-requires-scope: audit_records.read + tags: + - Escalation Policies + operationId: listEscalationPolicyAuditRecords + summary: List audit records for an escalation policy + description: | + 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` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/cursor_limit' + - $ref: '#/components/parameters/cursor_cursor' + - $ref: '#/components/parameters/audit_since' + - $ref: '#/components/parameters/audit_until' + responses: + '200': + description: Records matching the query criteria. + content: + application/json: + schema: + $ref: '#/components/schemas/AuditRecordResponseSchema' + examples: + response: + $ref: '#/components/examples/AuditRecordEscalationPolicyResponse' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/event_orchestrations.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/event_orchestrations.yaml new file mode 100644 index 0000000..fc0fc42 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/event_orchestrations.yaml @@ -0,0 +1,5378 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - event_orchestrations + description: Event_Orchestrations +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + Orchestration: + type: object + properties: + id: + type: string + description: ID of the Orchestration. + readOnly: true + self: + type: string + format: url + description: The API show URL at which the object is accessible + readOnly: true + name: + type: string + description: Name of the Orchestration. + description: + type: string + description: A description of this Orchestration's purpose. + team: + type: object + description: 'Reference to the team that owns the Orchestration. If none is specified, only admins have access.' + properties: + id: + type: string + type: + type: string + description: A string that determines the schema of the object + readOnly: true + self: + type: string + format: url + description: The API show URL at which the object is accessible + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/OrchestrationIntegration' + readOnly: true + routes: + type: integer + description: Number of different Service Orchestration being routed to + readOnly: true + created_at: + type: string + format: date-time + description: The date the Orchestration was created at. + readOnly: true + created_by: + type: object + description: Reference to the user that has created the Orchestration. + properties: + id: + type: string + readOnly: true + type: + type: string + description: A string that determines the schema of the object + readOnly: true + self: + type: string + format: url + description: The API show URL at which the object is accessible + readOnly: true + readOnly: true + updated_at: + type: string + format: date-time + description: The date the Orchestration was last updated. + readOnly: true + updated_by: + type: object + description: Reference to the user that has updated the Orchestration last. + properties: + id: + type: string + readOnly: true + type: + type: string + description: A string that determines the schema of the object + readOnly: true + self: + type: string + format: url + description: The API show URL at which the object is accessible + readOnly: true + readOnly: true + version: + type: string + description: Version of the Orchestration. + readOnly: true + OrchestrationIntegration: + type: object + properties: + id: + type: string + description: ID of the Integration. + readOnly: true + label: + type: string + description: Name of the Integration. + parameters: + type: object + readOnly: true + properties: + routing_key: + type: string + description: Routing Key used to send Events to this Orchestration + readOnly: true + type: + type: string + default: global + readOnly: true + OrchestrationGlobal: + allOf: + - type: object + properties: + orchestration_path: + type: object + properties: + type: + type: string + default: service + readOnly: true + parent: + type: object + properties: + id: + type: string + description: ID of the object these Orchestration Rules belongs to. + readOnly: true + type: + type: string + description: A string that determines the schema of the parent object + readOnly: true + self: + type: string + format: url + description: The API show URL at which the parent object is accessible + readOnly: true + readOnly: true + sets: + type: array + description: 'Must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph of rules.' + items: + type: object + description: A set of rules + properties: + id: + type: string + description: The ID of this set of rules. Rules in other sets can route events into this set using the "route_to" properties. + default: start + rules: + type: array + items: + type: object + properties: + id: + type: string + description: ID of the rule + readOnly: true + label: + type: string + description: A description of this rule's purpose. + conditions: + type: array + description: Each of these conditions is evaluated to check if an event matches this rule. The rule is considered a match if **any** of these conditions match. + items: + type: object + properties: + expression: + type: string + description: A PCL condition string + example: event.summary matches part 'my service error' + actions: + type: object + description: 'When an event matches this rule, these are the actions that will be taken to change the resulting alert and incident.' + disabled: + type: boolean + description: Indicates whether the rule is disabled and would therefore not be evaluated. + catch_all: + type: object + description: 'When none of the Rules in a set match an event, we apply the catch_all actions to the event.' + properties: + actions: + type: object + description: These are the actions that will be taken to change the resulting alert and incident. + created_at: + type: string + format: date-time + description: The date/time the object was created. + readOnly: true + created_by: + type: object + description: Reference to the user that created the object. + properties: + id: + type: string + readOnly: true + type: + type: string + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + readOnly: true + self: + type: string + format: url + description: The API show URL at which the object is accessible + readOnly: true + readOnly: true + updated_at: + type: string + format: date-time + description: The date/time the object was last updated. + readOnly: true + updated_by: + type: object + description: Reference to the user that last updated the object. + properties: + id: + type: string + readOnly: true + type: + type: string + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + readOnly: true + self: + type: string + format: url + description: The API show URL at which the object is accessible + readOnly: true + readOnly: true + version: + type: string + description: Version of these Orchestration Rules + readOnly: true + required: + - orchestration_path + - type: object + properties: + orchestration_path: + properties: + type: + description: Indicates that these are a set of "global" rules. + default: global + parent: + properties: + id: + description: ID of the Global Event Orchestration these Global Rules belongs to. + type: + enum: + - event_orchestration_reference + sets: + description: 'You must define at least a "start" set, but you can also define any number of additional sets that are routed to by other rules to form a directional graph.' + items: + properties: + rules: + items: + properties: + actions: + allOf: + - properties: + route_to: + type: string + description: The ID of a Set from this Global Orchestration whose rules you also want to use with event that match this rule. + - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/0' + - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/1' + - $ref: '#/components/schemas/OrchestrationUnrouted/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions' + - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/3' + catch_all: + description: 'When none of the rules match an event, the event will be routed according to the catch_all settings.' + properties: + actions: + allOf: + - type: object + properties: + suppress: + type: boolean + description: 'If true, the resulting alert is suppressed. Suppressed alerts will not trigger an incident.' + suspend: + type: integer + description: The number of seconds to suspend the resulting alert before triggering. This effectively pauses incident notifications. If a resolve event arrives before the alert triggers then PagerDuty won't create an incident for this the resulting alert. + drop_event: + type: boolean + description: 'If true, this event will be dropped. Dropped events will not trigger or resolve an alert or an incident. Dropped events will not be evaluated against router rules.' + - type: object + properties: + priority: + type: string + description: The ID of the priority you want to set on resulting incident. You can find the list of priority IDs for your account by calling the priorities endpoint. + example: P53ZZH5 + annotate: + type: string + description: Add this text as a note on the resulting incident. + - $ref: '#/components/schemas/OrchestrationUnrouted/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions' + - type: object + properties: + automation_actions: + type: array + description: Create a Webhoook associated with the resulting incident. + items: + type: object + properties: + name: + type: string + description: The name of the Webhook. + url: + type: string + description: The API endpoint where PagerDuty's servers will send the webhook request. + auto_send: + type: boolean + description: 'When true, PagerDuty''s servers will automatically send this webhook request as soon as the resulting incident is created. When false, your incident responder will be able to manually trigger the Webhook via the PagerDuty website & mobile app.' + default: false + headers: + type: array + description: Specify custom key/value pairs that'll be sent with the webhook request as request headers. + items: + type: object + properties: + key: + type: string + value: + type: string + parameters: + type: array + description: Specify custom key/value pairs that'll be included in the webhook request's JSON payload. + items: + type: object + properties: + key: + type: string + value: + type: string + example: + $ref: '#/components/examples/OrchestrationPathGlobalTypeResponse/value' + OrchestrationUnrouted: + allOf: + - $ref: '#/components/schemas/OrchestrationGlobal/allOf/0' + - type: object + properties: + orchestration_path: + properties: + type: + description: Indicates that these are a "unrouted" type set of rules. + default: unrouted + parent: + properties: + id: + description: ID of the Global Event Orchestration this Unrouted Orchestration belongs to. + type: + enum: + - event_orchestration_reference + sets: + description: 'An Unrouted Orchestration must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph.' + items: + properties: + rules: + items: + properties: + actions: + allOf: + - properties: + route_to: + type: string + description: The ID of a Set from this Unrouted Orchestration whose rules you also want to use with event that match this rule. + - $ref: '#/components/schemas/OrchestrationUnrouted/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions' + catch_all: + properties: + actions: + type: object + properties: + severity: + type: string + description: Set the severity of the resulting alert. + enum: + - info + - error + - warning + - critical + event_action: + type: string + description: Set whether the resulting alert status is trigger or resolve. + enum: + - trigger + - resolve + variables: + type: array + description: Populate variables from event payloads and use those variables in other event actions. + items: + type: object + properties: + name: + type: string + description: The name of the variable + example: server_name + path: + type: string + description: 'Path to a field in an event, in dot-notation.' + example: event.summary + type: + type: string + description: The type of operation to populate the variable. Currently only Regex-based variable extraction is supported. + enum: + - regex + value: + type: string + description: 'A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used.' + example: High CPU on (.*) server + extractions: + type: array + description: Dynamically extract values to set and modify new and existing PD-CEF fields. + items: + anyOf: + - type: object + description: Use a template string & variables + properties: + target: + type: string + description: The PD-CEF field that will be set with the value from the template. + example: event.summary + template: + type: string + description: A value that will be used to populate the target PD-CEF field. You can include variables extracted from the payload by using string interpolation. + example: 'High CPU on {{hostname}} server' + - type: object + description: Use a regex to extract a value + properties: + target: + type: string + description: The PD-CEF field that will be set with the value from the regex. + example: event.custom_details.server + regex: + type: string + description: 'A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used.' + example: High CPU on (.*) server + source: + type: string + description: The path to the event field where the regex will be applied to extract a value. + example: event.summary + example: + orchestration_path: + type: unrouted + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/router' + sets: + - id: start + rules: + - label: Update the summary of un-matched Critical alerts so they're easier to spot + id: 38880ffb + conditions: + - expression: event.severity matches 'critical' + actions: + extractions: + - target: event.summary + template: '[Critical Unrouted] {{event.summary}}' + - label: Reduce the severity of all other unrouted events + id: 3896801e + conditions: [] + actions: + severity: info + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: aZO.EEf9zWb9Vg0NYq.Uqad1hOC2Maod + OrchestrationWarningIneligible: + type: object + description: This rule is using a feature that is currently unavailable on the current account plan. + properties: + message: + type: string + description: A description of the warning and any potential side effects. + rule_id: + type: string + description: The ID of the rule using the feature. + feature: + type: string + description: The feature that the current account plan does not have access to. + enum: + - threshold_condition + - recurring_condition + - scheduled_condition + - nested_rules + - suspend + - automation_actions + - pagerduty_automation_actions + - extractions + - variables + - suppress + feature_type: + type: string + description: 'Specifies whether the feature is a part of the rule''s conditions, or its actions.' + enum: + - conditions + - actions + - nested_rules + warning_type: + type: string + description: The type of warning that is being returned for the rule. + enum: + - forbidden_feature + OrchestrationRouter: + allOf: + - $ref: '#/components/schemas/OrchestrationGlobal/allOf/0' + - type: object + properties: + orchestration_path: + properties: + type: + description: Indicates that these are a "router" type set of rules. + default: router + parent: + properties: + id: + description: ID of the Global Event Orchestration this Router belongs to. + type: + enum: + - event_orchestration_reference + sets: + description: 'The Router contains a single set of rules (the "start" set). The Router evaluates Events against these Rules, one at a time, and routes each Event to a specific Service based on the first rule that matches.' + maxItems: 1 + minItems: 1 + items: + properties: + rules: + items: + properties: + actions: + properties: + route_to: + type: string + description: The ID of the target Service for the resulting alert. You can find the service you want to route to by calling the services endpoint. + example: PSI2I2O + catch_all: + description: 'When none of the rules match an event, the event will be routed according to the catch_all settings.' + properties: + actions: + properties: + route_to: + description: 'With a value of ''unrouted'', all events are sent to the Unrouted Orchestration.' + type: string + default: unrouted + example: + orchestration_path: + type: router + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/router' + sets: + - id: start + rules: + - label: Events relating to our relational database + id: 1c26698b + conditions: + - expression: event.summary matches part 'database' + - expression: 'event.source matches regex ''db[0-9]+-server''' + actions: + route_to: PB31XBA + - label: Events relating to our www app server + id: d9801904 + conditions: + - expression: event.summary matches part 'www' + actions: + route_to: PC2D9ML + catch_all: + actions: + route_to: unrouted + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: 9co0z4b152oICsoV91_PW2.ww8ip_xap + ServiceOrchestration: + allOf: + - $ref: '#/components/schemas/OrchestrationGlobal/allOf/0' + - type: object + properties: + orchestration_path: + properties: + type: + description: Indicates that these are sets of rules belonging to a service. + default: service + parent: + properties: + id: + description: The ID of the Service this Orchestration belongs to. + type: + enum: + - service_reference + sets: + description: 'A Service Orchestration must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph.' + items: + properties: + rules: + items: + properties: + actions: + allOf: + - properties: + route_to: + type: string + description: The ID of a Set from this Service Orchestration whose rules you also want to use with event that match this rule. + - $ref: '#/components/schemas/ServiceOrchestration/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/0' + - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/1' + - $ref: '#/components/schemas/OrchestrationUnrouted/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions' + - $ref: '#/components/schemas/ServiceOrchestration/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/3' + - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/3' + catch_all: + properties: + actions: + allOf: + - type: object + properties: + suppress: + type: boolean + description: 'If true, the resulting alert is suppressed. Suppressed alerts will not trigger an incident.' + suspend: + type: integer + description: The number of seconds to suspend the resulting alert before triggering. This effectively pauses incident notifications. If a resolve event arrives before the alert triggers then PagerDuty won't create an incident for this the resulting alert. + - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/1' + - $ref: '#/components/schemas/OrchestrationUnrouted/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions' + - type: object + properties: + pagerduty_automation_actions: + type: array + description: Configure an Automation Action associated with the resulting incident. + items: + type: object + properties: + action_id: + type: string + description: Automation Action ID + - $ref: '#/components/schemas/OrchestrationGlobal/allOf/1/properties/orchestration_path/properties/catch_all/properties/actions/allOf/3' + example: + orchestration_path: + type: service + parent: + id: PC2D9ML + self: 'https://api.pagerduty.com/service/PC2D9ML' + type: service_reference + self: 'https://api.pagerduty.com/event_orchestrations/service/PC2D9ML' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - event.severity matches 'critical' + actions: + annotate: 'Please use our P1 runbook: https://docs.test/p1-runbook' + priority: P0IN2KQ + suppress: false + - label: If the API endpoints return HTTP 502 run an Automation Action that restarts the service + id: 8a874630 + conditions: + - event.custom_details.http_status_code equals '502' + actions: + pagerduty_automation_actions: + - action_id: 01CSB5SMOKCKVRI5GN0LJG7SMB + - label: If there's something wrong on the canary let the team know about it in our deployments Slack channel + id: 1f6d9a33 + conditions: + - event.custom_details.hostname matches part 'canary' + actions: + automation_actions: + - name: Canary Slack Notification + url: 'https://our-slack-listerner.test/send-notification' + auto_send: true + headers: + - key: X-Notification-Source + value: PagerDuty Incident Webhook + parameters: + - key: channel + value: '#my-team-channel' + - key: message + value: Something is wrong with the canary deployment + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + NotAllowed: + description: 'The request was received and recognized by the server, but its HTTP method was rejected for the requested resource.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + OrchestrationPathRouterTypeResponse: + description: The Orchestration Router object. + content: + application/json: + schema: + $ref: '#/components/schemas/OrchestrationRouter' + examples: + response: + summary: Example Response + value: + orchestration_path: + type: router + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/router' + sets: + - id: start + rules: + - label: Events relating to our relational database + id: 1c26698b + conditions: + - expression: event.summary matches part 'database' + - expression: 'event.source matches regex ''db[0-9]+-server''' + actions: + route_to: PB31XBA + - label: Events relating to our www app server + id: d9801904 + conditions: + - expression: event.summary matches part 'www' + actions: + route_to: PC2D9ML + catch_all: + actions: + route_to: unrouted + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: 9co0z4b152oICsoV91_PW2.ww8ip_xap + OrchestrationPathUnroutedTypeResponse: + description: The Unrouted Orchestration object. + content: + application/json: + schema: + $ref: '#/components/schemas/OrchestrationUnrouted' + examples: + response: + summary: Example Response + value: + orchestration_path: + type: unrouted + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/router' + sets: + - id: start + rules: + - label: Update the summary of un-matched Critical alerts so they're easier to spot + id: 38880ffb + conditions: + - expression: event.severity matches 'critical' + actions: + extractions: + - target: event.summary + template: '[Critical Unrouted] {{event.summary}}' + - label: Reduce the severity of all other unrouted events + id: 3896801e + conditions: [] + actions: + severity: info + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: aZO.EEf9zWb9Vg0NYq.Uqad1hOC2Maod + OrchestrationPathServiceTypeResponse: + description: The Service Orchestration object. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceOrchestration' + examples: + response: + summary: Example Response + value: + orchestration_path: + type: service + parent: + id: PC2D9ML + self: 'https://api.pagerduty.com/service/PC2D9ML' + type: service_reference + self: 'https://api.pagerduty.com/event_orchestrations/service/PC2D9ML' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to every event sent to this Service + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + pagerduty_automation_actions: + - action_id: 01CSB5SMOKCKVRI5GN0LJG7SMB + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + annotate: 'Please use our P1 runbook: https://docs.test/p1-runbook' + priority: P0IN2KQ + suppress: false + - label: If there's something wrong on the canary let the team know about it in our deployments Slack channel + id: 1f6d9a33 + conditions: + - expression: event.custom_details.hostname matches part 'canary' + actions: + automation_actions: + - name: Canary Slack Notification + url: 'https://our-slack-listerner.test/send-notification' + auto_send: true + headers: + - key: X-Notification-Source + value: PagerDuty Incident Webhook + parameters: + - key: channel + value: '#my-team-channel' + - key: message + value: Something is wrong with the canary deployment + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + OrchestrationPathServiceActiveResponse: + description: An object with the active status. + content: + application/json: + schema: + type: object + properties: + active: + type: boolean + description: The status of the service orchestration. + examples: + response: + summary: Example Response + value: + active: false + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + event_orchestrations: + id: pagerduty.event_orchestrations.event_orchestrations + name: event_orchestrations + title: Event Orchestrations + methods: + list_event_orchestrations: + operation: + $ref: '#/paths/~1event_orchestrations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.orchestrations + _list_event_orchestrations: + operation: + $ref: '#/paths/~1event_orchestrations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + post_orchestration: + operation: + $ref: '#/paths/~1event_orchestrations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_orchestration: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.orchestration + _get_orchestration: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_orchestration: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_orchestration: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/event_orchestrations/methods/get_orchestration' + - $ref: '#/components/x-stackQL-resources/event_orchestrations/methods/list_event_orchestrations' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/event_orchestrations/methods/delete_orchestration' + integrations: + id: pagerduty.event_orchestrations.integrations + name: integrations + title: Integrations + methods: + list_orchestration_integrations: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1integrations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.integrations + _list_orchestration_integrations: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1integrations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + post_orchestration_integration: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1integrations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_orchestration_integration: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1integrations~1{integration_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.integration + _get_orchestration_integration: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1integrations~1{integration_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_orchestration_integration: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1integrations~1{integration_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_orchestration_integration: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1integrations~1{integration_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + migrate_orchestration_integration: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1integrations~1migration/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/integrations/methods/get_orchestration_integration' + - $ref: '#/components/x-stackQL-resources/integrations/methods/list_orchestration_integrations' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/integrations/methods/delete_orchestration_integration' + global: + id: pagerduty.event_orchestrations.global + name: global + title: Global + methods: + get_orch_path_global: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1global/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.orchestration_path + _get_orch_path_global: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1global/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_orch_path_global: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1global/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/global/methods/get_orch_path_global' + insert: [] + update: [] + delete: [] + router: + id: pagerduty.event_orchestrations.router + name: router + title: Router + methods: + get_orch_path_router: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1router/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.orchestration_path + _get_orch_path_router: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1router/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_orch_path_router: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1router/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/router/methods/get_orch_path_router' + insert: [] + update: [] + delete: [] + unrouted: + id: pagerduty.event_orchestrations.unrouted + name: unrouted + title: Unrouted + methods: + get_orch_path_unrouted: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1unrouted/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.orchestration_path + _get_orch_path_unrouted: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1unrouted/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_orch_path_unrouted: + operation: + $ref: '#/paths/~1event_orchestrations~1{id}~1unrouted/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/unrouted/methods/get_orch_path_unrouted' + insert: [] + update: [] + delete: [] + services: + id: pagerduty.event_orchestrations.services + name: services + title: Services + methods: + get_orch_path_service: + operation: + $ref: '#/paths/~1event_orchestrations~1services~1{service_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.orchestration_path + _get_orch_path_service: + operation: + $ref: '#/paths/~1event_orchestrations~1services~1{service_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_orch_path_service: + operation: + $ref: '#/paths/~1event_orchestrations~1services~1{service_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/services/methods/get_orch_path_service' + insert: [] + update: [] + delete: [] + services_active: + id: pagerduty.event_orchestrations.services_active + name: services_active + title: Services Active + methods: + get_orch_active_status: + operation: + $ref: '#/paths/~1event_orchestrations~1services~1{service_id}~1active/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $ + _get_orch_active_status: + operation: + $ref: '#/paths/~1event_orchestrations~1services~1{service_id}~1active/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_orch_active_status: + operation: + $ref: '#/paths/~1event_orchestrations~1services~1{service_id}~1active/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/services_active/methods/get_orch_active_status' + insert: [] + update: [] + delete: [] +paths: + /event_orchestrations: + get: + x-pd-requires-scope: event_orchestrations.read + tags: + - Event Orchestrations + operationId: listEventOrchestrations + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.read` + summary: List Event Orchestrations + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/sort_by_event_orchestration' + responses: + '200': + description: A paginated array of Event Orchestration objects. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + orchestrations: + type: array + items: + type: object + properties: + id: + type: string + description: ID of the Orchestration. + readOnly: true + self: + type: string + format: url + description: The API show URL at which the object is accessible + readOnly: true + name: + type: string + description: Name of the Orchestration. + description: + type: string + description: A description of this Orchestration's purpose. + team: + type: object + description: 'Reference to the team that owns the Orchestration. If none is specified, only admins have access.' + properties: + id: + type: string + type: + type: string + description: A string that determines the schema of the object + readOnly: true + self: + type: string + format: url + description: The API show URL at which the object is accessible + readOnly: true + routes: + type: integer + description: Number of different Service Orchestration being routed to + readOnly: true + created_at: + type: string + format: date-time + description: The date the Orchestration was created at. + readOnly: true + created_by: + type: object + description: Reference to the user that has created the Orchestration. + properties: + id: + type: string + readOnly: true + type: + type: string + description: A string that determines the schema of the object + readOnly: true + self: + type: string + format: url + description: The API show URL at which the object is accessible + readOnly: true + readOnly: true + updated_at: + type: string + format: date-time + description: The date the Orchestration was last updated. + readOnly: true + updated_by: + type: object + description: Reference to the user that has updated the Orchestration last. + properties: + id: + type: string + readOnly: true + type: + type: string + description: A string that determines the schema of the object + readOnly: true + self: + type: string + format: url + description: The API show URL at which the object is accessible + readOnly: true + readOnly: true + version: + type: string + description: Version of the Orchestration. + readOnly: true + examples: + response: + summary: Response Example + value: + orchestrations: + - id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + name: Shopping Cart Orchestration + description: Send shopping cart alerts to the right services + team: + id: PQYP5MN + type: team_reference + self: 'https://api.pagerduty.com/teams/PQYP5MN' + routes: 0 + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: 9co0z4b152oICsoV91_PW2.ww8ip_xap + limit: 25 + offset: 0 + more: false + total: 1 + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + post: + x-pd-requires-scope: event_orchestrations.write + tags: + - Event Orchestrations + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.write` + summary: Create an Orchestration + operationId: postOrchestration + requestBody: + content: + application/json: + schema: + type: object + properties: + orchestration: + $ref: '#/components/schemas/Orchestration' + required: + - orchestration + examples: + create_orchestration: + summary: 'Example: Create Orchestration' + value: + orchestration: + name: New Orchestration + description: This is a newly created orchestration + team: + id: PXD0WR8 + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + responses: + '201': + description: The Orchestration that was created. + content: + application/json: + schema: + type: object + properties: + orchestration: + $ref: '#/components/schemas/Orchestration' + examples: + response: + summary: Response Example + value: + orchestration: + id: 3aae9a17-8585-4d8c-93d3-99742801cd95 + self: 'https://api.pagerduty.com/event_orchestrations/3aae9a17-8585-4d8c-93d3-99742801cd95' + name: New Orchestration + description: This is a newly created orchestration + team: + id: PXD0WR8 + self: 'https://api.pagerduty.com/teams/PXD0WR8' + type: team_reference + integrations: + - id: 461cd942-d7cc-43ef-ac7d-86ba2d58fc45 + label: New Orchestration Default Integration + parameters: + routing_key: R022XIJR9M266DX570EVE6EXP1AFBN6D + type: global + routes: 0 + created_at: '2021-12-02T14:21:42Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-12-02T14:21:42Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: oBgzJsGDOz99G.FKZ0c1C6hw35twk_Ib + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' + '/event_orchestrations/{id}': + get: + x-pd-requires-scope: event_orchestrations.read + tags: + - Event Orchestrations + operationId: getOrchestration + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.read` + summary: Get an Orchestration + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/event_orchestration_id' + responses: + '200': + description: The Orchestration object. + content: + application/json: + schema: + type: object + properties: + orchestration: + $ref: '#/components/schemas/Orchestration' + examples: + response: + summary: Response Example + value: + orchestration: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + name: Shopping Cart Orchestration + description: Send shopping cart alerts to the right services + team: + id: PQYP5MN + type: team_reference + self: 'https://api.pagerduty.com/teams/PQYP5MN' + integrations: + - id: 9c5ff030-12da-4204-a067-25ee61a8df6c + label: Shopping Cart Orchestration Default Integration + parameters: + routing_key: R028DIE06SNKNO6V5ACSLRV7Y0TUVG7T + type: global + routes: 0 + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: 9co0z4b152oICsoV91_PW2.ww8ip_xap + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + put: + x-pd-requires-scope: event_orchestrations.write + tags: + - Event Orchestrations + operationId: updateOrchestration + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.write` + summary: Update an Orchestration + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/event_orchestration_id' + requestBody: + content: + application/json: + schema: + type: object + properties: + orchestration: + $ref: '#/components/schemas/Orchestration' + required: + - orchestration + examples: + change_name: + summary: 'Example: Change name' + value: + orchestration: + name: Go-Kart Orchestration + change_team: + summary: 'Example: Change team' + value: + orchestration: + team: + id: PWL7QXS + change_description: + summary: 'Example: Change description' + value: + orchestration: + description: Orchestration that does some stuff + description: '' + responses: + '200': + description: The Orchestration that was updated. + content: + application/json: + schema: + type: object + properties: + orchestration: + $ref: '#/components/schemas/Orchestration' + examples: + response: + summary: Response Example + value: + orchestration: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + name: Go-Kart Orchestration + description: Orchestration that does some stuff + team: + id: PWL7QXS + type: team_reference + self: 'https://api.pagerduty.com/teams/PWL7QXS' + integrations: + - id: 9c5ff030-12da-4204-a067-25ee61a8df6c + label: Go-Kart Orchestration Default Integration + parameters: + routing_key: R028DIE06SNKNO6V5ACSLRV7Y0TUVG7T + type: global + routes: 0 + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-19T11:42:32Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: BrWLKQBLm8QO2ZYQ0GosHLxdbgWZ0ZR3 + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' + delete: + x-pd-requires-scope: event_orchestrations.write + tags: + - Event Orchestrations + operationId: deleteOrchestration + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.write` + summary: Delete an Orchestration + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/event_orchestration_id' + responses: + '204': + description: The Orchestration was deleted successfully. + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' + '/event_orchestrations/{id}/integrations': + get: + x-pd-requires-scope: event_orchestrations.read + tags: + - Event Orchestrations + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.read` + summary: List Integrations for an Event Orchestration + operationId: listOrchestrationIntegrations + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/event_orchestration_id' + responses: + '200': + description: The Integrations for this Event Orchestration. + content: + application/json: + schema: + type: object + properties: + integrations: + type: array + items: + $ref: '#/components/schemas/OrchestrationIntegration' + total: + $ref: '#/components/schemas/Pagination/properties/total' + examples: + response: + summary: Response Example + value: + integrations: + - id: 9c5ff030-12da-4204-a067-25ee61a8df6c + label: Go-Kart Orchestration Default Integration + parameters: + routing_key: R022XIJR9M266DX570EVE6EXP1AFBN6D + type: global + - id: 11832872-88b6-4661-8972-db5712b69496 + label: Integration for Monitoring Tool X + parameters: + routing_key: R028DIE06SNKNO6V5ACSLRV7Y0TUVG7T + type: global + total: 2 + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '405': + $ref: '#/components/responses/NotAllowed' + post: + x-pd-requires-scope: event_orchestrations.write + tags: + - Event Orchestrations + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.write` + summary: Create an Integration for an Event Orchestration + operationId: postOrchestrationIntegration + requestBody: + content: + application/json: + schema: + type: object + properties: + integration: + type: object + properties: + label: + type: string + description: Name of the Integration. + required: + - label + required: + - integration + examples: + create_orchestration: + summary: 'Example: Create an Integration' + value: + integration: + label: Integration for Monitoring Tool X + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/event_orchestration_id' + responses: + '201': + description: The Integration that was created. + content: + application/json: + schema: + type: object + properties: + integration: + $ref: '#/components/schemas/OrchestrationIntegration' + examples: + response: + summary: Response Example + value: + integration: + id: 11832872-88b6-4661-8972-db5712b69496 + label: Integration for Monitoring Tool X + parameters: + routing_key: R028DIE06SNKNO6V5ACSLRV7Y0TUVG7T + type: global + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' + '/event_orchestrations/{id}/integrations/{integration_id}': + get: + x-pd-requires-scope: event_orchestrations.read + tags: + - Event Orchestrations + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.read` + summary: Get an Integration for an Event Orchestration + operationId: getOrchestrationIntegration + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/event_orchestration_id' + - $ref: '#/components/parameters/event_orchestration_integration_id' + responses: + '200': + description: An Integration for this Event Orchestration. + content: + application/json: + schema: + properties: + integration: + $ref: '#/components/schemas/OrchestrationIntegration' + type: object + examples: + response: + summary: Response Example + value: + integration: + id: 9c5ff030-12da-4204-a067-25ee61a8df6c + label: Go-Kart Orchestration Default Integration + parameters: + routing_key: R022XIJR9M266DX570EVE6EXP1AFBN6D + type: global + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '405': + $ref: '#/components/responses/NotAllowed' + put: + x-pd-requires-scope: event_orchestrations.write + tags: + - Event Orchestrations + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.write` + summary: Update an Integration for an Event Orchestration + operationId: updateOrchestrationIntegration + requestBody: + content: + application/json: + schema: + type: object + properties: + integration: + type: object + properties: + label: + type: string + description: Name of the Integration. + required: + - label + required: + - integration + examples: + create_orchestration: + summary: 'Example: Update an Integration' + value: + integration: + label: New Name for my Integration + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/event_orchestration_id' + - $ref: '#/components/parameters/event_orchestration_integration_id' + responses: + '200': + description: The Integration that was updated. + content: + application/json: + schema: + type: object + properties: + integration: + $ref: '#/components/schemas/OrchestrationIntegration' + examples: + response: + summary: Response Example + value: + integration: + id: 11832872-88b6-4661-8972-db5712b69496 + label: New Name for my Integration + parameters: + routing_key: R028DIE06SNKNO6V5ACSLRV7Y0TUVG7T + type: global + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' + delete: + x-pd-requires-scope: event_orchestrations.write + tags: + - Event Orchestrations + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.write` + summary: Delete an Integration for an Event Orchestration + operationId: deleteOrchestrationIntegration + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/event_orchestration_id' + - $ref: '#/components/parameters/event_orchestration_integration_id' + responses: + '204': + description: The Integration was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' + '/event_orchestrations/{id}/integrations/migration': + post: + x-pd-requires-scope: event_orchestrations.write + tags: + - Event Orchestrations + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.write` + summary: Migrate an Integration from one Event Orchestration to another + operationId: migrateOrchestrationIntegration + requestBody: + content: + application/json: + schema: + type: object + properties: + source_id: + type: string + description: The ID of the Event Orchestration you'll be moving the Integration away from + source_type: + type: string + description: The type of of the `source_id` object + enum: + - orchestration + integration_id: + type: string + description: The ID of the Integration you'll be moving + required: + - source_id + - source_type + - integration_id + examples: + migrate_integration: + summary: 'Example: Migrate an Integration' + value: + source_type: orchestration + source_id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + integration_id: 11832872-88b6-4661-8972-db5712b69496 + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/event_orchestration_id' + responses: + '200': + description: The Integration that was migrated + content: + application/json: + schema: + type: object + properties: + integrations: + type: array + items: + $ref: '#/components/schemas/OrchestrationIntegration' + total: + $ref: '#/components/schemas/Pagination/properties/total' + examples: + response: + summary: Response Example + value: + integrations: + - id: 9c5ff030-12da-4204-a067-25ee61a8df6c + label: Go-Kart Orchestration Default Integration + parameters: + routing_key: R022XIJR9M266DX570EVE6EXP1AFBN6D + type: global + - id: 11832872-88b6-4661-8972-db5712b69496 + label: Integration for Monitoring Tool X + parameters: + routing_key: R028DIE06SNKNO6V5ACSLRV7Y0TUVG7T + type: global + total: 2 + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' + '/event_orchestrations/{id}/global': + get: + x-pd-requires-scope: event_orchestrations.read + tags: + - Event Orchestrations + operationId: getOrchPathGlobal + summary: Get the Global Orchestration for an Event Orchestration + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.read` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/event_orchestration_id' + responses: + '200': + description: The Global Orchestration Rules object. + content: + application/json: + schema: + $ref: '#/components/schemas/OrchestrationGlobal' + examples: + response: + $ref: '#/components/examples/OrchestrationPathGlobalTypeResponse' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + put: + x-pd-requires-scope: event_orchestrations.write + tags: + - Event Orchestrations + operationId: updateOrchPathGlobal + summary: Update the Global Orchestration for an Event Orchestration + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/event_orchestration_id' + requestBody: + description: Update Global Orchestration rules. Omitted rules and rule details are deleted. + content: + application/json: + schema: + $ref: '#/components/schemas/OrchestrationGlobal' + examples: + request: + summary: Example Request + value: + orchestration_path: + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + responses: + '200': + description: The Global Orchestration Rules object. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/OrchestrationGlobal' + - type: object + properties: + warnings: + type: array + description: List of applicable warnings messages for each rule using a feature not available on your account plan. + items: + anyOf: + - $ref: '#/components/schemas/OrchestrationWarningIneligible' + examples: + response: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + warnings: + - feature: nested_rules + feature_type: nested_rules + message: 'This orchestration contains Nested Rules, which is not available on your account plan. The orchestration will be updated, however, only rules in the ''start'' set will be evaluated' + rule_id: null + warning_type: forbidden_feature + - feature: variables + feature_type: actions + message: 'This rule uses Dynamic Field Enrichment & Extraction, which is an action not available on your account plan. The rule will be updated, but the action will not be fired when the rule is evaluated' + rule_id: c91f72f3 + warning_type: forbidden_feature + - feature: extractions + feature_type: actions + message: 'This rule uses Dynamic Field Enrichment & Extraction, which is an action not available on your account plan. The rule will be updated, but the action will not be fired when the rule is evaluated' + rule_id: c91f72f3 + warning_type: forbidden_feature + - feature: recurring_condition + feature_type: conditions + message: 'This rule uses Recurring Condition, which is a condition not available on your account plan. The rule will be updated, but it will not be evaluated by events' + rule_id: cd770384 + warning_type: forbidden_feature + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' + '/event_orchestrations/{id}/router': + get: + x-pd-requires-scope: event_orchestrations.read + tags: + - Event Orchestrations + operationId: getOrchPathRouter + summary: Get the Router for an Event Orchestration + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.read` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/event_orchestration_id' + responses: + '200': + $ref: '#/components/responses/OrchestrationPathRouterTypeResponse' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + put: + x-pd-requires-scope: event_orchestrations.write + tags: + - Event Orchestrations + operationId: updateOrchPathRouter + summary: Update the Router for an Event Orchestration + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/event_orchestration_id' + requestBody: + description: Updates to Orchestration Router details. Omitted rules and rule details are deleted. + content: + application/json: + schema: + $ref: '#/components/schemas/OrchestrationRouter' + examples: + request: + summary: Example Request + value: + orchestration_path: + sets: + - id: start + rules: + - label: Events relating to our relational database + id: 1c26698b + conditions: + - expression: event.summary matches part 'database' + - expression: 'event.source matches regex ''db[0-9]+-server''' + actions: + route_to: PB31XBA + - label: Events relating to our www app server + id: d9801904 + conditions: + - expression: event.summary matches part 'www' + actions: + route_to: PC2D9ML + - label: Events relating to our delivery pipeline + id: ed624931 + conditions: + - expression: trigger_count over 1 minute > 3 + actions: + route_to: PQSJBMA + responses: + '200': + description: The Orchestration Router object. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/OrchestrationRouter' + - type: object + properties: + warnings: + type: array + description: List of applicable warnings messages for each rule using a feature not available on your account plan. + items: + anyOf: + - $ref: '#/components/schemas/OrchestrationWarningIneligible' + examples: + response: + summary: Example Response + value: + orchestration_path: + type: router + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/router' + sets: + - id: start + rules: + - label: Events relating to our relational database + id: 1c26698b + conditions: + - expression: event.summary matches part 'database' + - expression: 'event.source matches regex ''db[0-9]+-server''' + actions: + route_to: PB31XBA + - label: Events relating to our www app server + id: d9801904 + conditions: + - expression: event.summary matches part 'www' + actions: + route_to: PC2D9ML + - label: Events relating to our delivery pipeline + id: ed624931 + conditions: + - expression: trigger_count over 1 minute > 3 + actions: + route_to: PQSJBMA + catch_all: + actions: + route_to: unrouted + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: 9co0z4b152oICsoV91_PW2.ww8ip_xap + warnings: + - feature: threshold_condition + feature_type: conditions + message: 'This rule uses Threshold Condition, which is a condition not available on your account plan. The rule will be updated, but it will not be evaluated by events' + rule_id: ed624931 + warning_type: forbidden_feature + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' + '/event_orchestrations/{id}/unrouted': + get: + x-pd-requires-scope: event_orchestrations.read + tags: + - Event Orchestrations + operationId: getOrchPathUnrouted + summary: Get the Unrouted Orchestration for an Event Orchestration + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.read` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/event_orchestration_id' + responses: + '200': + $ref: '#/components/responses/OrchestrationPathUnroutedTypeResponse' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + put: + x-pd-requires-scope: event_orchestrations.write + tags: + - Event Orchestrations + operationId: updateOrchPathUnrouted + summary: Update the Unrouted Orchestration for an Event Orchestration + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `event_orchestrations.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/event_orchestration_id' + requestBody: + description: Updates to Unrouted Orchestration rules. Omitted rules and rule details are deleted. + content: + application/json: + schema: + $ref: '#/components/schemas/OrchestrationUnrouted' + examples: + request: + summary: Example Request + value: + orchestration_path: + sets: + - id: start + rules: + - label: Update the summary of un-matched Critical alerts so they're easier to spot + id: 38880ffb + conditions: + - expression: event.severity matches 'critical' + actions: + extractions: + - target: event.summary + template: '[Critical Unrouted] {{event.summary}}' + - label: Reduce the severity of all other unrouted events + id: 3896801e + conditions: [] + actions: + severity: info + catch_all: + actions: + suppress: true + responses: + '200': + description: The Unrouted Orchestration object. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/OrchestrationUnrouted' + - type: object + properties: + warnings: + type: array + description: List of applicable warnings messages for each rule using a feature not available on your account plan. + items: + anyOf: + - $ref: '#/components/schemas/OrchestrationWarningIneligible' + examples: + response: + summary: Example Response + value: + orchestration_path: + type: unrouted + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/router' + sets: + - id: start + rules: + - label: Update the summary of un-matched Critical alerts so they're easier to spot + id: 38880ffb + conditions: + - expression: event.severity matches 'critical' + actions: + extractions: + - target: event.summary + template: '[Critical Unrouted] {{event.summary}}' + - label: Reduce the severity of all other unrouted events + id: 3896801e + conditions: [] + actions: + severity: info + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: aZO.EEf9zWb9Vg0NYq.Uqad1hOC2Maod + warnings: + - feature: extractions + feature_type: actions + message: 'This rule uses Dynamic Field Enrichment & Extraction, which is an action not available on your account plan. The rule will be updated, but the action will not be fired when the rule is evaluated' + rule_id: 3896801e + warning_type: forbidden_feature + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' + '/event_orchestrations/services/{service_id}': + get: + x-pd-requires-scope: services.read + tags: + - Event Orchestrations + operationId: getOrchPathService + summary: Get the Service Orchestration for a Service + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `services.read` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/service_id' + responses: + '200': + $ref: '#/components/responses/OrchestrationPathServiceTypeResponse' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + put: + x-pd-requires-scope: services.write + tags: + - Event Orchestrations + operationId: updateOrchPathService + summary: Update the Service Orchestration for a Service + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `services.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/service_id' + requestBody: + description: Update Service Orchestration rules. Omitted rules and rule details are deleted. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceOrchestration' + examples: + request: + summary: Example Request + value: + orchestration_path: + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + pagerduty_automation_actions: + - action_id: 01CSB5SMOKCKVRI5GN0LJG7SMB + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + annotate: 'Please use our P1 runbook: https://docs.test/p1-runbook' + priority: P0IN2KQ + suppress: false + - label: If there's something wrong on the canary let the team know about it in our deployments Slack channel + id: 1f6d9a33 + conditions: + - expression: event.custom_details.hostname matches part 'canary' + actions: + automation_actions: + - name: Canary Slack Notification + url: 'https://our-slack-listerner.test/send-notification' + auto_send: true + headers: + - key: X-Notification-Source + value: PagerDuty Incident Webhook + parameters: + - key: channel + value: '#my-team-channel' + - key: message + value: Something is wrong with the canary deployment + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + responses: + '200': + description: The Service Orchestration object. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ServiceOrchestration' + - type: object + properties: + warnings: + type: array + description: List of applicable warnings messages for each rule using a feature not available on your account plan. + items: + anyOf: + - $ref: '#/components/schemas/OrchestrationWarningIneligible' + examples: + response: + summary: Example Response + value: + orchestration_path: + type: service + parent: + id: PC2D9ML + self: 'https://api.pagerduty.com/service/PC2D9ML' + type: service_reference + self: 'https://api.pagerduty.com/event_orchestrations/service/PC2D9ML' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + pagerduty_automation_actions: + - action_id: 01CSB5SMOKCKVRI5GN0LJG7SMB + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + annotate: 'Please use our P1 runbook: https://docs.test/p1-runbook' + priority: P0IN2KQ + suppress: false + - label: If there's something wrong on the canary let the team know about it in our deployments Slack channel + id: 1f6d9a33 + conditions: + - expression: event.custom_details.hostname matches part 'canary' + actions: + automation_actions: + - name: Canary Slack Notification + url: 'https://our-slack-listerner.test/send-notification' + auto_send: true + headers: + - key: X-Notification-Source + value: PagerDuty Incident Webhook + parameters: + - key: channel + value: '#my-team-channel' + - key: message + value: Something is wrong with the canary deployment + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + warnings: + - feature: nested_rules + feature_type: nested_rules + message: 'This orchestration contains Nested Rules, which is not available on your account plan. The orchestration will be updated, however, only rules in the ''start'' set will be evaluated' + rule_id: null + warning_type: forbidden_feature + - feature: variables + feature_type: actions + message: 'This rule uses Dynamic Field Enrichment & Extraction, which is an action not available on your account plan. The rule will be updated, but the action will not be fired when the rule is evaluated' + rule_id: c91f72f3 + warning_type: forbidden_feature + - feature: extractions + feature_type: actions + message: 'This rule uses Dynamic Field Enrichment & Extraction, which is an action not available on your account plan. The rule will be updated, but the action will not be fired when the rule is evaluated' + rule_id: c91f72f3 + warning_type: forbidden_feature + - feature: pagerduty_automation_actions + feature_type: actions + message: 'This rule uses PagerDuty Automation Actions, which is an action not available on your account plan. The rule will be updated, but the action will not be fired when the rule is evaluated' + rule_id: c91f72f3 + warning_type: forbidden_feature + - feature: automation_actions + feature_type: actions + message: 'This rule uses Automation Actions, which is an action not available on your account plan. The rule will be updated, but the action will not be fired when the rule is evaluated' + rule_id: 1f6d9a33 + warning_type: forbidden_feature + - feature: recurring_condition + feature_type: conditions + message: 'This rule uses Recurring Condition, which is a condition not available on your account plan. The rule will be updated, but it will not be evaluated by events' + rule_id: cd770384 + warning_type: forbidden_feature + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' + '/event_orchestrations/services/{service_id}/active': + get: + x-pd-requires-scope: services.read + tags: + - Event Orchestrations + operationId: getOrchActiveStatus + summary: Get the Service Orchestration active status for a Service + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `services.read` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/service_id' + responses: + '200': + $ref: '#/components/responses/OrchestrationPathServiceActiveResponse' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + put: + x-pd-requires-scope: services.write + tags: + - Event Orchestrations + operationId: updateOrchActiveStatus + summary: Update the Service Orchestration active status for a Service + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations) + + Scoped OAuth requires: `services.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/service_id' + requestBody: + description: Update Service Orchestration's active status. + content: + application/json: + schema: + $ref: '#/components/responses/OrchestrationPathServiceActiveResponse/content/application~1json/schema' + examples: + request: + summary: Example Request + value: + active: false + responses: + '200': + $ref: '#/components/responses/OrchestrationPathServiceActiveResponse' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/extension_schemas.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/extension_schemas.yaml new file mode 100644 index 0000000..717fe0e --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/extension_schemas.yaml @@ -0,0 +1,2745 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - extension_schemas + description: Extension_Schemas +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + ExtensionSchema: + type: object + properties: + icon_url: + type: string + format: url + readOnly: true + description: 'A small logo, 18-by-18 pixels.' + logo_url: + type: string + format: url + readOnly: true + description: 'A large logo, 75 pixels high and no more than 300 pixels wide.' + label: + type: string + readOnly: true + description: Human friendly display label + key: + type: string + readOnly: true + description: Machine friendly display label + description: + type: string + description: The long description for the Extension + guide_url: + type: string + format: url + readOnly: true + description: A link to the extension's support guide + send_types: + type: array + description: The types of PagerDuty incident events that will activate this Extension + uniqueItems: true + items: + type: string + enum: + - trigger + - acknowledge + - resolve + - delegate + - escalate + - unacknowledge + - assign + - custom + url: + type: string + readOnly: true + description: The url that the webhook payload will be sent to for this Extension. + example: + id: PJFWPEP + type: extension_schema + summary: Generic Webhook + self: 'https://api.pagerduty.com/extension_schemas/PJFWPEP' + html_url: 'null' + description: Long description here + guide_url: 'https://developer.pagerduty.com' + icon_url: 'https://extension.com/extension.png' + key: generic_webhook + label: Generic Webhook + logo_url: 'https://extension.com/logo.png' + send_types: + - trigger + - acknowledge + - resolve + - delegate + - escalate + - unacknowledge + - assign + - custom + url: 'https://developer.pagerduty.com/my_webhook_endpoint' + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + extension_schemas: + id: pagerduty.extension_schemas.extension_schemas + name: extension_schemas + title: Extension Schemas + methods: + list_extension_schemas: + operation: + $ref: '#/paths/~1extension_schemas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.extension_schemas + _list_extension_schemas: + operation: + $ref: '#/paths/~1extension_schemas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_extension_schema: + operation: + $ref: '#/paths/~1extension_schemas~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.extension_schema + _get_extension_schema: + operation: + $ref: '#/paths/~1extension_schemas~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/extension_schemas/methods/get_extension_schema' + - $ref: '#/components/x-stackQL-resources/extension_schemas/methods/list_extension_schemas' + insert: [] + update: [] + delete: [] +paths: + /extension_schemas: + get: + x-pd-requires-scope: extension_schemas.read + tags: + - Extension Schemas + operationId: listExtensionSchemas + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extension-schemas) + + Scoped OAuth requires: `extension_schemas.read` + summary: List extension schemas + parameters: + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + responses: + '200': + description: A paginated array of extension schemas. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + extension_schemas: + type: array + items: + $ref: '#/components/schemas/ExtensionSchema' + required: + - extension_schemas + examples: + response: + summary: Response Example + value: + extension_schemas: + - id: PJFWPEP + type: extension_schema + summary: Generic Webhook + self: 'https://api.pagerduty.com/extension_schemas/PJFWPEP' + description: Long description here + guide_url: 'https://developer.pagerduty.com' + icon_url: 'https://extension.com/extension.png' + key: generic_webhook + label: Generic Webhook + logo_url: 'https://extension.com/logo.png' + send_types: + - trigger + - acknowledge + - resolve + - delegate + - escalate + - unacknowledge + - assign + url: '' + limit: 25 + offset: 0 + more: false + total: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/extension_schemas/{id}': + get: + x-pd-requires-scope: extension_schemas.read + tags: + - Extension Schemas + operationId: getExtensionSchema + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extension-schemas) + + Scoped OAuth requires: `extension_schemas.read` + summary: Get an extension vendor + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: The extension vendor requested + content: + application/json: + schema: + type: object + properties: + extension_schema: + $ref: '#/components/schemas/ExtensionSchema' + required: + - extension_schema + examples: + response: + summary: Response Example + value: + extension_schema: + id: PJFWPEP + type: extension_schema + summary: Generic Webhook + self: 'https://api.pagerduty.com/extension_schemas/PJFWPEP' + description: Long description here + guide_url: 'https://developer.pagerduty.com' + icon_url: 'https://extension.com/extension.png' + key: generic_webhook + label: Generic Webhook + logo_url: 'https://extension.com/logo.png' + send_types: + - trigger + - acknowledge + - resolve + - delegate + - escalate + - unacknowledge + - assign + url: '' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/extensions.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/extensions.yaml new file mode 100644 index 0000000..b52698e --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/extensions.yaml @@ -0,0 +1,4238 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + Extension: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + name: + type: string + description: The name of the extension. + type: + type: string + description: The type of object being created. + default: extension + enum: + - extension + endpoint_url: + type: string + format: url + description: The url of the extension. + extension_objects: + type: array + description: The objects for which the extension applies + items: + $ref: '#/components/schemas/ServiceReference' + extension_schema: + $ref: '#/components/schemas/ExtensionSchemaReference' + temporarily_disabled: + type: boolean + readOnly: true + description: 'Whether or not this extension is temporarily disabled; for example, a webhook extension that is repeatedly rejected by the server.' + default: false + config: + type: object + description: The object that contains extension configuration values depending on the extension schema specification. + required: + - extension_objects + - extension_schema + - name + example: + id: PJU23I3 + endpoint_url: 'https://example.com/receive_a_pagerduty_webhook' + name: My Webhook + summary: My Webhook + type: extension + extension_schema: + id: PJFWPEP + type: extension_schema_reference + extension_objects: + - id: PIJ90N7 + type: service_reference + config: + anykey: anyvalue + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + ServiceReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - service_reference + ExtensionSchemaReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - extension_schema_reference + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + WebhookIncidentAction: + allOf: + - $ref: '#/components/schemas/Action' + - type: object + properties: + type: + type: string + description: | + The type of action being reported by this message. * `incident.trigger` - Sent when an incident is newly created/triggered. * `incident.acknowledge` - Sent when an incident is acknowledged by a user. * `incident.unacknowledge` - Sent when an incident is unacknowledged due to its acknowledgement timing out. * `incident.resolve` - Sent when an incident has been resolved. * `incident.assign` - Sent when an incident has been assigned to another user. Often occurs in concert with an `acknowledge`. * `incident.escalate` - Sent when an incident has been escalated to another user in the same escalation chain. * `incident.delegate` - Sent when an incident has been reassigned to another escalation policy. * `incident.annotate` - Sent when a note is created on an incident. + enum: + - incident.trigger + - incident.acknowledge + - incident.unacknowledge + - incident.resolve + - incident.assign + - incident.escalate + - incident.delegate + - incident.annotate + incident: + $ref: '#/components/schemas/Incident' + log_entries: + type: array + description: Log Entries that correspond to the action this Webhook is reporting. Includes the channels. + items: + oneOf: + - $ref: '#/components/schemas/AcknowledgeLogEntry' + - $ref: '#/components/schemas/AnnotateLogEntry' + - $ref: '#/components/schemas/AssignLogEntry' + - $ref: '#/components/schemas/DelegateLogEntry' + - $ref: '#/components/schemas/EscalateLogEntry' + - $ref: '#/components/schemas/ExhaustEscalationPathLogEntry' + - $ref: '#/components/schemas/NotifyLogEntry' + - $ref: '#/components/schemas/ReachAckLimitLogEntry' + - $ref: '#/components/schemas/ReachTriggerLimitLogEntry' + - $ref: '#/components/schemas/RepeatEscalationPathLogEntry' + - $ref: '#/components/schemas/ResolveLogEntry' + - $ref: '#/components/schemas/SnoozeLogEntry' + - $ref: '#/components/schemas/TriggerLogEntry' + - $ref: '#/components/schemas/UnacknowledgeLogEntry' + - $ref: '#/components/schemas/UrgencyChangeLogEntry' + example: + id: bb4fcb00-6324-11e6-b9aa-22000affca53 + type: incident.resolve + triggered_at: '2016-08-15T20:13:28Z' + log_entries: + - id: R0FFIOTKIU30MN7XWR99SI0 + type: resolve_log_entry + summary: Resolved by Earline Greenholt + self: 'https://api.pagerduty.com/log_entries/R0FFIOTKIU30MN7XWR99SI0' + html_url: null + created_at: '2017-09-22T18:37:29+00:00' + agent: + id: PLMUP47 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + channel: + type: slack + user: + id: U60DQ6ZXY + name: alisdair + team: + id: T029K7I8 + domain: subdomain + channel: + id: C6981DRAW + name: subdomain-ops + service: + id: PN49J75 + type: service_reference + summary: Cool Service + self: 'https://api.pagerduty.com/services/PNTDJ30' + html_url: 'https://subdomain.pagerduty.com/services/PNTDJ30' + incident: + id: PVO5OB2 + type: incident_reference + summary: The server is on fire. + self: 'https://api.pagerduty.com/incidents/PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + webhook: + type: webhook + summary: webhook + self: 'https://api.pagerduty.com/webhooks/PPGPXHO' + html_url: 'null' + name: My Webhook + endpoint_url: 'https://example.com' + webhook_object: + id: PNTDJ30 + type: service_reference + summary: Cool Service + self: 'null' + html_url: 'null' + config: + anykey: anyvalue + outbound_integration: + id: PJFWPEP + type: outbound_integration_reference + summary: Generic Webhook V2 + self: 'null' + html_url: 'null' + incident: + id: PT4KHLK + type: incident + summary: The server is on fire. + self: 'https://api.pagerduty.com/incidents/PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK' + incident_number: 1234 + created_at: '2015-10-06T21:30:42Z' + status: resolved + pending_actions: + - type: unacknowledge + at: '2015-11-10T01:02:52Z' + - type: resolve + at: '2015-11-10T04:31:52Z' + incident_key: baf7cf21b1da41b4b0221008339ff357 + service: + id: PIJ90N7 + type: service_reference + summary: My Application Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + name: My Application Service + description: 'null' + auto_resolve_timeout: 14400 + acknowledgement_timeout: 600 + created_at: '2015-11-06T11:12:51-05:00' + status: active + last_incident_timestamp: 'null' + integrations: + - id: PQ12345 + type: generic_email_inbound_integration_reference + summary: Email Integration + self: 'https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345' + escalation_policy: + id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + incident_urgency_rule: + type: use_support_hours + during_support_hours: + type: constant + urgency: high + outside_support_hours: + type: constant + urgency: low + support_hours: + type: fixed_time_per_day + time_zone: America/Lima + start_time: '09:00:00' + end_time: '17:00:00' + days_of_week: + - 1 + - 2 + - 3 + - 4 + - 5 + scheduled_actions: + - type: urgency_change + at: + type: named_time + name: support_hours_start + to_urgency: high + assignments: + - at: '2015-11-10T00:31:52Z' + assignee: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + acknowledgements: + - at: '2015-11-10T00:32:52Z' + acknowledger: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + last_status_change_at: '2015-10-06T21:38:23Z' + last_status_change_by: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + first_trigger_log_entry: + id: Q02JTSNZWHSEKV + type: trigger_log_entry_reference + summary: Triggered through the API + self: 'https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV' + escalation_policy: + id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + urgency: high + WebhooksV1Message: + type: object + description: A message containing information about a single PagerDuty action. + readOnly: true + properties: + id: + type: string + format: uuid + description: Uniquely identifies this outgoing webhook message; can be used for idempotency when processing the messages. + readOnly: true + type: + type: string + description: The type of action being reported by this message. + enum: + - incident.trigger + - incident.acknowledge + - incident.unacknowledge + - incident.resolve + - incident.assign + - incident.escalate + - incident.delegate + readOnly: true + created_on: + type: string + format: date-time + description: The date/time when the incident changed state. + readOnly: true + data: + type: object + properties: + incident: + $ref: '#/components/schemas/WebhooksV1IncidentData' + Action: + type: object + description: A message containing information about a single PagerDuty action. + readOnly: true + properties: + id: + type: string + format: uuid + description: Uniquely identifies this outgoing webhook message; can be used for idempotency when processing the messages. + readOnly: true + triggered_at: + type: string + format: date-time + description: The date/time when this message was was sent. + readOnly: true + webhook: + $ref: '#/components/schemas/Webhook' + Incident: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + incident_number: + type: integer + readOnly: true + description: The number of the incident. This is unique across your account. + created_at: + type: string + format: date-time + readOnly: true + description: The date/time the incident was first triggered. + status: + type: string + description: The current status of the incident. + enum: + - triggered + - acknowledged + - resolved + title: + type: string + readOnly: false + description: 'A succinct description of the nature, symptoms, cause, or effect of the incident.' + pending_actions: + type: array + readOnly: true + description: 'The list of pending_actions on the incident. A pending_action object contains a type of action which can be escalate, unacknowledge, resolve or urgency_change. A pending_action object contains at, the time at which the action will take place. An urgency_change pending_action will contain to, the urgency that the incident will change to.' + items: + $ref: '#/components/schemas/IncidentAction' + incident_key: + type: string + readOnly: true + description: The incident's de-duplication key. + service: + $ref: '#/components/schemas/ServiceReference' + assignments: + type: array + description: List of all assignments for this incident. This list will be empty if the `Incident.status` is `resolved`. + items: + $ref: '#/components/schemas/Assignment' + assigned_via: + type: string + description: How the current incident assignments were decided. Note that `direct_assignment` incidents will not escalate up the attached `escalation_policy` + enum: + - escalation_policy + - direct_assignment + readOnly: true + acknowledgements: + type: array + description: List of all acknowledgements for this incident. This list will be empty if the `Incident.status` is `resolved` or `triggered`. + items: + $ref: '#/components/schemas/Acknowledgement' + last_status_change_at: + type: string + format: date-time + readOnly: true + description: The time at which the status of the incident last changed. + last_status_change_by: + $ref: '#/components/schemas/AgentReference' + first_trigger_log_entry: + $ref: '#/components/schemas/LogEntryReference' + escalation_policy: + $ref: '#/components/schemas/EscalationPolicyReference' + teams: + type: array + description: The teams involved in the incident’s lifecycle. + items: + $ref: '#/components/schemas/TeamReference' + priority: + $ref: '#/components/schemas/PriorityReference' + urgency: + type: string + enum: + - high + - low + description: The current urgency of the incident. + resolve_reason: + $ref: '#/components/schemas/ResolveReason' + alert_counts: + $ref: '#/components/schemas/AlertCount' + conference_bridge: + $ref: '#/components/schemas/ConferenceBridge' + body: + $ref: '#/components/schemas/IncidentBody' + incidents_responders: + type: array + readOnly: true + items: + $ref: '#/components/schemas/IncidentsRespondersReference' + responder_requests: + type: array + readOnly: true + items: + $ref: '#/components/schemas/ResponderRequest' + AcknowledgeLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + acknowledgement_timeout: + type: integer + description: 'Duration for which the acknowledgement lasts, in seconds. Services can contain an `acknowledgement_timeout` property, which specifies the length of time acknowledgements should last for. Each time an incident is acknowledged, this timeout is copied into the acknowledgement log entry. This property is optional, as older log entries may not contain it. It may also be `null`, as acknowledgements can be performed on incidents whose services have no `acknowledgement_timeout` set.' + type: + type: string + enum: + - acknowledgement_log_entry + AnnotateLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - annotate_log_entry + AssignLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + assignees: + type: array + readOnly: true + description: An array of assigned Users for this log entry + items: + $ref: '#/components/schemas/UserReference' + type: + type: string + enum: + - assign_log_entry + DelegateLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + assignees: + type: array + readOnly: true + description: An array of assigned Users for this log entry + items: + $ref: '#/components/schemas/UserReference' + type: + type: string + enum: + - delegate_log_entry + EscalateLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + assignees: + type: array + readOnly: true + description: An array of assigned Users for this log entry + items: + $ref: '#/components/schemas/UserReference' + type: + type: string + enum: + - escalate_log_entry + ExhaustEscalationPathLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - exhaust_escalation_path_log_entry + NotifyLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + created_at: + type: string + format: date-time + readOnly: true + description: Time at which the log entry was created + user: + $ref: '#/components/schemas/UserReference' + type: + type: string + enum: + - notify_log_entry + ReachAckLimitLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - reach_ack_limit_log_entry + ReachTriggerLimitLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - reach_trigger_limit_log_entry + RepeatEscalationPathLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - repeat_escalation_path_log_entry + ResolveLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - resolve_log_entry + SnoozeLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + changed_actions: + type: array + items: + $ref: '#/components/schemas/IncidentAction' + type: + type: string + enum: + - snooze_log_entry + TriggerLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - trigger_log_entry + UnacknowledgeLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - unacknowledge_log_entry + UrgencyChangeLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - urgency_change_log_entry + WebhooksV1IncidentData: + type: object + description: The incident details at the time of the state change. + readOnly: true + properties: + id: + type: string + readOnly: true + incident_number: + type: integer + description: The number of the incident. This is unique across the account. + readOnly: true + created_on: + type: string + format: date-time + description: The date/time the incident was first triggered. + readOnly: true + status: + type: string + description: The current status of the incident. + enum: + - triggered + - acknowledged + - resolved + readOnly: true + html_url: + type: string + format: url + readOnly: true + incident_key: + type: string + description: The incident's de-duplication key. + readOnly: true + service: + $ref: '#/components/schemas/WebhooksV1Service' + assigned_to_user: + $ref: '#/components/schemas/WebhooksV1AssignedToUser' + assigned_to: + type: array + items: + $ref: '#/components/schemas/WebhooksV1AssignedTo' + readOnly: true + trigger_summary_data: + type: object + properties: + subject: + type: string + readOnly: true + readOnly: true + trigger_details_html_url: + type: string + format: url + readOnly: true + last_status_change_on: + type: string + format: date-time + readOnly: true + description: The time at which the status of the incident last changed. + last_status_change_by: + $ref: '#/components/schemas/WebhooksV1AssignedToUser' + number_of_escalations: + type: integer + minimum: 0 + description: Number of times the incident has been escalated. + readOnly: true + urgency: + type: string + enum: + - high + - low + readOnly: true + Webhook: + type: object + description: Information about the configured webhook. + readOnly: true + properties: + endpoint_url: + type: string + format: url + description: The url endpoint the webhook payload is sent to. + name: + type: string + description: The name of the webhook. + webhook_object: + $ref: '#/components/schemas/WebhookObject' + config: + type: object + description: The object that contains webhook configuration values depending on the webhook type specification. + outbound_integration: + $ref: '#/components/schemas/OutboundIntegrationReference' + example: + id: PPGPXHO + type: webhook + summary: webhook + name: My Webhook + endpoint_url: 'https://example.com' + webhook_object: + id: PNTDJ30 + type: service_reference + config: + anykey: anyvalue + outbound_integration: + id: PJFWPEP + type: outbound_integration_reference + IncidentAction: + description: An incident action is a pending change to an incident that will automatically happen at some future time. + type: object + properties: + type: + type: string + enum: + - unacknowledge + - escalate + - resolve + - urgency_change + at: + type: string + format: date-time + discriminator: + propertyName: type + required: + - type + - at + Assignment: + type: object + properties: + at: + type: string + format: date-time + description: Time at which the assignment was created. + assignee: + $ref: '#/components/schemas/UserReference' + required: + - at + - assignee + Acknowledgement: + type: object + properties: + at: + type: string + format: date-time + description: Time at which the acknowledgement was created. + acknowledger: + $ref: '#/components/schemas/AcknowledgerReference' + required: + - at + - acknowledger + AgentReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + description: 'The agent (user, service or integration) that created or modified the Incident Log Entry.' + properties: + type: + enum: + - user_reference + - service_reference + - integration_reference + type: string + readOnly: true + LogEntryReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - acknowledge_log_entry_reference + - annotate_log_entry_reference + - assign_log_entry_reference + - escalate_log_entry_reference + - exhaust_escalation_path_log_entry_reference + - notify_log_entry_reference + - reach_trigger_limit_log_entry_reference + - repeat_escalation_path_log_entry_reference + - resolve_log_entry_reference + - snooze_log_entry_reference + - trigger_log_entry_reference + - unacknowledge_log_entry_reference + EscalationPolicyReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - escalation_policy_reference + TeamReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - team_reference + PriorityReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - priority_reference + ResolveReason: + type: object + properties: + type: + type: string + description: The reason the incident was resolved. The only reason currently supported is merge. + default: merge_resolve_reason + enum: + - merge_resolve_reason + incident: + $ref: '#/components/schemas/IncidentReference' + AlertCount: + type: object + properties: + triggered: + type: integer + description: The count of triggered alerts + resolved: + type: integer + description: The count of resolved alerts + all: + type: integer + description: The total count of alerts + ConferenceBridge: + type: object + properties: + conference_number: + type: string + description: 'The phone number of the conference call for the conference bridge. Phone numbers should be formatted like +1 415-555-1212,,,,1234#, where a comma (,) represents a one-second wait and pound (#) completes access code input.' + conference_url: + type: string + format: url + description: An URL for the conference bridge. This could be a link to a web conference or Slack channel. + IncidentBody: + type: object + properties: + type: + type: string + enum: + - incident_body + details: + type: string + description: Additional incident details. + required: + - type + IncidentsRespondersReference: + type: object + properties: + state: + type: string + description: The status of the responder being added to the incident + example: pending + user: + $ref: '#/components/schemas/UserReference' + incident: + $ref: '#/components/schemas/IncidentReference' + updated_at: + type: string + message: + type: string + description: The message sent with the responder request + requester: + $ref: '#/components/schemas/UserReference' + requested_at: + type: string + ResponderRequest: + type: object + properties: + incident: + $ref: '#/components/schemas/IncidentReference' + requester: + $ref: '#/components/schemas/UserReference' + requested_at: + type: string + description: The time the request was made + message: + type: string + description: The message sent with the responder request + responder_request_targets: + type: array + description: The array of targets the responder request is being sent to + items: + $ref: '#/components/schemas/ResponderRequestTargetReference' + LogEntry: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + type: + type: string + enum: + - acknowledge_log_entry + - annotate_log_entry + - assign_log_entry + - delegate_log_entry + - escalate_log_entry + - exhaust_escalation_path_log_entry + - notify_log_entry + - reach_ack_limit_log_entry + - reach_trigger_limit_log_entry + - repeat_escalation_path_log_entry + - resolve_log_entry + - snooze_log_entry + - trigger_log_entry + - unacknowledge_log_entry + - urgency_change_log_entry + created_at: + type: string + format: date-time + readOnly: true + description: Time at which the log entry was created. + channel: + $ref: '#/components/schemas/Channel' + agent: + $ref: '#/components/schemas/AgentReference' + note: + type: string + readOnly: true + description: 'Optional field containing a note, if one was included with the log entry.' + contexts: + type: array + readOnly: true + description: Contexts to be included with the trigger such as links to graphs or images. + items: + $ref: '#/components/schemas/Context' + service: + $ref: '#/components/schemas/ServiceReference' + incident: + $ref: '#/components/schemas/IncidentReference' + teams: + type: array + readOnly: true + description: Will consist of references unless included + items: + $ref: '#/components/schemas/TeamReference' + event_details: + type: object + readOnly: true + properties: + description: + type: string + description: Additional details about the event. + UserReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - user_reference + WebhooksV1Service: + type: object + description: The service on which the incident occurred. + properties: + id: + type: string + readOnly: true + name: + type: string + description: The name of the service. + readOnly: true + html_url: + type: string + format: url + readOnly: true + deleted_at: + type: string + format: date-time + description: 'The date/time the service was deleted, if it has been removed.' + readOnly: true + description: + type: string + description: The description of the service. + readOnly: true + WebhooksV1AssignedToUser: + type: object + description: The user assigned to the incident. + readOnly: true + properties: + id: + type: string + readOnly: true + name: + type: string + description: The user's name. + readOnly: true + email: + type: string + format: email + description: The user's email address. + readOnly: true + html_url: + type: string + format: url + readOnly: true + WebhooksV1AssignedTo: + type: object + readOnly: true + properties: + at: + type: string + format: date-time + description: Time at which the assignment was created. + object: + allOf: + - $ref: '#/components/schemas/WebhooksV1AssignedToUser' + - properties: + type: + type: string + enum: + - user + WebhookObject: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + description: The webhook object (service) that the webhook belongs to. + properties: + type: + type: string + enum: + - service + - service_reference + OutboundIntegrationReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - outbound_integration_reference + AcknowledgerReference: + allOf: + - $ref: '#/components/schemas/Reference' + - description: The acknowledger represents the entity that made the acknowledgement for an incident. + type: object + properties: + type: + enum: + - user_reference + - service_reference + type: string + IncidentReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - incident_reference + ResponderRequestTargetReference: + type: object + properties: + type: + type: string + description: The type of target (either a user or an escalation policy) + id: + type: string + description: The id of the user or escalation policy + summary: + type: string + incident_responders: + type: array + description: An array of responders associated with the specified incident + items: + $ref: '#/components/schemas/IncidentsRespondersReference' + Channel: + type: object + description: 'Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats.' + properties: + type: + type: string + description: type + user: + type: object + team: + type: object + notification: + $ref: '#/components/schemas/Notification' + channel: + type: object + description: channel + required: + - type + Context: + type: object + discriminator: + propertyName: type + properties: + type: + type: string + description: The type of context being attached to the incident. + enum: + - link + - image + href: + type: string + description: The link's target url + src: + type: string + description: The image's source url + text: + type: string + description: The alternate display for an image + required: + - type + Notification: + type: object + properties: + id: + type: string + readOnly: true + type: + type: string + description: The type of notification. + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + readOnly: true + started_at: + type: string + format: date-time + description: The time at which the notification was sent + readOnly: true + address: + type: string + description: The address where the notification was sent. This will be null for notification type `push_notification`. + readOnly: true + user: + $ref: '#/components/schemas/UserReference' + conferenceAddress: + type: string + description: The address of the conference bridge + status: + type: string + '': + type: string + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + PaymentRequired: + description: | + Account does not have the abilities to perform the action. Please review the response for the required abilities. + You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + extensions: + id: pagerduty.extensions.extensions + name: extensions + title: Extensions + methods: + list_extensions: + operation: + $ref: '#/paths/~1extensions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.extensions + _list_extensions: + operation: + $ref: '#/paths/~1extensions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_extension: + operation: + $ref: '#/paths/~1extensions/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_extension: + operation: + $ref: '#/paths/~1extensions~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.extension + _get_extension: + operation: + $ref: '#/paths/~1extensions~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_extension: + operation: + $ref: '#/paths/~1extensions~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_extension: + operation: + $ref: '#/paths/~1extensions~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + enable_extension: + operation: + $ref: '#/paths/~1extensions~1{id}~1enable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/extensions/methods/get_extension' + - $ref: '#/components/x-stackQL-resources/extensions/methods/list_extensions' + insert: + - $ref: '#/components/x-stackQL-resources/extensions/methods/create_extension' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/extensions/methods/delete_extension' +paths: + /extensions: + get: + tags: + - Extensions + x-pd-requires-scope: extensions.read + operationId: listExtensions + description: | + List existing extensions. + + Extensions are representations of Extension Schema objects that are attached to Services. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions) + + Scoped OAuth requires: `extensions.read` + summary: List extensions + parameters: + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/extension_object_id' + - $ref: '#/components/parameters/extension_schema_id' + - $ref: '#/components/parameters/include_extensions' + responses: + '200': + description: A paginated array of extensions. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + extensions: + type: array + items: + $ref: '#/components/schemas/Extension' + required: + - extensions + examples: + response: + summary: Response Example + value: + extensions: + - id: PPGPXHO + self: 'https://api.pagerduty.com/extensions/PPGPXHO' + endpoint_url: 'https://example.com/receive_a_pagerduty_webhook' + name: My Webhook + summary: My Webhook + type: extension + extension_schema: + id: PJFWPEP + type: extension_schema_reference + summary: Generic Webhook + self: 'https://api.pagerduty.com/extension_schemas/PJFWPEP' + extension_objects: + - id: PIJ90N7 + type: service_reference + summary: My Application Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + limit: 25 + offset: 0 + more: false + total: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + post: + tags: + - Extensions + x-pd-requires-scope: extensions.write + operationId: createExtension + description: | + Create a new Extension. + + Extensions are representations of Extension Schema objects that are attached to Services. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions) + + Scoped OAuth requires: `extensions.write` + summary: Create an extension + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + requestBody: + content: + application/json: + schema: + type: object + properties: + extension: + $ref: '#/components/schemas/Extension' + required: + - extension + examples: + request: + summary: Request Example + value: + extension: + endpoint_url: 'https://example.com/receive_a_pagerduty_webhook' + name: My Webhook + extension_schema: + id: PJFWPEP + type: extension_schema_reference + extension_objects: + - id: PIJ90N7 + type: service_reference + requestCustomHeaders: + summary: Request Example with Custom Headers + value: + extension: + endpoint_url: 'https://example.com/receive_a_pagerduty_webhook' + name: My Webhook + extension_schema: + id: PJFWPEP + type: extension_schema_reference + extension_objects: + - id: PIJ90N7 + type: service_reference + config: + headers: + - name: Authorization + value: Token token=super_secret_token_value + description: The extension to be created + responses: + '201': + description: The extension that was created + content: + application/json: + schema: + type: object + properties: + extension: + $ref: '#/components/schemas/Extension' + required: + - extension + examples: + response: + summary: Response Example + value: + extension: + id: PPGPXHO + self: 'https://api.pagerduty.com/extensions/PPGPXHO' + endpoint_url: 'https://example.com/receive_a_pagerduty_webhook' + name: My Webhook + summary: My Webhook + type: extension + extension_schema: + id: PJFWPEP + type: extension_schema_reference + summary: Generic Webhook + self: 'https://api.pagerduty.com/extension_schemas/PJFWPEP' + extension_objects: + - id: PIJ90N7 + type: service_reference + summary: My Application Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + callbacks: + webhookV2: + endpoint_url: + post: + parameters: [] + tags: + - Webhooks V2 + operationId: webhookV2 + description: Receive webhook indicating incident state has changed. + summary: Receive webhook + security: [] + responses: + '200': + description: Your server implementation should return this if it successfuly received the webhook. + requestBody: + description: Webhook. + content: + application/json: + schema: + type: object + properties: + messages: + type: array + description: An array of webhook messages. + items: + $ref: '#/components/schemas/WebhookIncidentAction' + webhookV1: + endpoint_url: + post: + parameters: [] + tags: + - Webhooks V1 + operationId: webhookV1 + description: Receive webhook indicating incident state has changed. + summary: Receive webhook + security: [] + responses: + '200': + description: Your server implementation should return this if it successfuly received the webhook. + requestBody: + description: Webhook. + content: + application/json: + schema: + $ref: '#/components/schemas/WebhooksV1Message' + '/extensions/{id}': + get: + tags: + - Extensions + x-pd-requires-scope: extensions.read + operationId: getExtension + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions) + + Scoped OAuth requires: `extensions.read` + summary: Get an extension + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/include_extensions_id' + responses: + '200': + description: The extension that was requested. + content: + application/json: + schema: + type: object + properties: + extension: + $ref: '#/components/schemas/Extension' + required: + - extension + examples: + response: + summary: Response Example + value: + extension: + id: PPGPXHO + self: 'https://api.pagerduty.com/extensions/PPGPXHO' + endpoint_url: 'https://example.com/receive_a_pagerduty_webhook' + name: My Webhook + summary: My Webhook + type: extension + extension_schema: + id: PJFWPEP + type: extension_schema_reference + summary: Generic Webhook + self: 'https://api.pagerduty.com/extension_schemas/PJFWPEP' + extension_objects: + - id: PIJ90N7 + type: service_reference + summary: My Application Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + temporarily_disabled: false + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + delete: + tags: + - Extensions + x-pd-requires-scope: extensions.write + operationId: deleteExtension + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions) + + Scoped OAuth requires: `extensions.write` + summary: Delete an extension + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '204': + description: The extension was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + put: + tags: + - Extensions + x-pd-requires-scope: extensions.write + operationId: updateExtension + description: | + Update an existing extension. + + Extensions are representations of Extension Schema objects that are attached to Services. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions) + + Scoped OAuth requires: `extensions.write` + summary: Update an extension + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + extension: + $ref: '#/components/schemas/Extension' + required: + - extension + examples: + request: + summary: Request Example + value: + extension: + endpoint_url: 'https://example.com/receive_a_pagerduty_webhook' + name: My Webhook + extension_schema: + id: PJFWPEP + type: extension_schema_reference + extension_objects: + - id: PIJ90N7 + type: service_reference + requestCustomHeaders: + summary: Request Example with Custom Headers + value: + extension: + endpoint_url: 'https://example.com/receive_a_pagerduty_webhook' + name: My Webhook + extension_schema: + id: PJFWPEP + type: extension_schema_reference + extension_objects: + - id: PIJ90N7 + type: service_reference + config: + headers: + - name: Authorization + value: Token token=super_secret_token_value + description: The extension to be updated. + responses: + '200': + description: The extension that was updated. + content: + application/json: + schema: + type: object + properties: + extension: + $ref: '#/components/schemas/Extension' + required: + - extension + examples: + response: + summary: Response Example + value: + extension: + id: PPGPXHO + self: 'https://api.pagerduty.com/extensions/PPGPXHO' + endpoint_url: 'https://example.com/receive_a_pagerduty_webhook' + name: My Webhook + summary: My Webhook + type: extension + extension_schema: + id: PJFWPEP + type: extension_schema_reference + summary: Generic Webhook + self: 'https://api.pagerduty.com/extension_schemas/PJFWPEP' + extension_objects: + - id: PIJ90N7 + type: service_reference + summary: My Application Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '/extensions/{id}/enable': + post: + tags: + - Extensions + x-pd-requires-scope: extensions.write + operationId: enableExtension + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions) + + Scoped OAuth requires: `extensions.write` + summary: Enable an extension + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: The extension that was successfully enabled. + content: + application/json: + schema: + type: object + properties: + extension: + $ref: '#/components/schemas/Extension' + required: + - extension + examples: + response: + summary: Response Example + value: + extension: + id: PPGPXHO + self: 'https://api.pagerduty.com/extensions/PPGPXHO' + endpoint_url: 'https://example.com/receive_a_pagerduty_webhook' + name: My Webhook + summary: My Webhook + type: extension + extension_schema: + id: PJFWPEP + type: extension_schema_reference + summary: Generic Webhook + self: 'https://api.pagerduty.com/extension_schemas/PJFWPEP' + extension_objects: + - id: PIJ90N7 + type: service_reference + summary: My Application Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/incident_workflows.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/incident_workflows.yaml new file mode 100644 index 0000000..51795e4 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/incident_workflows.yaml @@ -0,0 +1,4214 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - incident_workflows + description: Incident_Workflows +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + IncidentWorkflow: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + type: + type: string + enum: + - incident_workflow + name: + type: string + description: A descriptive name for the Incident Workflow + description: + type: string + description: A description of what the Incident Workflow does + created_at: + type: string + format: date-time + description: The timestamp this Incident Workflow was created + readOnly: true + team: + type: object + readOnly: false + description: If specified then workflow edit permissions will be scoped to members of this team + properties: + type: + type: string + description: Type of the referenced object + readOnly: true + enum: + - team_reference + id: + type: string + description: Unique identifier for the resource + readOnly: true + steps: + type: array + description: The ordered list of steps that execute sequentially as part of the workflow + items: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + type: + type: string + enum: + - step + name: + type: string + description: A descriptive name for the Step + description: + type: string + readOnly: true + description: A description of the action performed by the Step + action_configuration: + description: Configuration of automated action executed by this Step + type: object + properties: + action_id: + type: string + description: The identifier of the Action to execute + description: + type: string + description: Description of the Action + readOnly: true + inputs: + type: array + items: + type: object + properties: + name: + type: string + description: The name of the Input + parameter_type: + type: string + description: The data type of this Input + readOnly: true + value: + type: string + description: The configured value of the Input + required: + - name + - value + outputs: + type: array + readOnly: true + items: + type: object + properties: + name: + type: string + description: The name of the Output + readOnly: true + reference_name: + type: string + description: The reference name of the Output + readOnly: true + parameter_type: + type: string + description: The data type produced by this Output + readOnly: true + required: + - name + - value + required: + - action_id + - inputs + required: + - name + - action_configuration + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + IncidentWorkflowInstance: + type: object + properties: + id: + type: string + readOnly: true + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + enum: + - incident_workflow_instance + incident: + $ref: '#/components/schemas/Reference' + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + CursorPagination: + type: object + properties: + limit: + type: integer + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + readOnly: true + next_cursor: + type: string + description: | + An opaque string than will deliver the next set of results when provided as the `cursor` parameter in a subsequent request. A `null` value for this field indicates that there are no additional results. + example: dXNlcjaVMzc5V0ZYTlo= + nullable: true + readOnly: true + required: + - limit + - next_cursor + IncidentWorkflowAction: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + type: + type: string + enum: + - action + domain_name: + type: string + description: The Verified Domain of the account that created the action + package_name: + type: string + description: The Package Name corresponding to the broad category of the Action + function_name: + type: string + description: The Function Name describing the specific functionality of the Action + version: + type: number + description: The version of the Action + name: + type: string + description: The descriptive name of the Action + description: + type: string + description: A description of the Action + action_type: + type: string + description: The type of Action + enum: + - action + - trigger + trigger_type: + type: string + description: 'The type of Trigger this Action is, if action_type is trigger' + enum: + - polling + - subscription + - web + tags: + type: array + description: A set of tags to apply to this action. + items: + type: string + search_keywords: + type: array + description: A set of search keywords to apply to this action. + items: + type: string + metadata: + type: string + description: JSON-formatted string of metadata pertaining to the Action + created_at: + type: string + format: date-time + description: The date-time at which this Action was created + created_by_user_id: + type: string + description: The obfuscated Id of the User who created this Action + inputs: + type: array + description: Inputs whose values used during Action execution + items: + type: object + properties: + name: + type: string + description: The name of the Input + description: + type: string + description: Describes what the purpose of the Input + type: + type: string + description: The data type of this Input + enum: + - text + - password + - integer + - decimal + - date + - dateTime + - boolean + - singleChoice + - multipleChoice + - json + - connection + - trigger + default_value: + type: string + description: Serialized form of the default value that the input will take + is_required: + type: boolean + description: Whether a value must be provided for this input + is_hidden: + type: boolean + description: If true then this input will not be shown to users when configuring this action + advanced: + type: boolean + metadata: + type: string + connection_type_id: + type: string + description: The configured value of the Input + outputs: + type: array + description: Outputs whose values set during Action execution + readOnly: true + items: + type: object + properties: + name: + type: string + description: The name of the Output + description: + type: string + type: + type: string + description: The data type produced by this Output + enum: + - text + - password + - integer + - decimal + - date + - dateTime + - boolean + - singleChoice + - multipleChoice + - json + IncidentWorkflowTrigger: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + type: + type: string + enum: + - workflow_trigger + trigger_type_name: + type: string + readOnly: true + description: Human readable name for the trigger type + trigger_type: + type: string + enum: + - conditional + - manual + condition: + type: string + description: | + A PCL condition string. + + If specified, the trigger will execute when the condition is met on an incident. + + If unspecified, the trigger will execute on incident creation. + + Required if trigger_type is “conditional”, not allowed if trigger_type is “manual”. + trigger_url: + type: string + format: url + readOnly: true + workflow: + type: object + description: Workflow to start when this trigger is invoked + properties: + id: + type: string + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + enum: + - workflow_reference + name: + type: string + readOnly: true + description: A descriptive name for the Incident Workflow + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + services: + type: array + description: An optional array of Services associated with this workflow. Incidents in any of the listed Services are eligible to fire this Trigger + items: + type: object + properties: + id: + type: string + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + enum: + - service + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + is_subscribed_to_all_services: + type: boolean + description: Indicates that the Trigger should be associated with All Services + permissions: + description: An object detailing who can start this Trigger. Applicable only to manual Triggers. + type: object + properties: + restricted: + type: boolean + description: 'If true, indicates that the Trigger can only be started by authorized Users. If false, any user can start this Trigger. Applicable only to manual Triggers.' + team_id: + type: string + description: The ID of the team whose members can manually start this Trigger. Required and allowed if and only if permissions.restricted is true. + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + PaymentRequired: + description: | + Account does not have the abilities to perform the action. Please review the response for the required abilities. + You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + incident_workflows: + id: pagerduty.incident_workflows.incident_workflows + name: incident_workflows + title: Incident Workflows + methods: + list_incident_workflows: + operation: + $ref: '#/paths/~1incident_workflows/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.incident_workflows + _list_incident_workflows: + operation: + $ref: '#/paths/~1incident_workflows/get' + response: + mediaType: application/json + openAPIDocKey: '200' + post_incident_workflow: + operation: + $ref: '#/paths/~1incident_workflows/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_incident_workflow: + operation: + $ref: '#/paths/~1incident_workflows~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '201' + objectKey: $.incident_workflow + _get_incident_workflow: + operation: + $ref: '#/paths/~1incident_workflows~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '201' + delete_incident_workflow: + operation: + $ref: '#/paths/~1incident_workflows~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + put_incident_workflow: + operation: + $ref: '#/paths/~1incident_workflows~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '201' + create_incident_workflow_instance: + operation: + $ref: '#/paths/~1incident_workflows~1{id}~1instances/post' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/incident_workflows/methods/get_incident_workflow' + - $ref: '#/components/x-stackQL-resources/incident_workflows/methods/list_incident_workflows' + insert: + - $ref: '#/components/x-stackQL-resources/incident_workflows/methods/create_incident_workflow_instance' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/incident_workflows/methods/delete_incident_workflow' + actions: + id: pagerduty.incident_workflows.actions + name: actions + title: Actions + methods: + list_incident_workflow_actions: + operation: + $ref: '#/paths/~1incident_workflows~1actions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.actions + _list_incident_workflow_actions: + operation: + $ref: '#/paths/~1incident_workflows~1actions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_incident_workflow_action: + operation: + $ref: '#/paths/~1incident_workflows~1actions~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.action + _get_incident_workflow_action: + operation: + $ref: '#/paths/~1incident_workflows~1actions~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/actions/methods/get_incident_workflow_action' + - $ref: '#/components/x-stackQL-resources/actions/methods/list_incident_workflow_actions' + insert: [] + update: [] + delete: [] + triggers: + id: pagerduty.incident_workflows.triggers + name: triggers + title: Triggers + methods: + list_incident_workflow_triggers: + operation: + $ref: '#/paths/~1incident_workflows~1triggers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.triggers + _list_incident_workflow_triggers: + operation: + $ref: '#/paths/~1incident_workflows~1triggers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_incident_workflow_trigger: + operation: + $ref: '#/paths/~1incident_workflows~1triggers/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_incident_workflow_trigger: + operation: + $ref: '#/paths/~1incident_workflows~1triggers~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.trigger + _get_incident_workflow_trigger: + operation: + $ref: '#/paths/~1incident_workflows~1triggers~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_incident_workflow_trigger: + operation: + $ref: '#/paths/~1incident_workflows~1triggers~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_incident_workflow_trigger: + operation: + $ref: '#/paths/~1incident_workflows~1triggers~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + associate_service_to_incident_workflow_trigger: + operation: + $ref: '#/paths/~1incident_workflows~1triggers~1{id}~1services/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete_service_from_incident_workflow_trigger: + operation: + $ref: '#/paths/~1incident_workflows~1triggers~1{trigger_id}~1services~1{service_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/triggers/methods/get_incident_workflow_trigger' + - $ref: '#/components/x-stackQL-resources/triggers/methods/list_incident_workflow_triggers' + insert: + - $ref: '#/components/x-stackQL-resources/triggers/methods/create_incident_workflow_trigger' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/triggers/methods/delete_service_from_incident_workflow_trigger' + - $ref: '#/components/x-stackQL-resources/triggers/methods/delete_incident_workflow_trigger' +paths: + /incident_workflows: + get: + x-pd-requires-scope: incident_workflows.read + tags: + - Incident Workflows + operationId: listIncidentWorkflows + description: | + 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 "listIncidentWorkflowsByService" endpoint. + + 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` + summary: List Incident Workflows + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/include_incident_workflow_children' + responses: + '200': + description: A paginated array of Incident Workflows. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + incident_workflows: + type: array + items: + $ref: '#/components/schemas/IncidentWorkflow' + required: + - incident_workflows + examples: + response: + summary: Response Example + value: + incident_workflows: + - id: PSFEVL7 + name: Example Incident Workflow + description: This Incident Workflow is an example + type: incident_workflow + created_at: '2022-12-13T19:55:01.171Z' + self: 'https://api.pagerduty.com/incident_workflows/PSFEVL7' + html_url: 'https://pdt-flex-actions.pagerduty.com/flex-workflows/workflows/PSFEVL7' + limit: 1 + offset: 0 + more: true + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + x-pd-requires-scope: incident_workflows.write + tags: + - Incident Workflows + operationId: postIncidentWorkflow + description: | + 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` + summary: Create an Incident Workflow + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + requestBody: + content: + application/json: + schema: + type: object + properties: + incident_workflow: + $ref: '#/components/schemas/IncidentWorkflow' + required: + - incident_workflow + examples: + request: + summary: Request Example + value: + incident_workflow: + name: Example Incident Workflow + description: This Incident Workflow is an example + steps: + - name: Send Status Update + action_configuration: + action_id: 'pagerduty.com:incident-workflows:send-status-update:1' + inputs: + - name: Message + value: 'Example status message sent on {{current_date}}' + responses: + '201': + description: The new Incident Workflow + content: + application/json: + schema: + type: object + properties: + incident_workflow: + $ref: '#/components/schemas/IncidentWorkflow' + required: + - incident_workflow + examples: + response: + summary: Response Example + value: + incident_workflow: + id: PSFEVL7 + name: Example Incident Workflow + description: This Incident Workflow is an example + type: incident_workflow + created_at: '2022-12-13T19:55:01.171Z' + self: 'https://api.pagerduty.com/incident_workflows/PSFEVL7' + html_url: 'https://pdt-flex-actions.pagerduty.com/flex-workflows/workflows/PSFEVL7' + steps: + - id: P4RG7YW + type: step + name: Send Status Update + description: Posts a status update to a given incident + action_configuration: + action_id: 'pagerduty.com:incident-workflows:send-status-update:1' + description: Posts a status update to a given incident + inputs: + - name: Message + parameter_type: text + value: 'Example status message sent on {{current_date}}' + outputs: + - name: Result + reference_name: result + parameter_type: text + - name: Result Summary + reference_name: result-summary + parameter_type: text + - name: Error + reference_name: error + parameter_type: text + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/incident_workflows/{id}': + get: + x-pd-requires-scope: incident_workflows.read + tags: + - Incident Workflows + operationId: getIncidentWorkflow + description: | + 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` + summary: Get an Incident Workflow + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '201': + description: The Incident Workflow + content: + application/json: + schema: + type: object + properties: + incident_workflow: + $ref: '#/components/schemas/IncidentWorkflow' + required: + - incident_workflow + examples: + response: + summary: Response Example + value: + incident_workflow: + id: PSFEVL7 + name: Example Incident Workflow + description: This Incident Workflow is an example + type: incident_workflow + created_at: '2022-12-13T19:55:01.171Z' + self: 'https://api.pagerduty.com/incident_workflows/PSFEVL7' + html_url: 'https://pdt-flex-actions.pagerduty.com/flex-workflows/workflows/PSFEVL7' + steps: + - id: P4RG7YW + type: step + name: Send Status Update + description: Posts a status update to a given incident + action_configuration: + action_id: 'pagerduty.com:incident-workflows:send-status-update:1' + description: Posts a status update to a given incident + inputs: + - name: Message + parameter_type: text + value: 'Example status message sent on {{current_date}}' + outputs: + - name: Result + reference_name: result + parameter_type: text + - name: Result Summary + reference_name: result-summary + parameter_type: text + - name: Error + reference_name: error + parameter_type: text + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + delete: + x-pd-requires-scope: incident_workflows.write + tags: + - Incident Workflows + operationId: deleteIncidentWorkflow + description: | + 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` + summary: Delete an Incident Workflow + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: The Incident Workflow was deleted successfully + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + x-pd-requires-scope: incident_workflows.write + tags: + - Incident Workflows + operationId: putIncidentWorkflow + description: | + 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` + summary: Update an Incident Workflow + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + incident_workflow: + $ref: '#/components/schemas/IncidentWorkflow' + required: + - incident_workflow + examples: + request: + summary: Request Example + value: + incident_workflow: + name: Example Incident Workflow + description: This Incident Workflow is an example + steps: + - name: Send Status Update + action_configuration: + action_id: 'pagerduty.com:incident-workflows:send-status-update:1' + inputs: + - name: Message + value: 'Example status message sent on {{current_date}}' + responses: + '201': + description: The new Incident Workflow + content: + application/json: + schema: + type: object + properties: + incident_workflow: + $ref: '#/components/schemas/IncidentWorkflow' + required: + - incident_workflow + examples: + response: + summary: Response Example + value: + incident_workflow: + id: PSFEVL7 + name: Example Incident Workflow + description: This Incident Workflow is an example + type: incident_workflow + created_at: '2022-12-13T19:55:01.171Z' + self: 'https://api.pagerduty.com/incident_workflows/PSFEVL7' + html_url: 'https://pdt-flex-actions.pagerduty.com/flex-workflows/workflows/PSFEVL7' + steps: + - id: P4RG7YW + type: step + name: Send Status Update + description: Posts a status update to a given incident + action_configuration: + action_id: 'pagerduty.com:incident-workflows:send-status-update:1' + description: Posts a status update to a given incident + inputs: + - name: Message + parameter_type: text + value: 'Example status message sent on {{current_date}}' + outputs: + - name: Result + reference_name: result + parameter_type: text + - name: Result Summary + reference_name: result-summary + parameter_type: text + - name: Error + reference_name: error + parameter_type: text + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/incident_workflows/{id}/instances': + post: + x-pd-requires-scope: 'incident_workflows:instances.write' + tags: + - Incident Workflows + operationId: createIncidentWorkflowInstance + description: | + Start an Instance of 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:instances.write` + summary: Start an Incident Workflow Instance + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + incident_workflow_instance: + type: object + properties: + incident: + type: object + properties: + type: + type: string + enum: + - incident_reference + required: + - id + required: + - incident_workflow_instance + examples: + request: + summary: Request Example + value: + incident_workflow_instance: + id: P3SNKQS + type: incident_workflow_instance + incident: + id: Q1R2DLCB21K7NP + type: incident_reference + responses: + '201': + description: The Incident Workflow Instance + content: + application/json: + schema: + type: object + properties: + incident_workflow_instance: + $ref: '#/components/schemas/IncidentWorkflowInstance' + required: + - incident_workflow_instance + examples: + response: + summary: Response Example + value: + incident_workflow_instance: + id: P3SNKQS + type: incident_workflow_instance + incident: + id: Q1R2DLCB21K7NP + type: incident_reference + summary: '[#1234] The server is on fire.' + self: 'https://api.pagerduty.com/incidents/PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + /incident_workflows/actions: + get: + x-pd-requires-scope: incident_workflows.read + tags: + - Incident Workflows + operationId: listIncidentWorkflowActions + description: | + List Incident Workflow Actions + + Scoped OAuth requires: `incident_workflows.read` + summary: List Actions + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/cursor_limit' + - $ref: '#/components/parameters/cursor_cursor' + - $ref: '#/components/parameters/actions_filter_keyword' + responses: + '200': + description: A paginated array of Incident Workflow Actions + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/CursorPagination' + - type: object + properties: + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + actions: + type: array + items: + $ref: '#/components/schemas/IncidentWorkflowAction' + examples: + response: + summary: Response Example + value: + actions: + - type: action + id: 'pagerduty.com:test:sample-action:1' + domain_name: pagerduty.com + package_name: test + function_name: sample-action + version: 1 + name: 'Test: Sample Action' + description: A fake Action for documentation purposes + action_type: integration + tags: [] + metadata: '{}' + search_keywords: [] + inputs: + - name: Text Input + description: A text input + type: text + default_value: some text + is_required: true + is_hidden: false + advanced: false + metadata: '{}' + connection_type_id: '' + - name: Int Input + description: An integer input + type: integer + default_value: '1234' + is_required: false + is_hidden: false + advanced: false + metadata: '{}' + connection_type_id: '' + outputs: + - name: Text Output + description: A text output + type: text + created_at: '2022-12-08T22:14:16.965Z' + created_by_user_id: PNBURS9 + limit: 1 + next_cursor: N2E3YzkzNjMtYzBkMC00NjFmLTg1OTEtMGZjMjcwODUzODNl + more: true + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/incident_workflows/actions/{id}': + get: + x-pd-requires-scope: incident_workflows.read + tags: + - Incident Workflows + operationId: getIncidentWorkflowAction + description: | + Get an Incident Workflow Action + + Scoped OAuth requires: `incident_workflows.read` + summary: Get an Action + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: An Incident Workflow Action + content: + application/json: + schema: + type: object + properties: + action: + $ref: '#/components/schemas/IncidentWorkflowAction' + examples: + response: + summary: Response Example + value: + action: + type: action + id: 'pagerduty.com:test:sample-action:1' + domain_name: pagerduty.com + package_name: test + function_name: sample-action + version: 1 + name: 'Test: Sample Action' + description: A fake Action for documentation purposes + action_type: integration + tags: [] + metadata: '{}' + search_keywords: [] + inputs: + - name: Text Input + description: A text input + type: text + default_value: some text + is_required: true + is_hidden: false + advanced: false + metadata: '{}' + connection_type_id: '' + - name: Int Input + description: An integer input + type: integer + default_value: '1234' + is_required: false + is_hidden: false + advanced: false + metadata: '{}' + connection_type_id: '' + outputs: + - name: Text Output + description: A text output + type: text + created_at: '2022-12-08T22:14:16.965Z' + created_by_user_id: PNBURS9 + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + /incident_workflows/triggers: + get: + x-pd-requires-scope: incident_workflows.read + tags: + - Incident Workflows + operationId: listIncidentWorkflowTriggers + description: | + List existing Incident Workflow Triggers + + Scoped OAuth requires: `incident_workflows.read` + summary: List Triggers + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/triggers_filter_workflow_id' + - $ref: '#/components/parameters/triggers_filter_incident_id' + - $ref: '#/components/parameters/triggers_filter_service_id' + - $ref: '#/components/parameters/triggers_filter_trigger_type' + - $ref: '#/components/parameters/triggers_sort_by' + - $ref: '#/components/parameters/cursor_limit' + - $ref: '#/components/parameters/cursor_cursor' + responses: + '200': + description: A paginated array of Incident Workflow Triggers + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/CursorPagination' + - type: object + properties: + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + triggers: + type: array + items: + $ref: '#/components/schemas/IncidentWorkflowTrigger' + examples: + response: + summary: Response Example + value: + triggers: + - id: 4ad696eb-bb48-422a-8bd0-6efad6befa29 + type: workflow_trigger + trigger_type_name: Conditional Trigger + trigger_type: conditional + condition: incident.priority matches 'P1' + trigger_url: 'https://api.pagerduty.com/incident_workflows/triggers/4ad696eb-bb48-422a-8bd0-6efad6befa29/start' + self: 'https://api.pagerduty.com/incident_workflows/triggers/4ad696eb-bb48-422a-8bd0-6efad6befa29' + workflow_id: PSFEVL7 + workflow_name: Example Incident Workflow + is_subscribed_to_all_services: true + services: [] + workflow: + id: PSFEVL7 + name: Example Incident Workflow + description: This Incident Workflow is an example + type: incident_workflow + created_at: '2022-12-13T19:55:01.171Z' + self: 'https://api.pagerduty.com/incident_workflows/PSFEVL7' + html_url: 'https://pdt-flex-actions.pagerduty.com/flex-workflows/workflows/PSFEVL7' + permissions: + restricted: false + limit: 1 + next_cursor: N2E3YzkzNjMtYzBkMC00NjFmLTg1OTEtMGZjMjcwODUzODNl + more: true + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + x-pd-requires-scope: incident_workflows.write + tags: + - Incident Workflows + operationId: createIncidentWorkflowTrigger + description: | + Create new Incident Workflow Trigger + + Scoped OAuth requires: `incident_workflows.write` + summary: Create a Trigger + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + requestBody: + content: + application/json: + schema: + type: object + properties: + trigger: + $ref: '#/components/schemas/IncidentWorkflowTrigger' + required: + - trigger + examples: + request: + summary: Request Example + value: + trigger: + trigger_type: conditional + workflow: + id: PSFEVL7 + services: + - id: PIJ90N7 + is_subscribed_to_all_services: false + condition: incident.priority matches 'P1' + responses: + '201': + description: The newly created Incident Workflow Trigger + content: + application/json: + schema: + type: object + properties: + trigger: + $ref: '#/components/schemas/IncidentWorkflowTrigger' + required: + - trigger + examples: + response: + summary: Response Example + value: + trigger: + id: 4ad696eb-bb48-422a-8bd0-6efad6befa29 + type: workflow_trigger + trigger_type_name: Conditional Trigger + trigger_type: conditional + condition: incident.priority matches 'P1' + trigger_url: 'https://api.pagerduty.com/incident_workflows/triggers/4ad696eb-bb48-422a-8bd0-6efad6befa29/start' + self: 'https://api.pagerduty.com/incident_workflows/triggers/4ad696eb-bb48-422a-8bd0-6efad6befa29' + workflow_id: PSFEVL7 + workflow_name: Example Incident Workflow + is_subscribed_to_all_services: false + services: + - id: PIJ90N7 + summary: My Application Service + type: service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://pdt-circular.pagerduty.com/service-directory/P0544JX' + workflow: + id: PSFEVL7 + name: Example Incident Workflow + description: This Incident Workflow is an example + type: incident_workflow + created_at: '2022-12-13T19:55:01.171Z' + self: 'https://api.pagerduty.com/incident_workflows/PSFEVL7' + html_url: 'https://mydomain.pagerduty.com/flex-workflows/workflows/PSFEVL7' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/incident_workflows/triggers/{id}': + get: + x-pd-requires-scope: incident_workflows.read + tags: + - Incident Workflows + operationId: getIncidentWorkflowTrigger + description: | + Retrieve an existing Incident Workflows Trigger + + Scoped OAuth requires: `incident_workflows.read` + summary: Get a Trigger + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: The Incident Workflows Trigger + content: + application/json: + schema: + type: object + properties: + trigger: + $ref: '#/components/schemas/IncidentWorkflowTrigger' + examples: + response: + summary: Response Example + value: + trigger: + id: 4ad696eb-bb48-422a-8bd0-6efad6befa29 + type: workflow_trigger + trigger_type_name: Manual Trigger + trigger_type: manual + trigger_url: 'https://api.pagerduty.com/incident_workflows/triggers/4ad696eb-bb48-422a-8bd0-6efad6befa29/start' + self: 'https://api.pagerduty.com/incident_workflows/triggers/4ad696eb-bb48-422a-8bd0-6efad6befa29' + workflow_id: PSFEVL7 + workflow_name: Example Incident Workflow + is_subscribed_to_all_services: true + services: [] + workflow: + id: PSFEVL7 + name: Example Incident Workflow + description: This Incident Workflow is an example + type: incident_workflow + created_at: '2022-12-13T19:55:01.171Z' + self: 'https://api.pagerduty.com/incident_workflows/PSFEVL7' + html_url: 'https://pdt-flex-actions.pagerduty.com/flex-workflows/workflows/PSFEVL7' + permissions: + restricted: true + team_id: PUOEV7R + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + x-pd-requires-scope: incident_workflows.write + tags: + - Incident Workflows + operationId: updateIncidentWorkflowTrigger + description: | + Update an existing Incident Workflow Trigger + + Scoped OAuth requires: `incident_workflows.write` + summary: Update a Trigger + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + trigger: + $ref: '#/components/schemas/IncidentWorkflowTrigger' + required: + - trigger + examples: + request: + summary: Request Example + value: + trigger: + services: + - id: PIJ90N7 + is_subscribed_to_all_services: false + condition: incident.priority matches 'P1' + responses: + '200': + description: The updated Incident Workflow Trigger + content: + application/json: + schema: + type: object + properties: + trigger: + $ref: '#/components/schemas/IncidentWorkflowTrigger' + required: + - trigger + examples: + response: + summary: Response Example + value: + trigger: + id: 4ad696eb-bb48-422a-8bd0-6efad6befa29 + type: workflow_trigger + trigger_type_name: Conditional Trigger + trigger_type: conditional + condition: incident.priority matches 'P1' + trigger_url: 'https://api.pagerduty.com/incident_workflows/triggers/4ad696eb-bb48-422a-8bd0-6efad6befa29/start' + self: 'https://api.pagerduty.com/incident_workflows/triggers/4ad696eb-bb48-422a-8bd0-6efad6befa29' + workflow_id: PSFEVL7 + workflow_name: Example Incident Workflow + is_subscribed_to_all_services: false + services: + - id: PIJ90N7 + summary: My Application Service + type: service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://pdt-circular.pagerduty.com/service-directory/P0544JX' + workflow: + id: PSFEVL7 + name: Example Incident Workflow + description: This Incident Workflow is an example + type: incident_workflow + created_at: '2022-12-13T19:55:01.171Z' + self: 'https://api.pagerduty.com/incident_workflows/PSFEVL7' + html_url: 'https://mydomain.pagerduty.com/flex-workflows/workflows/PSFEVL7' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + delete: + x-pd-requires-scope: incident_workflows.write + tags: + - Incident Workflows + operationId: deleteIncidentWorkflowTrigger + description: | + Delete an existing Incident Workflow Trigger + + Scoped OAuth requires: `incident_workflows.write` + summary: Delete a Trigger + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '204': + description: The Incident Workflow Trigger was deleted successfully. + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/incident_workflows/triggers/{id}/services': + post: + x-pd-requires-scope: incident_workflows.write + tags: + - Incident Workflows + operationId: associateServiceToIncidentWorkflowTrigger + description: | + Associate a Service with an existing Incident Workflow Trigger + + Scoped OAuth requires: `incident_workflows.write` + summary: Associate a Trigger and Service + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + service: + type: object + properties: + id: + type: string + required: + - service + examples: + request: + summary: Request Example + value: + service: + id: PIJ90N7 + responses: + '201': + description: The updated Incident Workflow Trigger + content: + application/json: + schema: + type: object + properties: + trigger: + $ref: '#/components/schemas/IncidentWorkflowTrigger' + required: + - trigger + examples: + response: + summary: Response Example + value: + trigger: + id: 4ad696eb-bb48-422a-8bd0-6efad6befa29 + type: workflow_trigger + trigger_type_name: Conditional Trigger + trigger_type: conditional + condition: incident.priority matches 'P1' + trigger_url: 'https://api.pagerduty.com/incident_workflows/triggers/4ad696eb-bb48-422a-8bd0-6efad6befa29/start' + self: 'https://api.pagerduty.com/incident_workflows/triggers/4ad696eb-bb48-422a-8bd0-6efad6befa29' + workflow_id: PSFEVL7 + workflow_name: Example Incident Workflow + is_subscribed_to_all_services: false + services: + - id: PIJ90N7 + summary: My Application Service + type: service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://pdt-circular.pagerduty.com/service-directory/P0544JX' + workflow: + id: PSFEVL7 + name: Example Incident Workflow + description: This Incident Workflow is an example + type: incident_workflow + created_at: '2022-12-13T19:55:01.171Z' + self: 'https://api.pagerduty.com/incident_workflows/PSFEVL7' + html_url: 'https://mydomain.pagerduty.com/flex-workflows/workflows/PSFEVL7' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/incident_workflows/triggers/{trigger_id}/services/{service_id}': + delete: + x-pd-requires-scope: incident_workflows.write + tags: + - Incident Workflows + operationId: deleteServiceFromIncidentWorkflowTrigger + description: | + Remove a an existing Service from an Incident Workflow Trigger + + Scoped OAuth requires: `incident_workflows.write` + summary: Dissociate a Trigger and Service + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/triggers_path_trigger_id' + - $ref: '#/components/parameters/triggers_path_service_id' + responses: + '201': + description: The updated Incident Workflow Trigger + content: + application/json: + schema: + type: object + properties: + trigger: + $ref: '#/components/schemas/IncidentWorkflowTrigger' + required: + - trigger + examples: + response: + summary: Response Example + value: + trigger: + id: 4ad696eb-bb48-422a-8bd0-6efad6befa29 + type: workflow_trigger + trigger_type_name: Conditional Trigger + trigger_type: conditional + condition: incident.priority matches 'P1' + trigger_url: 'https://api.pagerduty.com/incident_workflows/triggers/4ad696eb-bb48-422a-8bd0-6efad6befa29/start' + self: 'https://api.pagerduty.com/incident_workflows/triggers/4ad696eb-bb48-422a-8bd0-6efad6befa29' + workflow_id: PSFEVL7 + workflow_name: Example Incident Workflow + is_subscribed_to_all_services: false + services: [] + workflow: + id: PSFEVL7 + name: Example Incident Workflow + description: This Incident Workflow is an example + type: incident_workflow + created_at: '2022-12-13T19:55:01.171Z' + self: 'https://api.pagerduty.com/incident_workflows/PSFEVL7' + html_url: 'https://mydomain.pagerduty.com/flex-workflows/workflows/PSFEVL7' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/incidents.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/incidents.yaml new file mode 100644 index 0000000..2057f60 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/incidents.yaml @@ -0,0 +1,7229 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + Incident: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + incident_number: + type: integer + readOnly: true + description: The number of the incident. This is unique across your account. + created_at: + type: string + format: date-time + readOnly: true + description: The date/time the incident was first triggered. + status: + type: string + description: The current status of the incident. + enum: + - triggered + - acknowledged + - resolved + title: + type: string + readOnly: false + description: 'A succinct description of the nature, symptoms, cause, or effect of the incident.' + pending_actions: + type: array + readOnly: true + description: 'The list of pending_actions on the incident. A pending_action object contains a type of action which can be escalate, unacknowledge, resolve or urgency_change. A pending_action object contains at, the time at which the action will take place. An urgency_change pending_action will contain to, the urgency that the incident will change to.' + items: + $ref: '#/components/schemas/IncidentAction' + incident_key: + type: string + readOnly: true + description: The incident's de-duplication key. + service: + $ref: '#/components/schemas/ServiceReference' + assignments: + type: array + description: List of all assignments for this incident. This list will be empty if the `Incident.status` is `resolved`. + items: + $ref: '#/components/schemas/Assignment' + assigned_via: + type: string + description: How the current incident assignments were decided. Note that `direct_assignment` incidents will not escalate up the attached `escalation_policy` + enum: + - escalation_policy + - direct_assignment + readOnly: true + acknowledgements: + type: array + description: List of all acknowledgements for this incident. This list will be empty if the `Incident.status` is `resolved` or `triggered`. + items: + $ref: '#/components/schemas/Acknowledgement' + last_status_change_at: + type: string + format: date-time + readOnly: true + description: The time at which the status of the incident last changed. + last_status_change_by: + $ref: '#/components/schemas/AgentReference' + first_trigger_log_entry: + $ref: '#/components/schemas/LogEntryReference' + escalation_policy: + $ref: '#/components/schemas/EscalationPolicyReference' + teams: + type: array + description: The teams involved in the incident’s lifecycle. + items: + $ref: '#/components/schemas/TeamReference' + priority: + $ref: '#/components/schemas/PriorityReference' + urgency: + type: string + enum: + - high + - low + description: The current urgency of the incident. + resolve_reason: + $ref: '#/components/schemas/ResolveReason' + alert_counts: + $ref: '#/components/schemas/AlertCount' + conference_bridge: + $ref: '#/components/schemas/ConferenceBridge' + body: + $ref: '#/components/schemas/IncidentBody' + incidents_responders: + type: array + readOnly: true + items: + $ref: '#/components/schemas/IncidentsRespondersReference' + responder_requests: + type: array + readOnly: true + items: + $ref: '#/components/schemas/ResponderRequest' + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + IncidentAction: + description: An incident action is a pending change to an incident that will automatically happen at some future time. + type: object + properties: + type: + type: string + enum: + - unacknowledge + - escalate + - resolve + - urgency_change + at: + type: string + format: date-time + discriminator: + propertyName: type + required: + - type + - at + ServiceReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - service_reference + Assignment: + type: object + properties: + at: + type: string + format: date-time + description: Time at which the assignment was created. + assignee: + $ref: '#/components/schemas/UserReference' + required: + - at + - assignee + Acknowledgement: + type: object + properties: + at: + type: string + format: date-time + description: Time at which the acknowledgement was created. + acknowledger: + $ref: '#/components/schemas/AcknowledgerReference' + required: + - at + - acknowledger + AgentReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + description: 'The agent (user, service or integration) that created or modified the Incident Log Entry.' + properties: + type: + enum: + - user_reference + - service_reference + - integration_reference + type: string + readOnly: true + LogEntryReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - acknowledge_log_entry_reference + - annotate_log_entry_reference + - assign_log_entry_reference + - escalate_log_entry_reference + - exhaust_escalation_path_log_entry_reference + - notify_log_entry_reference + - reach_trigger_limit_log_entry_reference + - repeat_escalation_path_log_entry_reference + - resolve_log_entry_reference + - snooze_log_entry_reference + - trigger_log_entry_reference + - unacknowledge_log_entry_reference + EscalationPolicyReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - escalation_policy_reference + TeamReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - team_reference + PriorityReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - priority_reference + ResolveReason: + type: object + properties: + type: + type: string + description: The reason the incident was resolved. The only reason currently supported is merge. + default: merge_resolve_reason + enum: + - merge_resolve_reason + incident: + $ref: '#/components/schemas/IncidentReference' + AlertCount: + type: object + properties: + triggered: + type: integer + description: The count of triggered alerts + resolved: + type: integer + description: The count of resolved alerts + all: + type: integer + description: The total count of alerts + ConferenceBridge: + type: object + properties: + conference_number: + type: string + description: 'The phone number of the conference call for the conference bridge. Phone numbers should be formatted like +1 415-555-1212,,,,1234#, where a comma (,) represents a one-second wait and pound (#) completes access code input.' + conference_url: + type: string + format: url + description: An URL for the conference bridge. This could be a link to a web conference or Slack channel. + IncidentBody: + type: object + properties: + type: + type: string + enum: + - incident_body + details: + type: string + description: Additional incident details. + required: + - type + IncidentsRespondersReference: + type: object + properties: + state: + type: string + description: The status of the responder being added to the incident + example: pending + user: + $ref: '#/components/schemas/UserReference' + incident: + $ref: '#/components/schemas/IncidentReference' + updated_at: + type: string + message: + type: string + description: The message sent with the responder request + requester: + $ref: '#/components/schemas/UserReference' + requested_at: + type: string + ResponderRequest: + type: object + properties: + incident: + $ref: '#/components/schemas/IncidentReference' + requester: + $ref: '#/components/schemas/UserReference' + requested_at: + type: string + description: The time the request was made + message: + type: string + description: The message sent with the responder request + responder_request_targets: + type: array + description: The array of targets the responder request is being sent to + items: + $ref: '#/components/schemas/ResponderRequestTargetReference' + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + UserReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - user_reference + AcknowledgerReference: + allOf: + - $ref: '#/components/schemas/Reference' + - description: The acknowledger represents the entity that made the acknowledgement for an incident. + type: object + properties: + type: + enum: + - user_reference + - service_reference + type: string + IncidentReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - incident_reference + ResponderRequestTargetReference: + type: object + properties: + type: + type: string + description: The type of target (either a user or an escalation policy) + id: + type: string + description: The id of the user or escalation policy + summary: + type: string + incident_responders: + type: array + description: An array of responders associated with the specified incident + items: + $ref: '#/components/schemas/IncidentsRespondersReference' + Alert: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + created_at: + type: string + format: date-time + readOnly: true + description: The date/time the alert was first triggered. + type: + type: string + default: alert + description: The type of object being created. + enum: + - alert + status: + type: string + description: The current status of the alert. + enum: + - triggered + - resolved + alert_key: + type: string + readOnly: true + description: The alert's de-duplication key. + service: + $ref: '#/components/schemas/ServiceReference' + first_trigger_log_entry: + $ref: '#/components/schemas/LogEntryReference' + incident: + $ref: '#/components/schemas/IncidentReference' + suppressed: + type: boolean + readOnly: true + description: Whether or not an alert is suppressed. Suppressed alerts are not created with a parent incident. + default: false + severity: + type: string + readOnly: true + description: The magnitude of the problem as reported by the monitoring tool. + enum: + - info + - warning + - error + - critical + integration: + $ref: '#/components/schemas/IntegrationReference' + body: + type: object + readOnly: true + description: A JSON object containing data describing the alert. + title: Body + properties: + type: + type: string + description: The type of the body. + enum: + - alert_body + contexts: + type: array + readOnly: true + description: Contexts to be included with the body such as links to graphs or images. + items: + $ref: '#/components/schemas/Context' + details: + type: object + readOnly: true + description: An arbitrary JSON object or string containing any data explaining the nature of the alert. + required: + - type + example: + type: alert + status: resolved + incident: + id: PEYSGVF + type: incident_reference + body: + type: alert_body + contexts: + - type: link + details: + customKey: Server is on fire! + customKey2: Other stuff! + IntegrationReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - aws_cloudwatch_inbound_integration_reference + - cloudkick_inbound_integration_reference + - event_transformer_api_inbound_integration_reference + - generic_email_inbound_integration_reference + - generic_events_api_inbound_integration_reference + - keynote_inbound_integration_reference + - nagios_inbound_integration_reference + - pingdom_inbound_integration_reference + - sql_monitor_inbound_integration_reference + - events_api_v2_inbound_integration_reference + - inbound_integration_reference + Context: + type: object + discriminator: + propertyName: type + properties: + type: + type: string + description: The type of context being attached to the incident. + enum: + - link + - image + href: + type: string + description: The link's target url + src: + type: string + description: The image's source url + text: + type: string + description: The alternate display for an image + required: + - type + CursorPagination: + type: object + properties: + limit: + type: integer + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + readOnly: true + next_cursor: + type: string + description: | + An opaque string than will deliver the next set of results when provided as the `cursor` parameter in a subsequent request. A `null` value for this field indicates that there are no additional results. + example: dXNlcjaVMzc5V0ZYTlo= + nullable: true + readOnly: true + required: + - limit + - next_cursor + Impact: + title: Impact + type: object + properties: + id: + type: string + readOnly: true + name: + type: string + readOnly: true + type: + type: string + description: The kind of object that has been impacted + enum: + - business_service + status: + type: string + description: The current impact status of the object + enum: + - impacted + - not_impacted + additional_fields: + type: object + properties: + highest_impacting_priority: + type: object + nullable: true + description: Priority information for the highest priority level that is affecting the impacted object. + properties: + id: + type: string + readOnly: true + order: + type: integer + readOnly: true + CustomFieldsFieldValue: + type: object + properties: + id: + type: string + description: Id of the field. + name: + type: string + description: 'The name of the field. May include ASCII characters, specifically lowercase letters, digits, and underescores. The `name` for a Field must be unique.' + maxLength: 50 + type: + type: string + description: Determines the type of the reference. + enum: + - field_value + display_name: + type: string + description: The human-readable name of the field. This must be unique across an account. + maxLength: 50 + multi_value: + type: boolean + description: 'If `true`, allows the custom field to store a set of multiple values. Must be `false` if `datatype` is not "string" or "url"' + datatype: + type: string + description: The kind of data the custom field is allowed to contain. + enum: + - boolean + - integer + - float + - string + - datetime + - url + description: + type: string + nullable: true + description: A description of the data this field contains. + maxLength: 1000 + fixed_options: + type: boolean + description: 'If `true`, restricts the values allowed to be stored in the custom field to a limited set of options (configured via the Field Option sub-resource). Must be `false` if `datatype` is "boolean", "url", or "datetime"' + value: + oneOf: + - type: object + properties: + value: + type: boolean + nullable: true + - type: object + properties: + value: + type: number + nullable: true + - type: object + properties: + value: + type: integer + nullable: true + - type: object + properties: + value: + oneOf: + - type: string + maxLength: 200 + nullable: true + - type: array + items: + type: string + maxLength: 200 + maxItems: 10 + uniqueItems: true + nullable: true + - type: object + properties: + value: + type: string + nullable: true + format: date-time + - type: object + properties: + value: + oneOf: + - type: string + format: uri + maxLength: 200 + nullable: true + - type: array + items: + type: string + format: uri + maxLength: 200 + maxItems: 10 + uniqueItems: true + nullable: true + required: + - id + - type + - name + - value + - display_name + - datatype + - multi_value + - description + - fixed_options + CustomFieldsEditableFieldValue: + oneOf: + - type: object + properties: + name: + $ref: '#/components/schemas/CustomFieldsFieldValue/properties/name' + value: + oneOf: + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/0' + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/1' + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/2' + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/3' + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/4' + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/5' + - type: object + properties: + id: + type: string + description: The ID of the Field. + value: + oneOf: + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/0' + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/1' + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/2' + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/3' + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/4' + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/5' + CustomFieldsIncidentSchema: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + description: The ID of the resource. + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + self: + type: string + nullable: true + readOnly: true + format: url + description: The API show URL at which the object is accessible + type: + type: string + readOnly: true + enum: + - schema + title: + description: The name of the schema. + type: string + maxLength: 100 + description: + description: A description of this schema. + type: string + nullable: true + maxLength: 1000 + required: + - id + - type + - summary + - self + - type: object + properties: + field_configurations: + type: array + readOnly: true + items: + allOf: + - $ref: '#/components/schemas/CustomFieldsFieldConfigurationWithFieldReference/allOf/0' + - type: object + properties: + field: + $ref: '#/components/schemas/CustomFieldsFieldWithOptions' + maxItems: 20 + uniqueItems: true + required: + - title + - description + CustomFieldsFieldConfigurationWithFieldReference: + allOf: + - allOf: + - $ref: '#/components/schemas/CustomFieldsEditableFieldConfiguration' + - type: object + properties: + type: + type: string + enum: + - field_configuration + required: + - id + - type + - created_at + - updated_at + - field + - required + - type: object + properties: + field: + description: The Field to be included in this schema. Each Field may only be used in one Field Configuration per schema. + allOf: + - type: object + properties: + type: + type: string + description: 'A string that determines the type of the reference. This must be the standard name for the entity, suffixed by `_reference`.' + enum: + - field_reference + id: + type: string + description: The ID of the resource. + required: + - type + - id + CustomFieldsFieldWithOptions: + allOf: + - $ref: '#/components/schemas/CustomFieldsField' + - type: object + properties: + field_options: + type: array + description: The fixed list of value options that may be stored in this field. + items: + $ref: '#/components/schemas/CustomFieldsFieldOption' + nullable: true + CustomFieldsEditableFieldConfiguration: + type: object + properties: + default_value: + type: object + description: The value to use for this field if none is provided. It must be specified if `required` is `true`. + allOf: + - oneOf: + - allOf: + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/0' + - type: object + properties: + datatype: + type: string + enum: + - boolean + required: + - datatype + - value + - allOf: + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/2' + - type: object + properties: + datatype: + type: string + enum: + - integer + required: + - datatype + - value + - allOf: + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/1' + - type: object + properties: + datatype: + type: string + enum: + - float + required: + - datatype + - value + - allOf: + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/3' + - type: object + properties: + datatype: + type: string + enum: + - string + required: + - datatype + - value + - allOf: + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/4' + - type: object + properties: + datatype: + type: string + enum: + - datetime + required: + - datatype + - value + - allOf: + - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/5' + - type: object + properties: + datatype: + type: string + enum: + - url + required: + - datatype + - value + - type: object + properties: + datatype: + type: string + enum: + - field_option + value: + oneOf: + - type: object + properties: + type: + type: string + enum: + - field_option_reference + id: + type: string + description: 'The ID of the field option. If value is not provided, an ID must be provided.' + value: + type: string + description: 'The value of the field option. If ID is not provided, an value must be provided.' + required: + - type + - id + - value + - type: array + items: + type: object + properties: + type: + type: string + enum: + - field_option_reference + id: + type: string + description: 'The ID of the field option. If value is not provided, an ID must be provided.' + value: + type: string + description: 'The value of the field option. If ID is not provided, an value must be provided.' + required: + - type + - id + - value + maxItems: 10 + uniqueItems: true + nullable: true + required: + - datatype + - value + discriminator: + propertyName: datatype + mapping: + boolean: ./BooleanFieldValue.yaml + integer: ./IntegerFieldValue.yaml + float: ./FloatFieldValue.yaml + string: ./StringFieldValue.yaml + datetime: ./DatetimeFieldValue.yaml + url: ./UrlFieldValue.yaml + field_option: ./FieldOptionFieldValue.yaml + - type: object + properties: + multi_value: + type: boolean + description: 'If `true`, allows the custom field to store a set of values. Must match the Field''s `multi_value` setting.' + required: + - multi_value + id: + type: string + readOnly: true + description: The ID of the resource. + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + created_at: + type: string + format: date-time + description: The date/time the object was created at. + readOnly: true + updated_at: + type: string + format: date-time + description: The date/time the object was last updated. + readOnly: true + required: + description: 'If `true`, this Field must always have a value set for objects using this schema.' + type: boolean + CustomFieldsField: + allOf: + - $ref: '#/components/schemas/CustomFieldsEditableField' + - type: object + properties: + id: + type: string + readOnly: true + description: The ID of the resource. + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + self: + type: string + nullable: true + readOnly: true + format: url + description: The API show URL at which the object is accessible + type: + type: string + enum: + - field + created_at: + type: string + format: date-time + description: The date/time the object was created at. + readOnly: true + updated_at: + type: string + format: date-time + description: The date/time the object was last updated. + readOnly: true + datatype: + $ref: '#/components/schemas/CustomFieldsFieldValue/properties/datatype' + multi_value: + $ref: '#/components/schemas/CustomFieldsFieldValue/properties/multi_value' + fixed_options: + $ref: '#/components/schemas/CustomFieldsFieldValue/properties/fixed_options' + required: + - id + - summary + - self + - type + - created_at + - updated_at + - datatype + - namespace + - name + - display_name + - multi_value + - fixed_options + CustomFieldsFieldOption: + allOf: + - $ref: '#/components/schemas/CustomFieldsEditableFieldOption' + - type: object + required: + - id + - type + - data + - created_at + - updated_at + CustomFieldsEditableField: + type: object + properties: + display_name: + $ref: '#/components/schemas/CustomFieldsFieldValue/properties/display_name' + description: + $ref: '#/components/schemas/CustomFieldsFieldValue/properties/description' + CustomFieldsEditableFieldOption: + type: object + properties: + id: + type: string + readOnly: true + description: The ID of the resource. + type: + type: string + enum: + - field_option + created_at: + type: string + format: date-time + description: The date/time the object was created at. + readOnly: true + updated_at: + type: string + format: date-time + description: The date/time the object was last updated. + readOnly: true + data: + oneOf: + - type: object + properties: + datatype: + type: string + description: The kind of data represented by this option. Must match the Field's `datatype`. + enum: + - integer + value: + type: integer + required: + - datatype + - value + - type: object + properties: + datatype: + type: string + description: The kind of data represented by this option. Must match the Field's `datatype`. + enum: + - float + value: + type: number + required: + - datatype + - value + - type: object + properties: + datatype: + type: string + description: The kind of data represented by this option. Must match the Field's `datatype`. + enum: + - string + value: + type: string + maxLength: 200 + required: + - datatype + - value + discriminator: + propertyName: datatype + mapping: + integer: ./IntegerFixedOptionValue.yaml + float: ./FloatFixedOptionValue.yaml + string: ./StringFixedOptionValue.yaml + required: + - id + - type + - created_at + - updated_at + description: '' + AcknowledgeLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + acknowledgement_timeout: + type: integer + description: 'Duration for which the acknowledgement lasts, in seconds. Services can contain an `acknowledgement_timeout` property, which specifies the length of time acknowledgements should last for. Each time an incident is acknowledged, this timeout is copied into the acknowledgement log entry. This property is optional, as older log entries may not contain it. It may also be `null`, as acknowledgements can be performed on incidents whose services have no `acknowledgement_timeout` set.' + type: + type: string + enum: + - acknowledgement_log_entry + AnnotateLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - annotate_log_entry + AssignLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + assignees: + type: array + readOnly: true + description: An array of assigned Users for this log entry + items: + $ref: '#/components/schemas/UserReference' + type: + type: string + enum: + - assign_log_entry + DelegateLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + assignees: + type: array + readOnly: true + description: An array of assigned Users for this log entry + items: + $ref: '#/components/schemas/UserReference' + type: + type: string + enum: + - delegate_log_entry + EscalateLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + assignees: + type: array + readOnly: true + description: An array of assigned Users for this log entry + items: + $ref: '#/components/schemas/UserReference' + type: + type: string + enum: + - escalate_log_entry + ExhaustEscalationPathLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - exhaust_escalation_path_log_entry + NotifyLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + created_at: + type: string + format: date-time + readOnly: true + description: Time at which the log entry was created + user: + $ref: '#/components/schemas/UserReference' + type: + type: string + enum: + - notify_log_entry + ReachAckLimitLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - reach_ack_limit_log_entry + ReachTriggerLimitLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - reach_trigger_limit_log_entry + RepeatEscalationPathLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - repeat_escalation_path_log_entry + ResolveLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - resolve_log_entry + SnoozeLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + changed_actions: + type: array + items: + $ref: '#/components/schemas/IncidentAction' + type: + type: string + enum: + - snooze_log_entry + TriggerLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - trigger_log_entry + UnacknowledgeLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - unacknowledge_log_entry + UrgencyChangeLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - urgency_change_log_entry + LogEntry: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + type: + type: string + enum: + - acknowledge_log_entry + - annotate_log_entry + - assign_log_entry + - delegate_log_entry + - escalate_log_entry + - exhaust_escalation_path_log_entry + - notify_log_entry + - reach_ack_limit_log_entry + - reach_trigger_limit_log_entry + - repeat_escalation_path_log_entry + - resolve_log_entry + - snooze_log_entry + - trigger_log_entry + - unacknowledge_log_entry + - urgency_change_log_entry + created_at: + type: string + format: date-time + readOnly: true + description: Time at which the log entry was created. + channel: + $ref: '#/components/schemas/Channel' + agent: + $ref: '#/components/schemas/AgentReference' + note: + type: string + readOnly: true + description: 'Optional field containing a note, if one was included with the log entry.' + contexts: + type: array + readOnly: true + description: Contexts to be included with the trigger such as links to graphs or images. + items: + $ref: '#/components/schemas/Context' + service: + $ref: '#/components/schemas/ServiceReference' + incident: + $ref: '#/components/schemas/IncidentReference' + teams: + type: array + readOnly: true + description: Will consist of references unless included + items: + $ref: '#/components/schemas/TeamReference' + event_details: + type: object + readOnly: true + properties: + description: + type: string + description: Additional details about the event. + Channel: + type: object + description: 'Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats.' + properties: + type: + type: string + description: type + user: + type: object + team: + type: object + notification: + $ref: '#/components/schemas/Notification' + channel: + type: object + description: channel + required: + - type + Notification: + type: object + properties: + id: + type: string + readOnly: true + type: + type: string + description: The type of notification. + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + readOnly: true + started_at: + type: string + format: date-time + description: The time at which the notification was sent + readOnly: true + address: + type: string + description: The address where the notification was sent. This will be null for notification type `push_notification`. + readOnly: true + user: + $ref: '#/components/schemas/UserReference' + conferenceAddress: + type: string + description: The address of the conference bridge + status: + type: string + '': + type: string + IncidentNote: + type: object + properties: + id: + type: string + readOnly: true + user: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + description: The user who created a Note. If a service created this Note the `user.type` will be "bot_user_reference" and `user.summary` will list the name of the service rather than the user. + properties: + type: + type: string + enum: + - user_reference + - bot_user_reference + channel: + type: object + readOnly: true + description: The means by which this Note was created. Has different formats depending on type. + properties: + summary: + type: string + description: A string describing the source of the Note. + readOnly: true + id: + type: string + readOnly: true + type: + type: string + description: A string that determines the schema of the object + readOnly: true + self: + type: string + format: url + description: The API show URL at which the object is accessible + readOnly: true + html_url: + type: string + format: url + description: a URL at which the entity is uniquely displayed in the Web app + readOnly: true + required: + - summary + content: + type: string + description: The note content + created_at: + type: string + format: date-time + description: The time at which the note was submitted + readOnly: true + required: + - content + example: + content: Firefighters are on the scene. + RelatedIncidentMachineLearningRelationship: + type: object + description: | + The data for a type of relationship where the Incident is related due to our machine learning algorithm. + properties: + grouping_classification: + type: string + description: | + The classification for why this Related Incident was grouped into this group. + Values can be one of: [similar_contents, prior_feedback], where: + similar_contents - The Related Incident was due to similar contents of the Incidents. + prior_feedback - The Related Incident was determined to be related, based on User feedback or Incident merge/unmerge actions. + enum: + - similar_contents + - prior_feedback + user_feedback: + type: object + description: The feedback provided from Users to influence the machine learning algorithm for future Related Incidents. + properties: + positive_feedback_count: + type: integer + description: The total number of times Users agreed that the Incidents are related. + negative_feedback_count: + type: integer + description: The total number of times Users disagreed that the Incidents are related. + RelatedIncidentServiceDependencyRelationship: + type: object + description: | + The data for a type of relationship where the Incident is related due to Business or Technical Service dependencies. + + Both `dependent_services` and `supporting_services` are returned to signify the dependencies between the Services + that the Incident and Related Incident belong to. + + Each Service reference returned in the list of supporting and dependent Services has a type of: + [business_service_reference, technical_service_reference]. + properties: + dependent_services: + type: array + items: + $ref: '#/components/schemas/RelatedIncidentServiceDependencyBase' + supporting_services: + type: array + items: + $ref: '#/components/schemas/RelatedIncidentServiceDependencyBase' + RelatedIncidentServiceDependencyBase: + type: object + properties: + id: + type: string + description: The ID of the Service referenced. + readOnly: true + type: + type: string + description: The type of the related Service. + enum: + - business_service_reference + - technical_service_reference + self: + type: string + nullable: true + readOnly: true + format: url + description: The API show URL at which the object is accessible. + StatusUpdate: + type: object + properties: + id: + type: string + message: + type: string + description: The message of the status update. + created_at: + type: string + description: The date/time when this status update was created. + sender: + $ref: '#/components/schemas/UserReference' + subject: + type: string + description: The subject of the custom html email status update. Present if included in request body. + html_message: + type: string + description: The html content of the custom html email status update. Present if included in request body. + NotificationSubscriberWithContext: + title: NotificationSubscriberWithContext + description: A reference of a subscriber entity with additional subscription context. + type: object + example: + subscriber_id: PD1234 + subscriber_type: user + properties: + subscriber_id: + type: string + description: The ID of the entity being subscribed + subscriber_type: + type: string + description: The type of the entity being subscribed + enum: + - user + - team + has_indirect_subscription: + type: boolean + description: If this subcriber has an indirect subscription to this incident via another object + subscribed_via: + nullable: true + type: array + items: + type: object + properties: + id: + type: string + description: The id of the object this subscriber is subscribed via + name: + type: string + description: The type of the object this subscriber is subscribed via + NotificationSubscriptionWithContext: + title: NotificationSubscriptionWithContext + type: object + description: An object describing the relationship of a NotificationSubscriber and a NotificationSubscribable with additional context on status of subscription attempt. + x-examples: + example-1: + subscriber_id: string + subscriber_type: user + subscribable_id: string + subscribable_type: incident + account_id: string + result: success + properties: + subscriber_id: + type: string + description: The ID of the entity being subscribed + subscriber_type: + type: string + enum: + - user + - team + description: The type of the entity being subscribed + subscribable_id: + type: string + description: The ID of the entity being subscribed to + subscribable_type: + type: string + enum: + - incident + - business_service + description: The type of the entity being subscribed to + account_id: + type: string + description: The type of the entity being subscribed to + result: + type: string + enum: + - success + - duplicate + - unauthorized + description: The resulting status of the subscription + NotificationSubscriber: + title: NotificationSubscriber + description: A reference of a subscriber entity. + type: object + properties: + subscriber_id: + type: string + description: The ID of the entity being subscribed + subscriber_type: + type: string + description: The type of the entity being subscribed + enum: + - user + - team + example: + subscriber_id: PD1234 + subscriber_type: user + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + PaymentRequired: + description: | + Account does not have the abilities to perform the action. Please review the response for the required abilities. + You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + RequestEntityTooLarge: + description: Caller provided a request that is too large to process. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + UnprocessableEntity: + description: Unprocessable Entity. Some arguments failed validation checks. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + InternalServerError: + description: Internal Server Error the PagerDuty server experienced an error. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + incidents: + id: pagerduty.incidents.incidents + name: incidents + title: Incidents + methods: + list_incidents: + operation: + $ref: '#/paths/~1incidents/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.incidents + _list_incidents: + operation: + $ref: '#/paths/~1incidents/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_incidents: + operation: + $ref: '#/paths/~1incidents/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create_incident: + operation: + $ref: '#/paths/~1incidents/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_incident: + operation: + $ref: '#/paths/~1incidents~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.incident + _get_incident: + operation: + $ref: '#/paths/~1incidents~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_incident: + operation: + $ref: '#/paths/~1incidents~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + merge_incidents: + operation: + $ref: '#/paths/~1incidents~1{id}~1merge/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create_incident_responder_request: + operation: + $ref: '#/paths/~1incidents~1{id}~1responder_requests/post' + response: + mediaType: application/json + openAPIDocKey: '200' + create_incident_snooze: + operation: + $ref: '#/paths/~1incidents~1{id}~1snooze/post' + response: + mediaType: application/json + openAPIDocKey: '201' + create_incident_status_update: + operation: + $ref: '#/paths/~1incidents~1{id}~1status_updates/post' + response: + mediaType: application/json + openAPIDocKey: '200' + remove_incident_notification_subscribers: + operation: + $ref: '#/paths/~1incidents~1{id}~1status_updates~1unsubscribe/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/incidents/methods/get_incident' + - $ref: '#/components/x-stackQL-resources/incidents/methods/list_incidents' + insert: + - $ref: '#/components/x-stackQL-resources/incidents/methods/create_incident' + update: [] + delete: [] + alerts: + id: pagerduty.incidents.alerts + name: alerts + title: Alerts + methods: + list_incident_alerts: + operation: + $ref: '#/paths/~1incidents~1{id}~1alerts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.alerts + _list_incident_alerts: + operation: + $ref: '#/paths/~1incidents~1{id}~1alerts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_incident_alerts: + operation: + $ref: '#/paths/~1incidents~1{id}~1alerts/put' + response: + mediaType: application/json + openAPIDocKey: '200' + get_incident_alert: + operation: + $ref: '#/paths/~1incidents~1{id}~1alerts~1{alert_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.alert + _get_incident_alert: + operation: + $ref: '#/paths/~1incidents~1{id}~1alerts~1{alert_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_incident_alert: + operation: + $ref: '#/paths/~1incidents~1{id}~1alerts~1{alert_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/alerts/methods/get_incident_alert' + - $ref: '#/components/x-stackQL-resources/alerts/methods/list_incident_alerts' + insert: [] + update: [] + delete: [] + business_services_impacts: + id: pagerduty.incidents.business_services_impacts + name: business_services_impacts + title: Business Services Impacts + methods: + put_incident_manual_business_service_association: + operation: + $ref: '#/paths/~1incidents~1{id}~1business_services~1{business_service_id}~1impacts/put' + response: + mediaType: application/json + openAPIDocKey: '200' + get_incident_impacted_business_services: + operation: + $ref: '#/paths/~1incidents~1{id}~1business_services~1impacts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.services + _get_incident_impacted_business_services: + operation: + $ref: '#/paths/~1incidents~1{id}~1business_services~1impacts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/business_services_impacts/methods/get_incident_impacted_business_services' + insert: [] + update: [] + delete: [] + field_values: + id: pagerduty.incidents.field_values + name: field_values + title: Field Values + methods: + get_incident_field_values: + operation: + $ref: '#/paths/~1incidents~1{id}~1field_values/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.field_values + _get_incident_field_values: + operation: + $ref: '#/paths/~1incidents~1{id}~1field_values/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_incident_field_values: + operation: + $ref: '#/paths/~1incidents~1{id}~1field_values/put' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/field_values/methods/get_incident_field_values' + insert: [] + update: [] + delete: [] + field_values_schema: + id: pagerduty.incidents.field_values_schema + name: field_values_schema + title: Field Values Schema + methods: + get_schema_for_incident: + operation: + $ref: '#/paths/~1incidents~1{id}~1field_values~1schema/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.schema + _get_schema_for_incident: + operation: + $ref: '#/paths/~1incidents~1{id}~1field_values~1schema/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/field_values_schema/methods/get_schema_for_incident' + insert: [] + update: [] + delete: [] + log_entries: + id: pagerduty.incidents.log_entries + name: log_entries + title: Log Entries + methods: + list_incident_log_entries: + operation: + $ref: '#/paths/~1incidents~1{id}~1log_entries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.log_entries + _list_incident_log_entries: + operation: + $ref: '#/paths/~1incidents~1{id}~1log_entries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/log_entries/methods/list_incident_log_entries' + insert: [] + update: [] + delete: [] + notes: + id: pagerduty.incidents.notes + name: notes + title: Notes + methods: + list_incident_notes: + operation: + $ref: '#/paths/~1incidents~1{id}~1notes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.notes + _list_incident_notes: + operation: + $ref: '#/paths/~1incidents~1{id}~1notes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_incident_note: + operation: + $ref: '#/paths/~1incidents~1{id}~1notes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/notes/methods/list_incident_notes' + insert: + - $ref: '#/components/x-stackQL-resources/notes/methods/create_incident_note' + update: [] + delete: [] + outlier_incident: + id: pagerduty.incidents.outlier_incident + name: outlier_incident + title: Outlier Incident + methods: + get_outlier_incident: + operation: + $ref: '#/paths/~1incidents~1{id}~1outlier_incident/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.outlier_incident + _get_outlier_incident: + operation: + $ref: '#/paths/~1incidents~1{id}~1outlier_incident/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/outlier_incident/methods/get_outlier_incident' + insert: [] + update: [] + delete: [] + past_incidents: + id: pagerduty.incidents.past_incidents + name: past_incidents + title: Past Incidents + methods: + get_past_incidents: + operation: + $ref: '#/paths/~1incidents~1{id}~1past_incidents/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.past_incidents + _get_past_incidents: + operation: + $ref: '#/paths/~1incidents~1{id}~1past_incidents/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/past_incidents/methods/get_past_incidents' + insert: [] + update: [] + delete: [] + related_incidents: + id: pagerduty.incidents.related_incidents + name: related_incidents + title: Related Incidents + methods: + get_related_incidents: + operation: + $ref: '#/paths/~1incidents~1{id}~1related_incidents/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.related_incidents + _get_related_incidents: + operation: + $ref: '#/paths/~1incidents~1{id}~1related_incidents/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/related_incidents/methods/get_related_incidents' + insert: [] + update: [] + delete: [] + status_updates_subscribers: + id: pagerduty.incidents.status_updates_subscribers + name: status_updates_subscribers + title: Status Updates Subscribers + methods: + get_incident_notification_subscribers: + operation: + $ref: '#/paths/~1incidents~1{id}~1status_updates~1subscribers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.subscribers + _get_incident_notification_subscribers: + operation: + $ref: '#/paths/~1incidents~1{id}~1status_updates~1subscribers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_incident_notification_subscribers: + operation: + $ref: '#/paths/~1incidents~1{id}~1status_updates~1subscribers/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/status_updates_subscribers/methods/get_incident_notification_subscribers' + insert: + - $ref: '#/components/x-stackQL-resources/status_updates_subscribers/methods/create_incident_notification_subscribers' + update: [] + delete: [] +paths: + /incidents: + get: + x-pd-requires-scope: incidents.read + tags: + - Incidents + operationId: listIncidents + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents) + + Scoped OAuth requires: `incidents.read` + summary: List incidents + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/date_range' + - $ref: '#/components/parameters/incident_key' + - $ref: '#/components/parameters/incident_services' + - $ref: '#/components/parameters/team_ids' + - $ref: '#/components/parameters/incident_assigned_to_user' + - $ref: '#/components/parameters/incident_urgencies' + - $ref: '#/components/parameters/time_zone' + - $ref: '#/components/parameters/statuses_incidents' + - $ref: '#/components/parameters/sort_by_incidents' + - $ref: '#/components/parameters/include_incidents' + - $ref: '#/components/parameters/since_incidents' + - $ref: '#/components/parameters/until_incidents' + responses: + '200': + description: A paginated array of incidents. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + incidents: + type: array + items: + $ref: '#/components/schemas/Incident' + required: + - incidents + examples: + response: + summary: Response Example + value: + incidents: + - id: PT4KHLK + type: incident + summary: '[#1234] The server is on fire.' + self: 'https://api.pagerduty.com/incidents/PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK' + incident_number: 1234 + created_at: '2015-10-06T21:30:42Z' + status: resolved + title: The server is on fire. + incident_key: baf7cf21b1da41b4b0221008339ff357 + service: + id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + priority: + id: P53ZZH5 + type: priority_reference + summary: P2 + self: 'https://api.pagerduty.com/priorities/P53ZZH5' + assigned_via: escalation_policy + assignments: [] + acknowledgements: [] + last_status_change_at: '2015-10-06T21:38:23Z' + last_status_change_by: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + first_trigger_log_entry: + id: Q02JTSNZWHSEKV + type: trigger_log_entry_reference + summary: Triggered through the API + self: 'https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV' + escalation_policy: + id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + urgency: high + conference_bridge: + conference_number: '+1-415-555-1212,,,,1234#' + conference_url: 'https://example.com/acb-123' + limit: 1 + offset: 0 + more: true + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + x-pd-requires-scope: incidents.write + tags: + - Incidents + operationId: updateIncidents + description: | + 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). + + Note: the manage incidents API endpoint is rate limited to 500 requests per minute. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents) + + Scoped OAuth requires: `incidents.write` + summary: Manage incidents + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + incidents: + type: array + description: 'An array of incidents, including the parameters to update.' + items: + properties: + id: + type: string + description: The id of the incident to update. + type: + type: string + description: The incident type. + enum: + - incident + - incident_reference + status: + type: string + description: The new status of the incident. + enum: + - resolved + - acknowledged + resolution: + type: string + description: The resolution for this incident if status is set to resolved. + title: + type: string + description: 'A succinct description of the nature, symptoms, cause, or effect of the incident.' + priority: + $ref: '#/components/schemas/PriorityReference' + escalation_level: + type: integer + description: Escalate the incident to this level in the escalation policy. + assignments: + type: array + description: Assign the incident to these assignees. + items: + properties: + assignee: + $ref: '#/components/schemas/UserReference' + escalation_policy: + $ref: '#/components/schemas/EscalationPolicyReference' + conference_bridge: + $ref: '#/components/schemas/ConferenceBridge' + required: + - id + - type + required: + - incidents + examples: + incidents: + summary: Request Example + value: + incidents: + - id: PT4KHLK + type: incident_reference + status: acknowledged + - id: PQMF62U + type: incident_reference + priority: + id: P53ZZH5 + type: priority_reference + - id: PPVZH9X + type: incident_reference + status: resolved + - id: P8JOGX7 + type: incident_reference + assignments: + - assignee: + id: PXPGF42 + type: user_reference + responses: + '200': + description: All of the updates succeeded. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + incidents: + type: array + items: + $ref: '#/components/schemas/Incident' + required: + - incidents + examples: + response: + summary: Response Example + value: + incidents: + - id: PT4KHLK + type: incident + summary: '[#1234] The server is on fire.' + self: 'https://api.pagerduty.com/incidents/PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK' + incident_number: 1234 + created_at: '2015-10-06T21:30:42Z' + status: resolved + title: The server is on fire. + alert_counts: + all: 2 + triggered: 0 + resolved: 2 + pending_actions: + - type: unacknowledge + at: '2015-11-10T01:02:52Z' + - type: resolve + at: '2015-11-10T04:31:52Z' + incident_key: baf7cf21b1da41b4b0221008339ff357 + service: + id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + assigned_via: escalation_policy + assignments: + - at: '2015-11-10T00:31:52Z' + assignee: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + acknowledgements: + - at: '2015-11-10T00:32:52Z' + acknowledger: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + last_status_change_at: '2015-10-06T21:38:23Z' + last_status_change_by: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + first_trigger_log_entry: + id: Q02JTSNZWHSEKV + type: trigger_log_entry_reference + summary: Triggered through the API + self: 'https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV' + escalation_policy: + id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + urgency: high + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '413': + $ref: '#/components/responses/RequestEntityTooLarge' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + x-pd-requires-scope: incidents.write + tags: + - Incidents + operationId: createIncident + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents) + + Scoped OAuth requires: `incidents.write` + summary: Create an Incident + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + incident: + type: object + description: Details of the incident to be created. + properties: + type: + type: string + enum: + - incident + title: + type: string + description: 'A succinct description of the nature, symptoms, cause, or effect of the incident.' + service: + $ref: '#/components/schemas/ServiceReference' + priority: + $ref: '#/components/schemas/PriorityReference' + urgency: + type: string + description: The urgency of the incident + enum: + - high + - low + body: + $ref: '#/components/schemas/IncidentBody' + incident_key: + type: string + description: A string which identifies the incident. Sending subsequent requests referencing the same service and with the same incident_key will result in those requests being rejected if an open incident matches that incident_key. + assignments: + type: array + description: Assign the incident to these assignees. Cannot be specified if an escalation policy is given. + items: + properties: + assignee: + $ref: '#/components/schemas/UserReference' + escalation_policy: + $ref: '#/components/schemas/EscalationPolicyReference' + conference_bridge: + $ref: '#/components/schemas/ConferenceBridge' + required: + - type + - title + - service + required: + - incident + examples: + request: + summary: Request Example + value: + incident: + type: incident + title: The server is on fire. + service: + id: PWIXJZS + type: service_reference + priority: + id: P53ZZH5 + type: priority_reference + urgency: high + incident_key: baf7cf21b1da41b4b0221008339ff357 + body: + type: incident_body + details: 'A disk is getting full on this machine. You should investigate what is causing the disk to fill, and ensure that there is an automated process in place for ensuring data is rotated (eg. logs should have logrotate around them). If data is expected to stay on this disk forever, you should start planning to scale up to a larger disk.' + escalation_policy: + id: PT20YPA + type: escalation_policy_reference + responses: + '201': + description: The incident object created. + content: + application/json: + schema: + type: object + properties: + incident: + $ref: '#/components/schemas/Incident' + required: + - incident + examples: + response: + summary: Response Example + value: + incident: + id: PT4KHLK + type: incident + title: The server is on fire. + summary: '[#1234] The server is on fire.' + self: 'https://api.pagerduty.com/incidents/PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK' + incident_number: 1234 + created_at: '2015-10-06T21:30:42Z' + status: triggered + incident_key: baf7cf21b1da41b4b0221008339ff357 + service: + id: PWIXJZS + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PWIXJZS' + html_url: 'https://subdomain.pagerduty.com/services/PWIXJZS' + priority: + id: P53ZZH5 + type: priority_reference + summary: P2 + self: 'https://api.pagerduty.com/priorities/P53ZZH5' + assigned_via: escalation_policy + assignments: + - at: '2015-11-10T00:31:52Z' + assignee: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + last_status_change_at: '2015-10-06T21:38:23Z' + last_status_change_by: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + first_trigger_log_entry: + id: Q02JTSNZWHSEKV + type: trigger_log_entry_reference + summary: Triggered through the API + self: 'https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV' + escalation_policy: + id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + urgency: high + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/incidents/{id}': + get: + x-pd-requires-scope: incidents.read + tags: + - Incidents + operationId: getIncident + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents) + + + > ### Early Access + > The `include[]=field_values` part of this endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + + Scoped OAuth requires: `incidents.read` + summary: Get an incident + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/include_incident' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '200': + description: The incident requested. + content: + application/json: + schema: + type: object + properties: + incident: + $ref: '#/components/schemas/Incident' + required: + - incident + examples: + response: + summary: Response Example + value: + incident: + id: PT4KHLK + type: incident + summary: '[#1234] The server is on fire.' + self: 'https://api.pagerduty.com/incidents/PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK' + incident_number: 1234 + created_at: '2015-10-06T21:30:42Z' + status: acknowledged + title: The server is on fire. + alert_counts: + all: 2 + triggered: 1 + resolved: 1 + pending_actions: + - type: unacknowledge + at: '2015-11-10T01:02:52Z' + - type: resolve + at: '2015-11-10T04:31:52Z' + incident_key: baf7cf21b1da41b4b0221008339ff357 + service: + id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + priority: + id: P53ZZH5 + type: priority_reference + summary: P2 + self: 'https://api.pagerduty.com/priorities/P53ZZH5' + assigned_via: escalation_policy + assignments: + - at: '2015-11-10T00:31:52Z' + assignee: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + acknowledgements: + - at: '2015-11-10T00:32:52Z' + acknowledger: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + last_status_change_at: '2015-10-06T21:38:23Z' + last_status_change_by: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + first_trigger_log_entry: + id: Q02JTSNZWHSEKV + type: trigger_log_entry_reference + summary: Triggered through the API + self: 'https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV' + escalation_policy: + id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + urgency: high + responder_requests: + - incident: + id: PXP12GZ + type: incident_reference + summary: Ongoing Incident in Mailroom + self: 'https://api.pagerduty.com/incidents/PXP12GZ' + html_url: 'https://subdomain.pagerduty.com/incidents/PXP12GZ' + requester: + id: P09TT3C + type: user_reference + summary: Jane Doe + self: 'https://api.pagerduty.com/users/P09TT3C' + html_url: 'https://subdomain.pagerduty.com/users/P09TT3C' + requested_at: '2018-08-16T14:55:17-07:00' + message: Please help with issue - join bridge at +1(234)-567-8910 + responder_request_targets: + - responder_request_target: + type: user + id: PL7A2O4 + incidents_responders: + - state: pending + user: + id: PL7A2O4 + type: user_reference + summary: Lee Turner + self: 'https://api.pagerduty.com/users/PL7A2O4' + html_url: 'https://subdomain.pagerduty.com/users/PL7A2O4' + avatar_url: 'https://secure.gravatar.com/avatar/51c673f51f6b483b24c889bbafbd2a67.png?d=mm&r=PG' + incident: + id: PXP12GZ + type: incident_reference + summary: Ongoing Incident in Mailroom + self: 'https://api.pagerduty.com/incidents/PXP12GZ' + html_url: 'https://subdomain.pagerduty.com/incidents/PXP12GZ' + updated_at: '2018-08-09T14:40:48-07:00' + message: Please help with issue - join bridge at +1(234)-567-8910 + requester: + id: P09TT3C + type: user_reference + summary: Jane Doe + self: 'https://api.pagerduty.com/users/P09TT3C' + html_url: 'https://subdomain.pagerduty.com/users/P09TT3C' + avatar_url: 'https://secure.gravatar.com/avatar/1c747247b75acc1f724e2784c838b3f8.png?d=mm&r=PG' + requested_at: '2018-08-09T21:40:49Z' + incidents_responders: + - state: pending + user: + id: PL7A2O4 + type: user_reference + summary: Lee Turner + self: 'https://api.pagerduty.com/users/PL7A2O4' + html_url: 'https://subdomain.pagerduty.com/users/PL7A2O4' + avatar_url: 'https://secure.gravatar.com/avatar/51c673f51f6b483b24c889bbafbd2a67.png?d=mm&r=PG' + incident: + id: PXP12GZ + type: incident_reference + summary: Ongoing Incident in Mailroom + self: 'https://api.pagerduty.com/incidents/PXP12GZ' + html_url: 'https://subdomain.pagerduty.com/incidents/PXP12GZ' + updated_at: '2018-08-09T14:40:48-07:00' + message: Please help with issue - join bridge at +1(234)-567-8910 + requester: + id: P09TT3C + type: user_reference + summary: Jane Doe + self: 'https://api.pagerduty.com/users/P09TT3C' + html_url: 'https://subdomain.pagerduty.com/users/P09TT3C' + avatar_url: 'https://secure.gravatar.com/avatar/1c747247b75acc1f724e2784c838b3f8.png?d=mm&r=PG' + requested_at: '2018-08-09T21:40:49Z' + field_values: + - id: PT4KHEE + type: field_value + name: environment + display_name: Runtime Environment + description: environment where incident occurred + fixed_options: true + datatype: string + multi_value: false + value: production + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + x-pd-requires-scope: incidents.write + tags: + - Incidents + operationId: updateIncident + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents) + + Scoped OAuth requires: `incidents.write` + summary: Update an incident + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + incident: + type: object + description: The parameters of the incident to update. + properties: + type: + type: string + description: The incident type. + enum: + - incident + - incident_reference + status: + type: string + description: The new status of the incident. + enum: + - resolved + - acknowledged + priority: + $ref: '#/components/schemas/PriorityReference' + resolution: + type: string + description: The resolution for this incident if status is set to resolved. + title: + type: string + description: The new title of the incident. + escalation_level: + type: integer + description: Escalate the incident to this level in the escalation policy. + assignments: + type: array + description: Assign the incident to these assignees. + items: + properties: + assignee: + $ref: '#/components/schemas/UserReference' + escalation_policy: + $ref: '#/components/schemas/EscalationPolicyReference' + urgency: + type: string + description: The urgency of the incident. + enum: + - high + - low + conference_bridge: + $ref: '#/components/schemas/ConferenceBridge' + required: + - type + required: + - incident + examples: + request: + summary: Request Example + value: + incident: + type: incident_reference + status: acknowledged + responses: + '200': + description: The incident was updated. + content: + application/json: + schema: + allOf: + - type: object + properties: + incident: + $ref: '#/components/schemas/Incident' + required: + - incident + examples: + response: + summary: Response Example + value: + incident: + id: PT4KHLK + type: incident + summary: '[#1234] The server is on fire.' + self: 'https://api.pagerduty.com/incidents/PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK' + incident_number: 1234 + created_at: '2015-10-06T21:30:42Z' + status: resolved + title: The server is on fire. + pending_actions: + - type: unacknowledge + at: '2015-11-10T01:02:52Z' + - type: resolve + at: '2015-11-10T04:31:52Z' + incident_key: baf7cf21b1da41b4b0221008339ff357 + service: + id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + priority: + id: P53ZZH5 + type: priority_reference + summary: P2 + self: 'https://api.pagerduty.com/priorities/P53ZZH5' + assigned_via: escalation_policy + assignments: + - at: '2015-11-10T00:31:52Z' + assignee: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + acknowledgements: + - at: '2015-11-10T00:32:52Z' + acknowledger: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + last_status_change_at: '2015-10-06T21:38:23Z' + last_status_change_by: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + first_trigger_log_entry: + id: Q02JTSNZWHSEKV + type: trigger_log_entry_reference + summary: Triggered through the API + self: 'https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV' + escalation_policy: + id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + urgency: high + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/incidents/{id}/alerts': + get: + x-pd-requires-scope: incidents.read + tags: + - Incidents + operationId: listIncidentAlerts + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents) + + Scoped OAuth requires: `incidents.read` + summary: List alerts for an incident + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/alert_key' + - $ref: '#/components/parameters/statuses_incident_alerts' + - $ref: '#/components/parameters/sort_by_incident_alerts' + - $ref: '#/components/parameters/include_incident_alerts' + responses: + '200': + description: A paginated array of the incident's alerts. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + alerts: + type: array + items: + $ref: '#/components/schemas/Alert' + required: + - alerts + examples: + response: + summary: Response Example + value: + alerts: + - id: PT4KHLK + type: alert + summary: The server is on fire. + self: 'https://api.pagerduty.com/incidents/PT4KHLK/alerts/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/alerts/PXPGF42' + created_at: '2015-10-06T21:30:42Z' + status: resolved + alert_key: baf7cf21b1da41b4b0221008339ff357 + service: + id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + body: + type: alert_body + contexts: + - type: link + details: + customKey: Server is on fire! + customKey2: Other stuff! + incident: + id: PT4KHLK + type: incident_reference + suppressed: false + severity: critical + integration: + id: PQ12345 + type: generic_email_inbound_integration_reference + summary: Email Integration + self: 'https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345' + limit: 1 + offset: 0 + more: true + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + x-pd-requires-scope: incidents.write + tags: + - Incidents + operationId: updateIncidentAlerts + description: | + 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 500 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents) + + Scoped OAuth requires: `incidents.write` + summary: Manage alerts + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + alerts: + type: array + description: 'An array of alerts, including the parameters to update for each alert.' + items: + $ref: '#/components/schemas/Alert' + required: + - alerts + examples: + request: + summary: Request Example + value: + alerts: + - id: PPVZH9X + type: alert + status: resolved + - id: P8JOGX7 + type: alert + incident: + id: PPVZH9X + type: incident_reference + responses: + '200': + description: All of the updates succeeded. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + alerts: + type: array + items: + $ref: '#/components/schemas/Alert' + required: + - alerts + examples: + response: + summary: Response Example + value: + alerts: + - id: PT4KHLK + type: alert + summary: The server is on fire. + self: 'https://api.pagerduty.com/incidents/PT4KHLK/alerts/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/alerts/PXPGF42' + created_at: '2015-10-06T21:30:42Z' + status: resolved + alert_key: baf7cf21b1da41b4b0221008339ff357 + service: + id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + body: + type: alert_body + contexts: + - type: link + details: + customKey: Server is on fire! + customKey2: Other stuff! + incident: + id: PPVZH9X + type: incident_reference + suppressed: false + severity: critical + limit: 1 + offset: 0 + more: true + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '413': + $ref: '#/components/responses/RequestEntityTooLarge' + '429': + $ref: '#/components/responses/TooManyRequests' + '/incidents/{id}/alerts/{alert_id}': + get: + x-pd-requires-scope: incidents.read + tags: + - Incidents + operationId: getIncidentAlert + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents) + + Scoped OAuth requires: `incidents.read` + summary: Get an alert + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/alert_id' + responses: + '200': + description: The alert requested. + content: + application/json: + schema: + type: object + properties: + alert: + $ref: '#/components/schemas/Alert' + required: + - alert + examples: + response: + summary: Response Example + value: + alert: + id: PT4KHLK + type: alert + summary: The server is on fire. + self: 'https://api.pagerduty.com/incident/PT4KHLX/alerts/PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/alerts/PT4KHLK' + created_at: '2015-10-06T21:30:42Z' + status: resolved + alert_key: baf7cf21b1da41b4b0221008339ff357 + service: + id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + incident: + id: PT4KHLX + type: incident_reference + summary: '[#1234] The server is on fire.' + self: 'https://api.pagerduty.com/incidents/PT4KHLX' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLX' + suppressed: false + severity: critical + integration: + id: PQ12345 + type: generic_email_inbound_integration_reference + summary: Email Integration + self: 'https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + x-pd-requires-scope: incidents.write + tags: + - Incidents + operationId: updateIncidentAlert + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents) + + Scoped OAuth requires: `incidents.write` + summary: Update an alert + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/alert_id' + - $ref: '#/components/parameters/from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + alert: + $ref: '#/components/schemas/Alert' + required: + - alert + examples: + request: + summary: Request Example + value: + alert: + type: alert + status: resolved + incident: + id: PEYSGVF + type: incident_reference + body: + type: alert_body + contexts: + - type: link + details: + customKey: Server is on fire! + customKey2: Other stuff! + description: The parameters of the alert to update. + responses: + '200': + description: The alert that was updated. + content: + application/json: + schema: + type: object + properties: + alert: + $ref: '#/components/schemas/Alert' + required: + - alert + examples: + request: + summary: Request Example + value: + alert: + type: alert + status: resolved + incident: + id: PEYSGVF + type: incident_reference + body: + type: alert_body + contexts: + - type: link + details: + customKey: Server is on fire! + customKey2: Other stuff! + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/incidents/{id}/business_services/{business_service_id}/impacts': + put: + summary: Manually change an Incident's Impact on a Business Service. + tags: + - Incidents + responses: + '200': + description: OK + content: + application/json: + schema: + description: '' + type: object + properties: + relation: + type: string + enum: + - impacted + - not_impacted + examples: + response: + summary: Response Example + value: + relation: impacted + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '429': + $ref: '#/components/responses/TooManyRequests' + operationId: putIncidentManualBusinessServiceAssociation + description: |- + Change Impact of an Incident on a Business Service. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/business_service_id' + - $ref: '#/components/parameters/early_access_bis' + requestBody: + content: + application/json: + schema: + description: '' + type: object + properties: + relation: + type: string + enum: + - impacted + - not_impacted + required: + - relation + description: |- + The `impacted` relation will cause the Business Service and any Services that it supports to become impacted by this incident. + + The `not_impacted` relation will remove the Incident's Impact from the specified Business Service. + + The effect of adding or removing Impact to a Business Service in this way will also change the propagation of Impact to other Services supported by that Business Service. + '/incidents/{id}/business_services/impacts': + get: + summary: List Business Services impacted by the given Incident + tags: + - Incidents + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/CursorPagination' + - type: object + properties: + services: + type: array + items: + $ref: '#/components/schemas/Impact' + examples: + response: + summary: Response Example + value: + limit: 100 + next_cursor: null + services: + - id: PD1234 + name: Web API + type: business_service + status: impacted + - id: PF9KMXH + name: Analytics Backend + type: business_service + status: impacted + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '429': + $ref: '#/components/responses/TooManyRequests' + operationId: getIncidentImpactedBusinessServices + description: |- + Retrieve a list of Business Services that are being impacted by the given Incident. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/early_access_bis' + '/incidents/{id}/field_values': + get: + tags: + - Incidents + operationId: getIncidentFieldValues + description: | + Get field values for an incident + + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Get Incident Field Values + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '200': + description: The list of field values + content: + application/json: + schema: + type: object + properties: + field_values: + type: array + items: + $ref: '#/components/schemas/CustomFieldsFieldValue' + required: + - field_values + examples: + response: + summary: Response Example + value: + field_values: + - id: PT4KHEE + type: field_value + name: environment + display_name: Runtime Environment + description: environment where incident occurred + fixed_options: true + datatype: string + multi_value: false + value: production + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + put: + tags: + - Incidents + operationId: setIncidentFieldValues + description: | + Set field values for an incident + + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Set Incident Field Values + parameters: + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + field_values: + type: array + items: + $ref: '#/components/schemas/CustomFieldsEditableFieldValue' + required: + - field_values + examples: + request: + summary: Request Example + value: + field_values: + - name: environment + value: production + responses: + '201': + description: Field values were updated + content: + application/json: + schema: + type: object + properties: + field_values: + type: array + items: + $ref: '#/components/schemas/CustomFieldsFieldValue' + required: + - field_values + examples: + response: + summary: Response Example + value: + field_values: + - id: PT4KHEE + type: field_value + name: environment + display_name: Runtime Environment + description: environment where incident occurred + fixed_options: true + datatype: string + multi_value: false + value: production + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + '/incidents/{id}/field_values/schema': + get: + tags: + - Incidents + operationId: getSchemaForIncident + description: | + Get detailed information about a Schema for an incident. + + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + summary: Get Incident's Schema + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/include_customfields_incident_schema' + - $ref: '#/components/parameters/early_access_customfields' + responses: + '200': + description: The schema requested. + content: + application/json: + schema: + type: object + properties: + schema: + $ref: '#/components/schemas/CustomFieldsIncidentSchema' + required: + - schema + examples: + response1: + summary: 'Example: No query parameters' + value: + schema: + id: PT20YPA + type: schema + self: 'https://api.pagerduty.com/customfields/schemas/PT20YPA' + summary: Security Incident + title: Security Incident + description: Default schema to use for security incidents + field_configurations: + - id: PT4KHEE + type: field_configuration + field: + id: PT4KZZZ + type: field + self: 'https://api.pagerduty.com/customfields/fields/PT4KZZZ' + summary: environment + name: environment + display_name: Environment + description: null + datatype: string + multi_value: true + fixed_options: true + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + required: true + default_value: + datatype: string + multi_value: true + value: + - prod + - stg + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + response2: + summary: 'Example: Using include[]=field_options' + value: + schema: + id: PT20YPA + type: schema + self: 'https://api.pagerduty.com/customfields/schemas/PT20YPA' + summary: Security Incident + title: Security Incident + description: Default schema to use for security incidents' + field_configurations: + - id: PT4KHEE + type: field_configuration + field: + id: PT4KZZZ + type: field + self: 'https://api.pagerduty.com/customfields/fields/PT4KZZZ' + summary: environment + name: environment + display_name: Environment + description: null + datatype: string + multi_value: true + fixed_options: true + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-07-01T21:30:42Z' + field_options: + - id: PT4KHEE + type: field_option + data: + datatype: string + value: + - prod + - stg + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + required: true + default_value: + datatype: string + multi_value: true + value: + - prod + - stg + created_at: '2021-06-01T21:30:42Z' + updated_at: '2021-06-01T21:30:42Z' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + '/incidents/{id}/log_entries': + get: + x-pd-requires-scope: incidents.read + tags: + - Incidents + operationId: listIncidentLogEntries + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents) + + Scoped OAuth requires: `incidents.read` + summary: List log entries for an incident + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/time_zone' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/until' + - $ref: '#/components/parameters/log_entry_is_overview' + - $ref: '#/components/parameters/include_log_entry' + responses: + '200': + description: A paginated array of the incident's log entries. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + log_entries: + type: array + items: + oneOf: + - $ref: '#/components/schemas/AcknowledgeLogEntry' + - $ref: '#/components/schemas/AnnotateLogEntry' + - $ref: '#/components/schemas/AssignLogEntry' + - $ref: '#/components/schemas/DelegateLogEntry' + - $ref: '#/components/schemas/EscalateLogEntry' + - $ref: '#/components/schemas/ExhaustEscalationPathLogEntry' + - $ref: '#/components/schemas/NotifyLogEntry' + - $ref: '#/components/schemas/ReachAckLimitLogEntry' + - $ref: '#/components/schemas/ReachTriggerLimitLogEntry' + - $ref: '#/components/schemas/RepeatEscalationPathLogEntry' + - $ref: '#/components/schemas/ResolveLogEntry' + - $ref: '#/components/schemas/SnoozeLogEntry' + - $ref: '#/components/schemas/TriggerLogEntry' + - $ref: '#/components/schemas/UnacknowledgeLogEntry' + - $ref: '#/components/schemas/UrgencyChangeLogEntry' + required: + - log_entries + examples: + response: + summary: Response Example + value: + log_entries: + - id: Q02JTSNZWHSEKV + type: trigger_log_entry + summary: Triggered through the API + self: 'https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV' + created_at: '2015-11-07T00:14:20Z' + agent: + id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + channel: + type: api + incident: + id: PT4KHLK + type: incident_reference + summary: '[#1234] The server is on fire.' + self: 'https://api.pagerduty.com/incidents/PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + contexts: [] + event_details: + description: 'Tasks::SFDCValidator - PD_Data__c - duplicates' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/incidents/{id}/merge': + put: + tags: + - Incidents + x-pd-requires-scope: incidents.write + operationId: mergeIncidents + description: | + Merge a list of source incidents into this incident. + + An incident represents a problem or an issue that needs to be addressed and resolved. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents) + + Scoped OAuth requires: `incidents.write` + summary: Merge incidents + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + source_incidents: + type: array + description: The source incidents that will be merged into the target incident and resolved. + items: + $ref: '#/components/schemas/IncidentReference' + required: + - source_incidents + examples: + request: + summary: Request Example + value: + source_incidents: + - id: P8JOGX7 + type: incident_reference + - id: PPVZH9X + type: incident_reference + responses: + '200': + description: 'The target incident, which now contains all the alerts from the source incident.' + content: + application/json: + schema: + type: object + properties: + incident: + $ref: '#/components/schemas/IncidentReference' + required: + - incident + examples: + response: + summary: Response Example + value: + incident: + id: PT4KHLK + type: incident_reference + summary: '[#1234] The server is on fire.' + self: 'https://api.pagerduty.com/incidents/PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/incidents/{id}/notes': + get: + x-pd-requires-scope: incidents.read + tags: + - Incidents + operationId: listIncidentNotes + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents) + + Scoped OAuth requires: `incidents.read` + summary: List notes for an incident + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: An array of notes. + content: + application/json: + schema: + type: object + properties: + notes: + type: array + items: + $ref: '#/components/schemas/IncidentNote' + required: + - notes + examples: + response: + summary: Response Example + value: + notes: + - id: PWL7QXS + user: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + channel: + summary: The PagerDuty website or APIs + content: Firefighters are on the scene. + created_at: '2013-03-06T15:28:51-05:00' + - id: PCQC25 + user: + id: PXPGF42 + type: bot_user_reference + summary: A Global Event Rule + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/event-rules/global/0e84de00-9511-4380-9f4f-a7b568bb49a0/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b' + channel: + id: 14e56445-ebab-4dd0-ba9d-fc28a41b7e7b + type: event_rule_reference + summary: A Global Event Rule + self: 'https://api.pagerduty.com/rulesets/0e84de00-9511-4380-9f4f-a7b568bb49a0/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b' + html_url: 'https://subdomain.pagerduty.com/event-rules/global/0e84de00-9511-4380-9f4f-a7b568bb49a0/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b' + content: Initial alert information indicates a 1-alarm fire + created_at: '2013-03-06T15:28:42-05:00' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + tags: + - Incidents + x-pd-requires-scope: incidents.write + operationId: createIncidentNote + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents) + + Scoped OAuth requires: `incidents.write` + summary: Create a note on an incident + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + note: + type: object + properties: + content: + type: string + description: The note content + required: + - content + required: + - note + examples: + request: + summary: Request Example + value: + note: + content: Firefighters are on the scene. + responses: + '200': + description: The new note. + content: + application/json: + schema: + type: object + properties: + note: + $ref: '#/components/schemas/IncidentNote' + required: + - note + examples: + response: + summary: Response Example + value: + note: + id: PWL7QXS + user: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + channel: + summary: The PagerDuty website or APIs + content: Firefighters are on the scene. + created_at: '2013-03-06T15:28:51-05:00' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/incidents/{id}/outlier_incident': + get: + x-pd-requires-scope: incidents.read + tags: + - Incidents + operationId: getOutlierIncident + description: | + Gets Outlier Incident information for a given Incident on its Service. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#outlier-incident) + + Scoped OAuth requires: `incidents.read` + summary: Get Outlier Incident + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/additional_details' + responses: + '200': + description: Outlier Incident information calculated over the same Service as the given Incident. + content: + application/json: + schema: + description: '' + type: object + properties: + outlier_incident: + type: object + description: Outlier Incident information calculated over the same Service as the given Incident. + properties: + incident: + $ref: '#/components/schemas/Incident' + incident_template: + type: object + properties: + id: + type: string + readOnly: true + cluster_id: + type: string + readOnly: true + description: The cluster the Incident Template pattern belongs to + mined_text: + type: string + readOnly: true + description: The Incident Template mined pattern text + examples: + response: + summary: Response Example + value: + outlier_incident: + incident: + id: PR2P3RW + created_at: '2020-11-18T13:08:14Z' + self: 'https://api.pagerduty.com/incidents/PR2P3RW' + title: '[LINUX]Used disk space is more than 5 GB on volume /var/log : PROBLEM for ce51323' + occurrence: + count: 10 + frequency: 0.04 + category: rare + since: '2020-09-23T13:08:14Z' + until: '2021-01-18T13:08:14Z' + incident_template: + id: PX3P1PX + cluster_id: P2B3X5 + mined_text: '[LINUX]Used disk space is more than on volume <*> : PROBLEM for <*>' + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '/incidents/{id}/past_incidents': + get: + x-pd-requires-scope: incidents.read + summary: Get Past Incidents + tags: + - Incidents + responses: + '200': + description: OK + content: + application/json: + schema: + description: '' + type: object + properties: + past_incidents: + type: array + description: Aggregate of past incidents + items: + type: object + properties: + incident: + type: object + description: Incident model reference + properties: + id: + type: string + description: The globally unique identifier of the incident + created_at: + type: string + description: The date/time the incident was first triggered + self: + type: string + description: The URL at which the object is accessible + title: + type: string + description: 'The description of the nature, symptoms, cause, or effect of the incident' + score: + type: number + description: 'The computed similarity score associated with the incident and parent incident ' + total: + type: number + description: The total number of Past Incidents if the total parameter was set in the request + limit: + type: number + description: The maximum number of Incidents requested + examples: + response: + summary: Response Example + value: + past_incidents: + - incident: + id: PFBE9I2 + created_at: '2020-11-04T16:08:15Z' + self: 'https://api.pagerduty.com/incidents/PFBE9I2' + title: Things are so broken! + score: 46.8249 + - incident: + id: P1J6V6M + created_at: '2020-10-22T17:18:14Z' + self: 'https://api.pagerduty.com/incidents/P1J6V6M' + title: Things are so broken! + score: 46.8249 + - incident: + id: P6HPX5N + created_at: '2020-10-06T22:01:13Z' + self: 'https://api.pagerduty.com/incidents/P6HPX5N' + title: You forgot to feed the cat! + score: 0 + total: 3 + limit: 5 + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + operationId: getPastIncidents + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#past_incidents) + + Scoped OAuth requires: `incidents.read` + '/incidents/{id}/related_incidents': + get: + x-pd-requires-scope: incidents.read + tags: + - Incidents + operationId: getRelatedIncidents + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#related_incidents) + + Scoped OAuth requires: `incidents.read` + summary: Get Related Incidents + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/additional_details' + responses: + '200': + description: A list of Related Incidents and their relationships. + content: + application/json: + schema: + description: '' + type: object + properties: + related_incidents: + type: array + description: A list of Related Incidents and their relationships. + items: + type: object + properties: + incident_details: + $ref: '#/components/schemas/Incident' + description: Details of the incident. + relationship_details: + type: array + description: A list of reasons for why the Incident is considered related. + items: + type: object + properties: + relationship_type: + type: string + description: The type of relationship. A relationship outlines the reason why two Incidents are considered related. + relationship_metadata: + description: Metadata associated with the relationship. + anyOf: + - $ref: '#/components/schemas/RelatedIncidentMachineLearningRelationship' + - $ref: '#/components/schemas/RelatedIncidentServiceDependencyRelationship' + examples: + response: + summary: Response Example + value: + related_incidents: + - incident: + id: PR2P3RW + created_at: '2020-11-18T13:08:14Z' + self: 'https://api.pagerduty.com/incidents/PR2P3RW' + title: The server is on fire. + relationships: + - type: machine_learning_inferred + metadata: + grouping_classification: similar_contents + user_feedback: + positive_feedback_count: 12 + negative_feedback_count: 3 + - type: service_dependency + metadata: + dependent_services: + id: P1L1YEE + type: business_service_reference + self: 'https://api.pagerduty.com/business_services/P1L1YEE' + supporting_services: + id: PNGCNV2 + type: technical_service_reference + self: 'https://api.pagerduty.com/services/PNGCNV2' + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '/incidents/{id}/responder_requests': + post: + x-pd-requires-scope: incidents.write + tags: + - Incidents + operationId: createIncidentResponderRequest + description: | + Send a new responder request 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents) + + Scoped OAuth requires: `incidents.write` + summary: Create a responder request for an incident + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + requester_id: + type: string + description: The user id of the requester. + message: + type: string + description: The message sent with the responder request. + responder_request_targets: + description: The array of targets the responder request is sent to. + items: + $ref: '#/components/schemas/ResponderRequestTargetReference' + required: + - requester_id + - message + - responder_request_targets + examples: + request: + summary: Request Example + value: + requester_id: PL1JMK5 + message: Please help with issue - join bridge at +1(234)-567-8910 + responder_request_targets: + - responder_request_target: + id: PJ25ZYX + type: user_reference + responses: + '200': + description: The new responder request for the given incident. + content: + application/json: + schema: + type: object + properties: + responder_request: + $ref: '#/components/schemas/ResponderRequest' + required: + - responder_request + examples: + response: + summary: Response Example + value: + responder_request: + incident: + id: PXP12GZ + type: incident_reference + summary: Ongoing Incident in Mailroom + self: 'https://api.pagerduty.com/incidents/PXP12GZ' + html_url: 'https://subdomain.pagerduty.com/incidents/PXP12GZ' + requester: + id: P09TT3C + type: user_reference + summary: Jane Doe + self: 'https://api.pagerduty.com/users/P09TT3C' + html_url: 'https://subdomain.pagerduty.com/users/P09TT3C' + requested_at: '2018-08-16T14:55:17-07:00' + message: Please help with issue - join bridge at +1(234)-567-8910 + responder_request_targets: + - responder_request_target: + type: user + id: PL7A2O4 + incidents_responders: + - state: pending + user: + id: PL7A2O4 + type: user_reference + summary: Lee Turner + self: 'https://api.pagerduty.com/users/PL7A2O4' + html_url: 'https://subdomain.pagerduty.com/users/PL7A2O4' + avatar_url: 'https://secure.gravatar.com/avatar/51c673f51f6b483b24c889bbafbd2a67.png?d=mm&r=PG' + incident: + id: PXP12GZ + type: incident_reference + summary: Ongoing Incident in Mailroom + self: 'https://api.pagerduty.com/incidents/PXP12GZ' + html_url: 'https://subdomain.pagerduty.com/incidents/PXP12GZ' + updated_at: '2018-08-09T14:40:48-07:00' + message: Please help with issue - join bridge at +1(234)-567-8910 + requester: + id: P09TT3C + type: user_reference + summary: Jane Doe + self: 'https://api.pagerduty.com/users/P09TT3C' + html_url: 'https://subdomain.pagerduty.com/users/P09TT3C' + avatar_url: 'https://secure.gravatar.com/avatar/1c747247b75acc1f724e2784c838b3f8.png?d=mm&r=PG' + requested_at: '2018-08-09T21:40:49Z' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/incidents/{id}/snooze': + post: + tags: + - Incidents + x-pd-requires-scope: incidents.write + operationId: createIncidentSnooze + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents) + + Scoped OAuth requires: `incidents.write` + summary: Snooze an incident + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + duration: + type: integer + description: 'The number of seconds to snooze the incident for. After this number of seconds has elapsed, the incident will return to the "triggered" state.' + required: + - duration + examples: + request: + summary: Request Example + value: + duration: 3600 + responses: + '201': + description: The incident that was successfully snoozed. + content: + application/json: + schema: + type: object + properties: + incident: + $ref: '#/components/schemas/Incident' + required: + - incident + examples: + response: + summary: Response Example + value: + incident: + id: PT4KHLK + type: incident + summary: '[#1234] The server is on fire.' + self: 'https://api.pagerduty.com/incidents/PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK' + incident_number: 1234 + created_at: '2015-10-06T21:30:42Z' + status: resolved + pending_actions: + - type: unacknowledge + at: '2015-11-10T01:02:52Z' + - type: resolve + at: '2015-11-10T04:31:52Z' + incident_key: baf7cf21b1da41b4b0221008339ff357 + service: + id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + assigned_via: escalation_policy + assignments: + - at: '2015-11-10T00:31:52Z' + assignee: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + acknowledgements: + - at: '2015-11-10T00:32:52Z' + acknowledger: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + last_status_change_at: '2015-10-06T21:38:23Z' + last_status_change_by: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + first_trigger_log_entry: + id: Q02JTSNZWHSEKV + type: trigger_log_entry_reference + summary: Triggered through the API + self: 'https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV' + escalation_policy: + id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + urgency: high + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/incidents/{id}/status_updates': + post: + x-pd-requires-scope: incidents.write + tags: + - Incidents + operationId: createIncidentStatusUpdate + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents) + + Scoped OAuth requires: `incidents.write` + summary: Create a status update on an incident + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: The message to be posted as a status update. + subject: + type: string + description: The subject to be sent for the custom html email status update. Required if sending custom html email. + html_message: + type: string + description: The html content to be sent for the custom html email status update. Required if sending custom html email. + required: + - message + examples: + request: + summary: Request Example + value: + message: The server fire is spreading. + subject: Server Fire Update + html_message:

Server is still on fire

+ responses: + '200': + description: The new status update for the specified incident. + content: + application/json: + schema: + type: object + properties: + status_update: + $ref: '#/components/schemas/StatusUpdate' + required: + - status_update + examples: + response: + summary: Response Example + value: + status_update: + id: PWL7QXS + message: The server fire is spreading. + sender: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + created_at: '2013-03-06T15:28:51-05:00' + html_message:

Server is still on fire

+ subject: Server Fire Update + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/incidents/{id}/status_updates/subscribers': + get: + x-pd-requires-scope: subscribers.read + summary: List Notification Subscribers + tags: + - Incidents + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + subscribers: + type: array + items: + $ref: '#/components/schemas/NotificationSubscriberWithContext' + - type: object + properties: + account_id: + type: string + description: The ID of the account belonging to the subscriber entity + examples: + response: + summary: Response Example + value: + limit: 100 + more: false + offset: 0 + subscribers: + - subscriber_id: PD1234 + subscriber_type: user + has_indirect_subscription: false + subscribed_via: null + - subscriber_id: PD1234 + subscriber_type: team + has_indirect_subscription: true + subscribed_via: + - id: PD1234 + type: business_service + account_id: PD1234 + total: 2 + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '429': + $ref: '#/components/responses/TooManyRequests' + operationId: getIncidentNotificationSubscribers + description: | + Retrieve a list of Notification Subscribers on the Incident. + + + > Users must be added through `POST /incident/{id}/status_updates/subscribers` to be returned from this endpoint. + Scoped OAuth requires: `subscribers.read` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + post: + x-pd-requires-scope: subscribers.write + summary: Add Notification Subscribers + operationId: createIncidentNotificationSubscribers + tags: + - Incidents + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + subscriptions: + type: array + items: + $ref: '#/components/schemas/NotificationSubscriptionWithContext' + examples: + response: + summary: Response Example + value: + subscriptions: + - account_id: PD1234 + subscribable_id: PD1234 + subscribable_type: incident + subscriber_id: PD1234 + subscriber_type: user + result: success + - account_id: PD1234 + subscribable_id: PD1234 + subscribable_type: incident + subscriber_id: PD1234 + subscriber_type: team + result: duplicate + - account_id: PD1234 + subscribable_id: PD1235 + subscribable_type: incident + subscriber_id: PD1234 + subscriber_type: team + result: unauthorized + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + description: | + Subscribe the given entities to Incident Status Update Notifications. + + Scoped OAuth requires: `subscribers.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + subscribers: + type: array + uniqueItems: true + minItems: 1 + items: + $ref: '#/components/schemas/NotificationSubscriber' + required: + - subscribers + examples: + request: + summary: Request Example + value: + subscribers: + - subscriber_id: PD1234 + subscriber_type: team + - subscriber_id: PD1235 + subscriber_type: team + - subscriber_id: PD1234 + subscriber_type: user + description: The entities to subscribe. + '/incidents/{id}/status_updates/unsubscribe': + post: + x-pd-requires-scope: subscribers.write + summary: Remove Notification Subscriber + tags: + - Incidents + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + deleted_count: + type: number + unauthorized_count: + type: number + non_existent_count: + type: number + required: + - deleted_count + - unauthorized_count + - non_existent_count + examples: + response: + summary: Response Example + value: + deleted_count: 1 + unauthorized_count: 1 + non_existent_count: 0 + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '422': + $ref: '#/components/responses/UnprocessableEntity' + operationId: removeIncidentNotificationSubscribers + description: | + Unsubscribes the matching Subscribers from Incident Status Update Notifications. + + Scoped OAuth requires: `subscribers.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + subscribers: + type: array + uniqueItems: true + minItems: 1 + items: + $ref: '#/components/schemas/NotificationSubscriber' + required: + - subscribers + examples: + request: + summary: Request Example + value: + subscribers: + - subscriber_id: PD1234 + subscriber_type: team + - subscriber_id: PD1234 + subscriber_type: user + description: The entities to unsubscribe. diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/licenses.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/licenses.yaml new file mode 100644 index 0000000..24d67fe --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/licenses.yaml @@ -0,0 +1,2816 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + UserReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - user_reference + LicenseWithCounts: + allOf: + - type: object + required: + - id + - description + - name + - valid_roles + properties: + id: + type: string + description: Uniquely identifies the resource + description: + type: string + description: | + Description of the License. May include the names of add-ons associated with + the License, if there are any. + name: + type: string + description: | + Name of the License. + valid_roles: + type: array + description: The roles a User with this License can have + items: + type: string + role_group: + type: string + enum: + - FullUser + - Stakeholder + description: Indicates whether this License is assignable to full or stakeholder Users + example: FullUser + type: + type: string + description: Type of object + self: + type: string + description: API URL to access the License + html_url: + type: string + description: HTML URL to access the License + summary: + type: string + description: Summary of the License + - type: object + properties: + current_value: + type: integer + description: How many of these Licenses are currently allocated to Users + allocations_available: + type: integer + nullable: true + description: | + How many of these licenses are available to be allocated to a user. If this + value is "null" then there is no limit on the number of allocations allowed. + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + license_allocations: + id: pagerduty.licenses.license_allocations + name: license_allocations + title: License Allocations + methods: + list_license_allocations: + operation: + $ref: '#/paths/~1license_allocations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.license_allocations + _list_license_allocations: + operation: + $ref: '#/paths/~1license_allocations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/license_allocations/methods/list_license_allocations' + insert: [] + update: [] + delete: [] + licenses: + id: pagerduty.licenses.licenses + name: licenses + title: Licenses + methods: + list_licenses: + operation: + $ref: '#/paths/~1licenses/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.licenses + _list_licenses: + operation: + $ref: '#/paths/~1licenses/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/licenses/methods/list_licenses' + insert: [] + update: [] + delete: [] +paths: + /license_allocations: + get: + x-pd-requires-scope: licenses.read + tags: + - Licenses + operationId: listLicenseAllocations + description: | + List the Licenses allocated to Users within your Account + + Scoped OAuth requires: `licenses.read` + summary: List License Allocations + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + responses: + '200': + description: License allocations to Users within your Account + content: + application/json: + schema: + allOf: + - type: object + properties: + license_allocations: + type: array + items: + type: object + required: + - user + - license + - allocated_at + properties: + user: + $ref: '#/components/schemas/UserReference' + license: + $ref: '#/components/schemas/LicenseWithCounts/allOf/0' + allocated_at: + type: string + description: Indicates the date and time the License was allocated to the User + format: date-time + - $ref: '#/components/schemas/Pagination' + examples: + response: + summary: Response Example + value: + license_allocations: + - license: + id: PIP248G + name: Business (Full User) + description: Event Intelligence + valid_roles: + - owner + - admin + - user + - limited_user + - observer + - restricted_access + role_group: FullUser + summary: Business (Full User) + type: license + self: null + html_url: null + user: + id: PIP248H + type: user_reference + allocated_at: '2021-06-01T00:00:00-05:00' + offset: 0 + limit: 1 + more: false + total: 2 + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + /licenses: + get: + x-pd-requires-scope: licenses.read + tags: + - Licenses + operationId: listLicenses + description: | + List the Licenses associated with your Account + + Scoped OAuth requires: `licenses.read` + summary: List Licenses + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + responses: + '200': + description: Licenses associated with your Account + content: + application/json: + schema: + type: object + properties: + licenses: + type: array + items: + $ref: '#/components/schemas/LicenseWithCounts' + examples: + response: + summary: Example Response + value: + licenses: + - id: PIP248G + name: Business (Full User) + description: Event Intelligence + current_value: 234 + allocations_available: 4766 + valid_roles: + - owner + - admin + - user + - limited_user + - observer + - restricted_access + role_group: FullUser + summary: Business (Full User) + type: license + self: null + html_url: null + - id: PTHH1SQ + name: Business (Full User) + description: '' + current_value: 0 + allocations_available: 4766 + valid_roles: + - owner + - admin + - user + - limited_user + - observer + - restricted_access + role_group: FullUser + summary: Business (Full User) + type: license + self: null + html_url: null + - id: PQ8W0D0 + name: Business (Stakeholder) + description: '' + current_value: 48 + allocations_available: 4952 + valid_roles: + - read_only_user + - read_only_limited_user + role_group: Stakeholder + summary: Business (Stakeholder) + type: license + self: null + html_url: null + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/log_entries.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/log_entries.yaml new file mode 100644 index 0000000..ce5604f --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/log_entries.yaml @@ -0,0 +1,3221 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - log_entries + description: Log_Entries +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + AcknowledgeLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + acknowledgement_timeout: + type: integer + description: 'Duration for which the acknowledgement lasts, in seconds. Services can contain an `acknowledgement_timeout` property, which specifies the length of time acknowledgements should last for. Each time an incident is acknowledged, this timeout is copied into the acknowledgement log entry. This property is optional, as older log entries may not contain it. It may also be `null`, as acknowledgements can be performed on incidents whose services have no `acknowledgement_timeout` set.' + type: + type: string + enum: + - acknowledgement_log_entry + AnnotateLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - annotate_log_entry + AssignLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + assignees: + type: array + readOnly: true + description: An array of assigned Users for this log entry + items: + $ref: '#/components/schemas/UserReference' + type: + type: string + enum: + - assign_log_entry + DelegateLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + assignees: + type: array + readOnly: true + description: An array of assigned Users for this log entry + items: + $ref: '#/components/schemas/UserReference' + type: + type: string + enum: + - delegate_log_entry + EscalateLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + assignees: + type: array + readOnly: true + description: An array of assigned Users for this log entry + items: + $ref: '#/components/schemas/UserReference' + type: + type: string + enum: + - escalate_log_entry + ExhaustEscalationPathLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - exhaust_escalation_path_log_entry + NotifyLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + created_at: + type: string + format: date-time + readOnly: true + description: Time at which the log entry was created + user: + $ref: '#/components/schemas/UserReference' + type: + type: string + enum: + - notify_log_entry + ReachAckLimitLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - reach_ack_limit_log_entry + ReachTriggerLimitLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - reach_trigger_limit_log_entry + RepeatEscalationPathLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - repeat_escalation_path_log_entry + ResolveLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - resolve_log_entry + SnoozeLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + changed_actions: + type: array + items: + $ref: '#/components/schemas/IncidentAction' + type: + type: string + enum: + - snooze_log_entry + TriggerLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - trigger_log_entry + UnacknowledgeLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - unacknowledge_log_entry + UrgencyChangeLogEntry: + allOf: + - $ref: '#/components/schemas/LogEntry' + - type: object + properties: + type: + type: string + enum: + - urgency_change_log_entry + LogEntry: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + type: + type: string + enum: + - acknowledge_log_entry + - annotate_log_entry + - assign_log_entry + - delegate_log_entry + - escalate_log_entry + - exhaust_escalation_path_log_entry + - notify_log_entry + - reach_ack_limit_log_entry + - reach_trigger_limit_log_entry + - repeat_escalation_path_log_entry + - resolve_log_entry + - snooze_log_entry + - trigger_log_entry + - unacknowledge_log_entry + - urgency_change_log_entry + created_at: + type: string + format: date-time + readOnly: true + description: Time at which the log entry was created. + channel: + $ref: '#/components/schemas/Channel' + agent: + $ref: '#/components/schemas/AgentReference' + note: + type: string + readOnly: true + description: 'Optional field containing a note, if one was included with the log entry.' + contexts: + type: array + readOnly: true + description: Contexts to be included with the trigger such as links to graphs or images. + items: + $ref: '#/components/schemas/Context' + service: + $ref: '#/components/schemas/ServiceReference' + incident: + $ref: '#/components/schemas/IncidentReference' + teams: + type: array + readOnly: true + description: Will consist of references unless included + items: + $ref: '#/components/schemas/TeamReference' + event_details: + type: object + readOnly: true + properties: + description: + type: string + description: Additional details about the event. + UserReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - user_reference + IncidentAction: + description: An incident action is a pending change to an incident that will automatically happen at some future time. + type: object + properties: + type: + type: string + enum: + - unacknowledge + - escalate + - resolve + - urgency_change + at: + type: string + format: date-time + discriminator: + propertyName: type + required: + - type + - at + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + Channel: + type: object + description: 'Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats.' + properties: + type: + type: string + description: type + user: + type: object + team: + type: object + notification: + $ref: '#/components/schemas/Notification' + channel: + type: object + description: channel + required: + - type + AgentReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + description: 'The agent (user, service or integration) that created or modified the Incident Log Entry.' + properties: + type: + enum: + - user_reference + - service_reference + - integration_reference + type: string + readOnly: true + Context: + type: object + discriminator: + propertyName: type + properties: + type: + type: string + description: The type of context being attached to the incident. + enum: + - link + - image + href: + type: string + description: The link's target url + src: + type: string + description: The image's source url + text: + type: string + description: The alternate display for an image + required: + - type + ServiceReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - service_reference + IncidentReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - incident_reference + TeamReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - team_reference + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + Notification: + type: object + properties: + id: + type: string + readOnly: true + type: + type: string + description: The type of notification. + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + readOnly: true + started_at: + type: string + format: date-time + description: The time at which the notification was sent + readOnly: true + address: + type: string + description: The address where the notification was sent. This will be null for notification type `push_notification`. + readOnly: true + user: + $ref: '#/components/schemas/UserReference' + conferenceAddress: + type: string + description: The address of the conference bridge + status: + type: string + '': + type: string + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + log_entries: + id: pagerduty.log_entries.log_entries + name: log_entries + title: Log Entries + methods: + list_log_entries: + operation: + $ref: '#/paths/~1log_entries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.log_entries + _list_log_entries: + operation: + $ref: '#/paths/~1log_entries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_log_entry: + operation: + $ref: '#/paths/~1log_entries~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.log_entry + _get_log_entry: + operation: + $ref: '#/paths/~1log_entries~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_log_entry_channel: + operation: + $ref: '#/paths/~1log_entries~1{id}~1channel/put' + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/log_entries/methods/get_log_entry' + - $ref: '#/components/x-stackQL-resources/log_entries/methods/list_log_entries' + insert: [] + update: [] + delete: [] +paths: + /log_entries: + get: + x-pd-requires-scope: incidents.read + tags: + - Log Entries + operationId: listLogEntries + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#log-entries) + + Scoped OAuth requires: `incidents.read` + summary: List log entries + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/time_zone' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/until' + - $ref: '#/components/parameters/log_entry_is_overview' + - $ref: '#/components/parameters/include_log_entry' + - $ref: '#/components/parameters/team_ids' + responses: + '200': + description: A paginated array of log entries. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + log_entries: + type: array + items: + oneOf: + - $ref: '#/components/schemas/AcknowledgeLogEntry' + - $ref: '#/components/schemas/AnnotateLogEntry' + - $ref: '#/components/schemas/AssignLogEntry' + - $ref: '#/components/schemas/DelegateLogEntry' + - $ref: '#/components/schemas/EscalateLogEntry' + - $ref: '#/components/schemas/ExhaustEscalationPathLogEntry' + - $ref: '#/components/schemas/NotifyLogEntry' + - $ref: '#/components/schemas/ReachAckLimitLogEntry' + - $ref: '#/components/schemas/ReachTriggerLimitLogEntry' + - $ref: '#/components/schemas/RepeatEscalationPathLogEntry' + - $ref: '#/components/schemas/ResolveLogEntry' + - $ref: '#/components/schemas/SnoozeLogEntry' + - $ref: '#/components/schemas/TriggerLogEntry' + - $ref: '#/components/schemas/UnacknowledgeLogEntry' + - $ref: '#/components/schemas/UrgencyChangeLogEntry' + required: + - log_entries + examples: + response: + summary: Response Example + value: + log_entries: + - id: Q02JTSNZWHSEKV + type: trigger_log_entry + summary: Triggered through the API + self: 'https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV' + created_at: '2015-11-07T00:14:20Z' + agent: + id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + channel: + type: api + incident: + id: PT4KHLK + type: incident_reference + summary: '[#1234] The server is on fire.' + self: 'https://api.pagerduty.com/incidents/PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + contexts: [] + event_details: + description: 'Tasks::SFDCValidator - PD_Data__c - duplicates' + limit: 1 + offset: 0 + more: true + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/log_entries/{id}': + get: + x-pd-requires-scope: incidents.read + tags: + - Log Entries + operationId: getLogEntry + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#log-entries) + + Scoped OAuth requires: `incidents.read` + summary: Get a log entry + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/time_zone' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/include_log_entry' + responses: + '200': + description: A single log entry. + content: + application/json: + schema: + type: object + properties: + log_entry: + oneOf: + - $ref: '#/components/schemas/AcknowledgeLogEntry' + - $ref: '#/components/schemas/AnnotateLogEntry' + - $ref: '#/components/schemas/AssignLogEntry' + - $ref: '#/components/schemas/DelegateLogEntry' + - $ref: '#/components/schemas/EscalateLogEntry' + - $ref: '#/components/schemas/ExhaustEscalationPathLogEntry' + - $ref: '#/components/schemas/NotifyLogEntry' + - $ref: '#/components/schemas/ReachAckLimitLogEntry' + - $ref: '#/components/schemas/ReachTriggerLimitLogEntry' + - $ref: '#/components/schemas/RepeatEscalationPathLogEntry' + - $ref: '#/components/schemas/ResolveLogEntry' + - $ref: '#/components/schemas/SnoozeLogEntry' + - $ref: '#/components/schemas/TriggerLogEntry' + - $ref: '#/components/schemas/UnacknowledgeLogEntry' + - $ref: '#/components/schemas/UrgencyChangeLogEntry' + required: + - log_entry + examples: + response: + summary: Response Example + value: + log_entry: + id: Q02JTSNZWHSEKV + type: trigger_log_entry + summary: Triggered through the API + self: 'https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV' + created_at: '2015-11-07T00:14:20Z' + agent: + id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + channel: + type: api + incident: + id: PT4KHLK + type: incident_reference + summary: '[#1234] The server is on fire.' + self: 'https://api.pagerduty.com/incidents/PT4KHLK' + html_url: 'https://subdomain.pagerduty.com/incidents/PT4KHLK' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + contexts: [] + event_details: + description: 'Tasks::SFDCValidator - PD_Data__c - duplicates' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/log_entries/{id}/channel': + put: + x-pd-requires-scope: incidents.write + tags: + - Log Entries + operationId: updateLogEntryChannel + description: | + Update an existing incident log entry channel. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#log-entries) + + Scoped OAuth requires: `incidents.write` + summary: Update log entry channel information. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + channel: + type: object + description: The parameters to update. + properties: + details: + type: string + description: New channel details + type: + type: string + description: Channel type. Cannot be changed and must match the present value. + enum: + - web_trigger + - mobile + required: + - type + - details + required: + - channel + examples: + request: + summary: Request Example + value: + channel: + type: web_trigger + details: New channel details + description: The log entry channel to be updated. + responses: + '202': + description: The channel information modification was accepted. + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/maintenance_windows.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/maintenance_windows.yaml new file mode 100644 index 0000000..b4062b5 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/maintenance_windows.yaml @@ -0,0 +1,3065 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - maintenance_windows + description: Maintenance_Windows +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + MaintenanceWindow: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + type: + type: string + description: The type of object being created. + default: maintenance_window + enum: + - maintenance_window + sequence_number: + type: integer + readOnly: true + description: The order in which the maintenance window was created. + start_time: + type: string + format: date-time + description: 'This maintenance window''s start time. This is when the services will stop creating incidents. If this date is in the past, it will be updated to be the current time.' + end_time: + type: string + format: date-time + description: This maintenance window's end time. This is when the services will start creating incidents again. This date must be in the future and after the `start_time`. + description: + type: string + description: A description for this maintenance window. + created_by: + $ref: '#/components/schemas/UserReference' + services: + type: array + items: + $ref: '#/components/schemas/ServiceReference' + teams: + type: array + items: + $ref: '#/components/schemas/TeamReference' + readOnly: true + required: + - start_time + - end_time + - services + - type + example: + id: PIJ89JD + type: maintenance_window + start_time: '2015-11-09T20:00:00-05:00' + end_time: '2015-11-09T22:00:00-05:00' + description: Immanentizing the eschaton + services: + - id: PIJ90N7 + type: service_reference + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + UserReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - user_reference + ServiceReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - service_reference + TeamReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - team_reference + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + maintenance_windows: + id: pagerduty.maintenance_windows.maintenance_windows + name: maintenance_windows + title: Maintenance Windows + methods: + list_maintenance_windows: + operation: + $ref: '#/paths/~1maintenance_windows/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.maintenance_windows + _list_maintenance_windows: + operation: + $ref: '#/paths/~1maintenance_windows/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_maintenance_window: + operation: + $ref: '#/paths/~1maintenance_windows/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_maintenance_window: + operation: + $ref: '#/paths/~1maintenance_windows~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.maintenance_window + _get_maintenance_window: + operation: + $ref: '#/paths/~1maintenance_windows~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_maintenance_window: + operation: + $ref: '#/paths/~1maintenance_windows~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_maintenance_window: + operation: + $ref: '#/paths/~1maintenance_windows~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/maintenance_windows/methods/get_maintenance_window' + - $ref: '#/components/x-stackQL-resources/maintenance_windows/methods/list_maintenance_windows' + insert: + - $ref: '#/components/x-stackQL-resources/maintenance_windows/methods/create_maintenance_window' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/maintenance_windows/methods/delete_maintenance_window' +paths: + /maintenance_windows: + get: + x-pd-requires-scope: services.read + tags: + - Maintenance Windows + operationId: listMaintenanceWindows + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows) + + Scoped OAuth requires: `services.read` + summary: List maintenance windows + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/team_ids' + - $ref: '#/components/parameters/services' + - $ref: '#/components/parameters/include_maintenance_window' + - $ref: '#/components/parameters/filter_maintenance_windows' + responses: + '200': + description: A paginated array of maintenance windows. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + maintenance_windows: + type: array + items: + $ref: '#/components/schemas/MaintenanceWindow' + required: + - maintenance_windows + examples: + response: + summary: Response Example + value: + maintenance_windows: + - id: PW98YIO + type: maintenance_window + summary: Immanentizing the eschaton + self: 'https://api.pagerduty.com/maintenance_windows/PW98YIO' + html_url: 'https://subdomain.pagerduty.com/maintenance_windows#/show/PW98YIO' + sequence_number: 1 + start_time: '2015-11-09T20:00:00-05:00' + end_time: '2015-11-09T22:00:00-05:00' + description: Immanentizing the eschaton + services: + - id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + created_by: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + limit: 25 + offset: 0 + more: false + total: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + x-pd-requires-scope: services.write + tags: + - Maintenance Windows + operationId: createMaintenanceWindow + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows) + + Scoped OAuth requires: `services.write` + summary: Create a maintenance window + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + maintenance_window: + $ref: '#/components/schemas/MaintenanceWindow' + required: + - maintenance_window + examples: + request: + summary: Request Example + value: + maintenance_window: + type: maintenance_window + start_time: '2015-11-09T20:00:00-05:00' + end_time: '2015-11-09T22:00:00-05:00' + description: Immanentizing the eschaton + services: + - id: PIJ90N7 + type: service_reference + description: The maintenance window object. + responses: + '201': + description: The maintenance window that was created. + content: + application/json: + schema: + type: object + properties: + maintenance_window: + $ref: '#/components/schemas/MaintenanceWindow' + required: + - maintenance_window + examples: + response: + summary: Response Example + value: + maintenance_window: + id: PW98YIO + type: maintenance_window + summary: Immanentizing the eschaton + self: 'https://api.pagerduty.com/maintenance_windows/PW98YIO' + html_url: 'https://subdomain.pagerduty.com/maintenance_windows#/show/PW98YIO' + sequence_number: 1 + start_time: '2015-11-09T20:00:00-05:00' + end_time: '2015-11-09T22:00:00-05:00' + description: Immanentizing the eschaton + services: + - id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + created_by: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/maintenance_windows/{id}': + get: + x-pd-requires-scope: services.read + tags: + - Maintenance Windows + operationId: getMaintenanceWindow + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows) + + Scoped OAuth requires: `services.read` + summary: Get a maintenance window + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/include_maintenance_window' + responses: + '200': + description: The maintenance window that was updated. + content: + application/json: + schema: + type: object + properties: + maintenance_window: + $ref: '#/components/schemas/MaintenanceWindow' + required: + - maintenance_window + examples: + response: + summary: Response Example + value: + maintenance_window: + id: PW98YIO + type: maintenance_window + summary: Immanentizing the eschaton + self: 'https://api.pagerduty.com/maintenance_windows/PW98YIO' + html_url: 'https://subdomain.pagerduty.com/maintenance_windows#/show/PW98YIO' + sequence_number: 1 + start_time: '2015-11-09T20:00:00-05:00' + end_time: '2015-11-09T22:00:00-05:00' + description: Immanentizing the eschaton + services: + - id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + created_by: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + delete: + x-pd-requires-scope: services.write + tags: + - Maintenance Windows + operationId: deleteMaintenanceWindow + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows) + + Scoped OAuth requires: `services.write` + summary: Delete or end a maintenance window + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '204': + description: The maintenance window was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + description: The maintenance window can't be deleted because it has already ended. + '429': + $ref: '#/components/responses/TooManyRequests' + put: + x-pd-requires-scope: services.write + tags: + - Maintenance Windows + operationId: updateMaintenanceWindow + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows) + + Scoped OAuth requires: `services.write` + summary: Update a maintenance window + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + maintenance_window: + $ref: '#/components/schemas/MaintenanceWindow' + required: + - maintenance_window + examples: + request: + summary: Request Example + value: + maintenance_window: + type: maintenance_window + start_time: '2015-11-09T20:00:00-05:00' + end_time: '2015-11-09T22:00:00-05:00' + description: Immanentizing the eschaton + services: + - id: PIJ90N7 + type: service_reference + description: The maintenance window to be updated. + responses: + '200': + description: The maintenance window that was updated. + content: + application/json: + schema: + type: object + properties: + maintenance_window: + $ref: '#/components/schemas/MaintenanceWindow' + required: + - maintenance_window + examples: + response: + summary: Response Example + value: + maintenance_window: + id: PW98YIO + type: maintenance_window + summary: Immanentizing the eschaton + self: 'https://api.pagerduty.com/maintenance_windows/PW98YIO' + html_url: 'https://subdomain.pagerduty.com/maintenance_windows#/show/PW98YIO' + sequence_number: 1 + start_time: '2015-11-09T20:00:00-05:00' + end_time: '2015-11-09T22:00:00-05:00' + description: Immanentizing the eschaton + services: + - id: PIJ90N7 + type: service_reference + summary: My Mail Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + created_by: + id: PXPGF42 + type: user_reference + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/notifications.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/notifications.yaml new file mode 100644 index 0000000..d4b4cb1 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/notifications.yaml @@ -0,0 +1,2691 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - notifications + description: | + A Notification is created when an Incident is triggered or escalated. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + Notification: + type: object + properties: + id: + type: string + readOnly: true + type: + type: string + description: The type of notification. + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + readOnly: true + started_at: + type: string + format: date-time + description: The time at which the notification was sent + readOnly: true + address: + type: string + description: The address where the notification was sent. This will be null for notification type `push_notification`. + readOnly: true + user: + $ref: '#/components/schemas/UserReference' + conferenceAddress: + type: string + description: The address of the conference bridge + status: + type: string + '': + type: string + UserReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - user_reference + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + notifications: + id: pagerduty.notifications.notifications + name: notifications + title: Notifications + methods: + list_notifications: + operation: + $ref: '#/paths/~1notifications/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.notifications + _list_notifications: + operation: + $ref: '#/paths/~1notifications/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/notifications/methods/list_notifications' + insert: [] + update: [] + delete: [] +paths: + /notifications: + get: + x-pd-requires-scope: 'users:notifications.read' + tags: + - Notifications + operationId: listNotifications + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#notifications) + + Scoped OAuth requires: `users:notifications.read` + summary: List notifications + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/time_zone' + - $ref: '#/components/parameters/since_notifications' + - $ref: '#/components/parameters/until_notifications' + - $ref: '#/components/parameters/filter_notifications' + - $ref: '#/components/parameters/include_notifications' + responses: + '200': + description: A paginated array of notifications. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + notifications: + type: array + items: + $ref: '#/components/schemas/Notification' + required: + - notifications + examples: + response: + summary: Response Example + value: + notifications: + - id: PWL7QXS + type: phone_notification + started_at: '2013-03-06T15:28:51-05:00' + address: '+15555551234' + user: + id: PT23IWX + type: user_reference + summary: Tim Wright + self: 'https://api.pagerduty.com/users/PT23IWX' + html_url: 'https://subdomain.pagerduty.com/users/PT23IWX' + - id: PKN7NBH + type: push_notification + started_at: '2013-03-06T15:28:51-05:00' + user: + id: PT23IWX + type: user_reference + summary: Tim Wright + self: 'https://api.pagerduty.com/users/PT23IWX' + html_url: 'https://subdomain.pagerduty.com/users/PT23IWX' + limit: 100 + offset: 0 + more: false + total: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/on_calls.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/on_calls.yaml new file mode 100644 index 0000000..119ee3b --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/on_calls.yaml @@ -0,0 +1,2726 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - on_calls + description: | + 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 +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + Oncall: + type: object + properties: + escalation_policy: + $ref: '#/components/schemas/EscalationPolicyReference' + user: + $ref: '#/components/schemas/UserReference' + schedule: + $ref: '#/components/schemas/ScheduleReference' + escalation_level: + type: integer + readOnly: true + description: The escalation level for the on-call. + start: + type: string + format: date-time + readOnly: true + description: 'The start of the on-call. If `null`, the on-call is a permanent user on-call.' + end: + type: string + format: date-time + readOnly: true + description: 'The end of the on-call. If `null`, the user does not go off-call.' + example: + user: + id: PT23IWX + type: user_reference + summary: Tim Wright + self: 'https://api.pagerduty.com/users/PT23IWX' + html_url: 'https://subdomain.pagerduty.com/users/PT23IWX' + schedule: + id: PI7DH85 + type: schedule_reference + summary: Daily Engineering Rotation + self: 'https://api.pagerduty.com/schedules/PI7DH85' + html_url: 'https://subdomain.pagerduty.com/schedules/PI7DH85' + escalation_policy: + id: PT20YPA + type: escalation_policy_reference + summary: Engineering Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + escalation_level: 2 + start: '2015-03-06T15:28:51-05:00' + end: '2015-03-07T15:28:51-05:00' + EscalationPolicyReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - escalation_policy_reference + UserReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - user_reference + ScheduleReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - schedule_reference + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + oncalls: + id: pagerduty.on_calls.oncalls + name: oncalls + title: Oncalls + methods: + list_on_calls: + operation: + $ref: '#/paths/~1oncalls/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.oncalls + _list_on_calls: + operation: + $ref: '#/paths/~1oncalls/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/oncalls/methods/list_on_calls' + insert: [] + update: [] + delete: [] +paths: + /oncalls: + get: + tags: + - On-Calls + x-pd-requires-scope: oncalls.read + operationId: listOnCalls + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#on-calls) + + Scoped OAuth requires: `oncalls.read` + summary: List all of the on-calls + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/time_zone' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/include_oncalls' + - $ref: '#/components/parameters/user_ids_oncalls' + - $ref: '#/components/parameters/escalation_policy_ids_oncalls' + - $ref: '#/components/parameters/schedule_ids_oncalls' + - $ref: '#/components/parameters/since_oncalls' + - $ref: '#/components/parameters/until_oncalls' + - $ref: '#/components/parameters/earliest_oncalls' + responses: + '200': + description: A paginated array of on-call objects. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + oncalls: + type: array + items: + $ref: '#/components/schemas/Oncall' + required: + - oncalls + examples: + response: + summary: Response Example + value: + oncalls: + - user: + id: PT23IWX + type: user_reference + summary: Tim Wright + self: 'https://api.pagerduty.com/users/PT23IWX' + html_url: 'https://subdomain.pagerduty.com/users/PT23IWX' + schedule: + id: PI7DH85 + type: schedule_reference + summary: Daily Engineering Rotation + self: 'https://api.pagerduty.com/schedules/PI7DH85' + html_url: 'https://subdomain.pagerduty.com/schedules/PI7DH85' + escalation_policy: + id: PT20YPA + type: escalation_policy_reference + summary: Engineering Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + escalation_level: 2 + start: '2015-03-06T15:28:51-05:00' + end: '2015-03-07T15:28:51-05:00' + limit: 25 + offset: 0 + more: false + total: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/paused_incident_reports.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/paused_incident_reports.yaml new file mode 100644 index 0000000..cfa3dd3 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/paused_incident_reports.yaml @@ -0,0 +1,2688 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - paused_incident_reports + description: Paused_Incident_Reports +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + InternalServerError: + description: Internal Server Error the PagerDuty server experienced an error. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + alerts: + id: pagerduty.paused_incident_reports.alerts + name: alerts + title: Alerts + methods: + get_paused_incident_report_alerts: + operation: + $ref: '#/paths/~1paused_incident_reports~1alerts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.paused_incident_reporting_alerts + _get_paused_incident_report_alerts: + operation: + $ref: '#/paths/~1paused_incident_reports~1alerts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/alerts/methods/get_paused_incident_report_alerts' + insert: [] + update: [] + delete: [] + counts: + id: pagerduty.paused_incident_reports.counts + name: counts + title: Counts + methods: + get_paused_incident_report_counts: + operation: + $ref: '#/paths/~1paused_incident_reports~1counts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.paused_incident_reporting_counts + _get_paused_incident_report_counts: + operation: + $ref: '#/paths/~1paused_incident_reports~1counts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/counts/methods/get_paused_incident_report_counts' + insert: [] + update: [] + delete: [] +paths: + /paused_incident_reports/alerts: + get: + x-pd-requires-scope: incidents.read + tags: + - Paused Incident Reports + operationId: getPausedIncidentReportAlerts + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#paused-incident-reports) + + Scoped OAuth requires: `incidents.read` + summary: Get Paused Incident Reporting on Alerts + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/until' + - $ref: '#/components/parameters/paused_incident_reports_service_id' + - $ref: '#/components/parameters/paused_incident_reports_suspended_by' + responses: + '200': + description: Paused Incident Reporting on Alerts for the Account or scoped to a Service. + content: + application/json: + schema: + description: '' + type: object + properties: + paused_incident_reporting_alerts: + type: object + description: A list of the 5 most recent paused Alerts that weere triggered and 5 most recent Alerts that were reesolved before being triggerd. + properties: + since: + type: string + description: The start of the date range over which the report data is represented. + until: + type: string + description: The end of the date range over which the report data is represented. + triggered_after_pause_alerts: + type: array + description: An array of Alerts that were triggered after being paused. + items: + properties: + id: + type: string + description: The Alert ID + service_id: + type: string + description: The Alert's Service ID + created_at: + type: string + description: The date/time the Alert was created + resolved_after_pause_alerts: + type: array + description: An array of Alerts that were resolved after being paused. + items: + properties: + id: + type: string + description: The Alert ID + service_id: + type: string + description: The Alert's Service ID + created_at: + type: string + description: The date/time the Alert was created + examples: + response: + summary: Response Example + value: + paused_incident_reporting_counts: + since: '2021-06-01TT13:08:14Z' + until: '2021-08-01T13:08:14Z' + triggered_after_pause_alerts: + - id: PR2P3RW + service_id: PPSCXAN + created_at: '2020-10-18T12:01:11Z' + resolved_after_pause_alerts: + - id: PS2R1RZ + service_id: PRS12XW + created_at: '2020-10-17T02:02:10Z' + - id: PS1S1SX + service_id: PRS12XW + created_at: '2020-10-16T15:02:19Z' + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + /paused_incident_reports/counts: + get: + x-pd-requires-scope: incidents.read + tags: + - Paused Incident Reports + operationId: getPausedIncidentReportCounts + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#paused-incident-reports) + + Scoped OAuth requires: `incidents.read` + summary: Get Paused Incident Reporting counts + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/until' + - $ref: '#/components/parameters/paused_incident_reports_service_id' + - $ref: '#/components/parameters/paused_incident_reports_suspended_by' + responses: + '200': + description: Paused Incident Reporting counts for the Account or scoped to a Service. + content: + application/json: + schema: + description: '' + type: object + properties: + paused_incident_reporting_counts: + type: object + description: 'A representation of Alerts that were paused, triggered after pause, and resolved after pause.' + properties: + since: + type: string + description: The start of the date range over which the report data is represented. + until: + type: string + description: The end of the date range over which the report data is represented. + paused_count: + type: number + description: The total number of paused Alerts for the Account or Servce. + triggered_after_pause_count: + type: number + description: The total number of paused Alerts for the Account or Service that were triggerd after being paused (non-transient Alerts). + resolved_after_pause_count: + type: number + description: The total number of paused Alerts for the Account or Service that were resolved after being paused and not triggered (transient Alerts). + examples: + response: + summary: Response Example + value: + paused_incident_reporting_counts: + since: '2021-06-01TT13:08:14Z' + until: '2021-08-01T13:08:14Z' + paused_count: 50 + triggered_after_pause_count: 12 + resolved_after_pause_count: 38 + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/priorities.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/priorities.yaml new file mode 100644 index 0000000..b62f36e --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/priorities.yaml @@ -0,0 +1,2669 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + Priority: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + name: + type: string + description: The user-provided short name of the priority. + description: + type: string + description: The user-provided description of the priority. + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + PaymentRequired: + description: | + Account does not have the abilities to perform the action. Please review the response for the required abilities. + You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + priorities: + id: pagerduty.priorities.priorities + name: priorities + title: Priorities + methods: + list_priorities: + operation: + $ref: '#/paths/~1priorities/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.priorities + _list_priorities: + operation: + $ref: '#/paths/~1priorities/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/priorities/methods/list_priorities' + insert: [] + update: [] + delete: [] +paths: + /priorities: + get: + tags: + - Priorities + x-pd-requires-scope: priorities.read + operationId: listPriorities + description: | + List existing priorities, in order (most to least severe). + + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#priorities) + + Scoped OAuth requires: `priorities.read` + summary: List priorities + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + responses: + '200': + description: A paginated array of priorities. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + priorities: + type: array + items: + $ref: '#/components/schemas/Priority' + required: + - priorities + examples: + response: + summary: Response Example + value: + priorities: + - id: PSLWBL8 + type: priority + summary: P1 + self: 'https://api.pagerduty.com/priorities/PSLWBL8' + name: P1 + description: Critical issue that warrants public notification and liaison with executive teams + - id: P53ZZH5 + type: priority + summary: P2 + self: 'https://api.pagerduty.com/priorities/P53ZZH5' + name: P2 + description: Critical system issue actively impacting many customers' ability to use the product + - id: PGE9YCZ + type: priority + summary: P3 + self: 'https://api.pagerduty.com/priorities/PGE9YCZ' + name: P3 + description: Stability or minor customer-impacting issues that require immediate attention from service owners + - id: PVJPWYW + type: priority + summary: P4 + self: 'https://api.pagerduty.com/priorities/PVJPWYW' + name: P4 + description: 'Minor issues requiring action, but not affecting customer ability to use the product' + - id: P81SUUT + type: priority + summary: P5 + self: 'https://api.pagerduty.com/priorities/P81SUUT' + name: P5 + description: 'Cosmetic issues or bugs, not affecting customer ability to use the product' + limit: 25 + offset: 0 + more: false + total: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/response_plays.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/response_plays.yaml new file mode 100644 index 0000000..43ed078 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/response_plays.yaml @@ -0,0 +1,3153 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - response_plays + description: Response_Plays +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + ResponsePlay: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + type: + type: string + description: The type of object being created. + default: response_play + enum: + - response_play + name: + type: string + description: The name of the response play. + description: + type: string + nullable: true + description: The description of the response play. + maxLength: 349 + team: + oneOf: + - $ref: '#/components/schemas/TeamReference' + - type: object + nullable: true + subscribers: + type: array + nullable: true + description: An array containing the users and/or teams to be added as subscribers to any incident on which this response play is run. + items: + anyOf: + - $ref: '#/components/schemas/UserReference' + - $ref: '#/components/schemas/TeamReference' + discriminator: + propertyName: type + subscribers_message: + type: string + nullable: true + description: 'The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent.' + responders: + type: array + description: An array containing the users and/or escalation policies to be requested as responders to any incident on which this response play is run. + items: + anyOf: + - $ref: '#/components/schemas/UserReference' + - $ref: '#/components/schemas/EscalationPolicyReference' + discriminator: + propertyName: type + responders_message: + type: string + nullable: true + description: 'The message body of the notification that will be sent to this response play''s set of responders. If empty, a default response request notification will be sent.' + runnability: + type: string + description: |- + String representing how this response play is allowed to be run. Valid options are: + - `services`: This response play cannot be manually run by any users. It will run automatically for new incidents triggered on any services that are configured with this response play. + - `teams`: This response play can be run manually on an incident only by members of its configured team. This option can only be selected when the `team` property for this response play is not empty. + - `responders`: This response play can be run manually on an incident by any responders in this account. + enum: + - services + - teams + - responders + default: services + conference_number: + type: string + nullable: true + description: The telephone number that will be set as the conference number for any incident on which this response play is run. + conference_url: + type: string + description: The URL that will be set as the conference URL for any incident on which this response play is run. + nullable: true + conference_type: + type: string + description: |- + This field has three possible values and indicates how the response play was created. + - `none` : The response play had no conference_number or conference_url set at time of creation. + - `manual` : The response play had one or both of conference_number and conference_url set at time of creation. + - `zoom` : Customers with the Zoom-Integration Entitelment can use this value to dynamicly configure conference number and url for zoom + enum: + - none + - manual + - zoom + default: none + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + TeamReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - team_reference + UserReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - user_reference + EscalationPolicyReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - escalation_policy_reference + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + IncidentReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - incident_reference + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + PaymentRequired: + description: | + Account does not have the abilities to perform the action. Please review the response for the required abilities. + You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + response_plays: + id: pagerduty.response_plays.response_plays + name: response_plays + title: Response Plays + methods: + list_response_plays: + operation: + $ref: '#/paths/~1response_plays/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.plays + _list_response_plays: + operation: + $ref: '#/paths/~1response_plays/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_response_play: + operation: + $ref: '#/paths/~1response_plays/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_response_play: + operation: + $ref: '#/paths/~1response_plays~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.response_play + _get_response_play: + operation: + $ref: '#/paths/~1response_plays~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_response_play: + operation: + $ref: '#/paths/~1response_plays~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_response_play: + operation: + $ref: '#/paths/~1response_plays~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + run_response_play: + operation: + $ref: '#/paths/~1response_plays~1{response_play_id}~1run/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/response_plays/methods/get_response_play' + - $ref: '#/components/x-stackQL-resources/response_plays/methods/list_response_plays' + insert: + - $ref: '#/components/x-stackQL-resources/response_plays/methods/create_response_play' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/response_plays/methods/delete_response_play' +paths: + /response_plays: + get: + x-pd-requires-scope: response_plays.read + deprecated: true + tags: + - Response Plays + operationId: listResponsePlays + description: | + List all of the existing Response Plays. + + Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays) + + When using a Global API token, the `From` header is required. + + Scoped OAuth requires: `response_plays.read` + summary: List Response Plays + parameters: + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/filter_for_manual_run' + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/optional_from_header' + responses: + '200': + description: The array of Response Plays returned by the query. + content: + application/json: + schema: + type: object + properties: + response_plays: + type: array + items: + $ref: '#/components/schemas/ResponsePlay' + examples: + response: + summary: Response Example + value: + response_plays: + - type: response_play + team: null + summary: An Existing Response Play For Responders + self: 'https://api.pagerduty.com/response_plays/15b4b27e-2448-adf9-c5a5-85382304ff37' + name: An Existing Response Play For Responders + id: 15b4b27e-2448-adf9-c5a5-85382304ff37 + html_url: null + description: A Response Play that adds responders. + - type: response_play + team: null + summary: An Existing Response Play For Subscribers + self: 'https://api.pagerduty.com/response_plays/15b4b27e-2771-abe5-t6m9-81234304ff37' + name: An Existing Response Play For Subscribers + id: 15b4b27e-2771-abe5-t6m9-81234304ff37 + html_url: null + description: A Response Play that adds subscribers. + limit: null + offset: null + total: 2 + more: false + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + post: + deprecated: true + x-pd-requires-scope: response_plays.write + tags: + - Response Plays + operationId: createResponsePlay + description: | + Creates a new Response Plays. + + Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays) + + Scoped OAuth requires: `response_plays.write` + summary: Create a Response Play + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + response_play: + $ref: '#/components/schemas/ResponsePlay' + required: + - response_play + examples: + Example1: + summary: Create a Response Play which adds a Escalation Policy and User to an incident when the response play is run + value: + response_play: + type: response_play + team: null + name: Standard NOC-EP + description: A Response Play to add NOC EP on Run + subscribers: [] + subscribers_message: null + responders: + - type: user_reference + id: PROW72A + summary: our team stakeholder + - type: escalation_policy_reference + id: P12TU3X + summary: Network Center Escalation Policy + responders_message: NOC-EP + runnability: services + Example2: + summary: Add a static conference url to an incident when the response play is run + value: + response_play: + type: response_play + name: Basic Fixed URL + description: preset conference url + runnability: services + conference_url: 'https://my.conference.com/our_team/123' + description: The Response Play to be created. + responses: + '201': + description: The Response Play that was created. + content: + application/json: + schema: + type: object + properties: + response_play: + $ref: '#/components/schemas/ResponsePlay' + examples: + response: + summary: Response Example + value: + response_play: + type: response_play + team: null + summary: A New Response Play + subscribers_message: Please view the attached incident. + subscribers: + - type: user_reference + summary: null + self: 'https://api.pagerduty.com/users/PSEJLIN' + id: PSEJLIN + html_url: null + - type: team_reference + summary: null + self: 'https://api.pagerduty.com/teams/P12TU3X' + id: P12TU3X + html_url: null + self: 'https://api.pagerduty.com/response_plays/15b4b27e-2448-adf9-c5a5-85382304ff37' + runnability: services + responders_message: We need executive attention on this incident. + responders: + - type: user_reference + summary: null + self: 'https://api.pagerduty.com/users/PZOW51A' + id: PZOW51A + html_url: null + name: A New Response Play + id: 15b4b27e-2448-adf9-c5a5-85382304ff37 + html_url: null + description: A Response Play that adds subscribers and responders + conference_url: null + conference_number: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '/response_plays/{id}': + get: + deprecated: true + x-pd-requires-scope: response_plays.read + tags: + - Response Plays + operationId: getResponsePlay + description: | + Get details about an existing Response Play. + + Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays) + + When using a Global API token, the `From` header is required. + Scoped OAuth requires: `response_plays.read` + summary: Get a Response Play + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/optional_from_header' + responses: + '200': + description: The Response Play requested. + content: + application/json: + schema: + type: object + properties: + response_play: + $ref: '#/components/schemas/ResponsePlay' + examples: + response: + summary: Response Example + value: + response_play: + type: response_play + team: null + summary: Email Service Response Play + subscribers_message: null + subscribers: null + self: 'https://api.pagerduty.com/response_plays/15b4b27e-2448-adf9-c5a5-85382304ff37' + runnability: services + responders_message: null + responders: + - type: escalation_policy_reference + summary: null + self: 'https://api.pagerduty.com/escalation_policies/PZOW51A' + id: PZOW51A + html_url: null + name: Email Service Response Play + id: 15b4b27e-2448-adf9-c5a5-85382304ff37 + html_url: null + description: null + conference_url: null + conference_number: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + put: + deprecated: true + x-pd-requires-scope: response_plays.write + tags: + - Response Plays + operationId: updateResponsePlay + description: | + Updates an existing Response Play. + + Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays) + + Scoped OAuth requires: `response_plays.write` + summary: Update a Response Play + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + response_play: + $ref: '#/components/schemas/ResponsePlay' + required: + - response_play + examples: + request: + summary: Request Example + value: + response_play: + type: response_play + team: null + summary: Test Response Play + subscribers_message: Please view the attached incident. + subscribers: + - type: user_reference + id: PFS9QZZ + self: 'https://api.pagerduty.com/response_plays/153d9e1f-9008-ee4e-fa70-0d70cdf92f27' + runnability: responders + responders_message: null + responders: [] + name: Test Response Play + id: 153d9e1f-9008-ee4e-fa70-0d70cdf92f27 + html_url: null + description: An updated description of this Response Play. + conference_url: null + conference_number: null + description: The Response Play to be updated. + responses: + '200': + description: The Response Play that was updated. + content: + application/json: + schema: + type: object + properties: + response_play: + $ref: '#/components/schemas/ResponsePlay' + examples: + response: + summary: Response Example + value: + response_play: + type: response_play + team: null + summary: Test Response Play + subscribers_message: Please view the attached incident. + subscribers: + - type: user_reference + summary: null + self: 'https://api.pagerduty.com/users/PFS9QZZ' + id: PFS9QZZ + html_url: null + self: 'https://api.pagerduty.com/response_plays/153d9e1f-9008-ee4e-fa70-0d70cdf92f27' + runnability: services + responders_message: null + responders: [] + name: Test Response Play + id: 153d9e1f-9008-ee4e-fa70-0d70cdf92f27 + html_url: null + description: null + conference_url: null + conference_number: null + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + delete: + deprecated: true + x-pd-requires-scope: response_plays.write + tags: + - Response Plays + operationId: deleteResponsePlay + description: | + Delete an existing Response Play. Once the Response Play is deleted, the action cannot be undone. + + WARNING: When the Response Play is deleted, it is also removed from any Services that were using it. + + Response Plays allow you to create packages of Incident Actions that can be applied to an Incident. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays) + + Scoped OAuth requires: `response_plays.write` + summary: Delete a Response Play + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/from_header' + responses: + '204': + description: The Response Play was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '/response_plays/{response_play_id}/run': + post: + x-pd-requires-scope: response_plays.write + deprecated: true + tags: + - Response Plays + operationId: runResponsePlay + description: | + Run a specified response play on a given incident. + + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays) + + Scoped OAuth requires: `response_plays.write` + summary: Run a response play + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/response_play_id' + - $ref: '#/components/parameters/from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + incident: + $ref: '#/components/schemas/IncidentReference' + required: + - incident + examples: + request: + summary: Request Example + value: + incident: + id: PWL7QXS + type: incident_reference + responses: + '200': + description: Informs the user if the response play has been run successfully. + content: + application/json: + schema: + type: object + properties: + status: + type: string + required: + - status + examples: + response: + summary: Response Example + value: + status: ok + '400': + $ref: '#/components/responses/ArgumentError' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/rulesets.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/rulesets.yaml new file mode 100644 index 0000000..1af4721 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/rulesets.yaml @@ -0,0 +1,3806 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - rulesets + description: | + 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. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + Ruleset: + type: object + properties: + id: + type: string + readOnly: true + description: ID of the Ruleset. + self: + type: string + format: url + description: the API show URL at which the object is accessible + readOnly: true + type: + type: string + readOnly: true + enum: + - global + - default_global + name: + type: string + description: Name of the Ruleset. + routing_keys: + type: array + readOnly: true + description: Routing keys routed to this Ruleset. + items: + type: string + created_at: + type: string + format: date-time + readOnly: true + description: The date the Ruleset was created at. + creator: + type: object + readOnly: true + description: Reference to the user that has created the Ruleset. + properties: + id: + type: string + readOnly: true + type: + type: string + description: A string that determines the schema of the object + readOnly: true + self: + type: string + format: url + description: The API show URL at which the object is accessible + readOnly: true + updated_at: + type: string + format: date-time + readOnly: true + description: The date the Ruleset was last updated. + updater: + type: object + readOnly: true + description: Reference to the user that has updated the Ruleset last. + properties: + id: + type: string + readOnly: true + type: + type: string + description: A string that determines the schema of the object + readOnly: true + self: + type: string + format: url + description: The API show URL at which the object is accessible + readOnly: true + team: + type: object + description: 'Reference to the team that owns the Ruleset. If none is specified, only admins have access.' + properties: + id: + type: string + type: + type: string + description: A string that determines the schema of the object + readOnly: true + self: + type: string + format: url + description: The API show URL at which the object is accessible + readOnly: true + required: + - id + - type + example: + id: 0e84de00-9511-4380-9f4f-a7b568bb49a0 + name: MySQL Clusters + type: global + routing_keys: + - R0212P1QXGEIQE2NMTQ7L7WXD00DWHIN + self: 'https://api.pagerduty.com/rulesets/0e84de00-9511-4380-9f4f-a7b568bb49a0' + created_at: '2019-12-24T21:18:52Z' + creator: + type: user_reference + self: 'https://api.pagerduty.com/users/PABO808' + id: PABO808 + updated_at: '2019-12-25T14:54:23Z' + updater: + type: user_reference + self: 'https://api.pagerduty.com/users/PABO808' + id: PABO808 + team: + type: team_reference + self: 'https://api.pagerduty.com/teams/P3ZQXDF' + id: P3ZQXDF + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + EventRule: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + description: ID of the Event Rule. + self: + type: string + format: url + description: the API show URL at which the object is accessible. + readOnly: true + disabled: + type: boolean + description: Indicates whether the Event Rule is disabled and would therefore not be evaluated. + conditions: + type: object + description: 'Conditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though.' + properties: + operator: + type: string + description: Operator to combine sub-conditions. + enum: + - and + - or + subconditions: + type: array + description: Array of sub-conditions. + items: + type: object + properties: + operator: + type: string + description: The type of operator to apply. + enum: + - exists + - nexists + - equals + - nequals + - contains + - ncontains + - matches + - nmatches + parameters: + type: object + properties: + path: + type: string + description: 'Path to a field in an event, in dot-notation. For Event Rules on a serivce, this will have to be a PD-CEF field.' + value: + type: string + description: Value to apply to the operator. + options: + type: object + description: Options to configure the operator. + required: + - value + - path + required: + - operator + - parameters + required: + - operator + - subconditions + time_frame: + description: Time-based conditions for limiting when the rule is active. + type: object + properties: + active_between: + type: object + required: + - start_time + - end_time + description: A fixed window of time during which the rule is active. + properties: + start_time: + type: integer + description: The start time in milliseconds. + end_time: + type: integer + description: End time in milliseconds. + scheduled_weekly: + type: object + required: + - start_time + - duration + - timezone + - weekdays + description: 'A reccuring window of time based on the day of the week, during which the rule is active.' + properties: + start_time: + type: integer + description: The amount of milliseconds into the day at which the window starts. + duration: + type: integer + description: The duration of the window in milliseconds. + timezone: + type: string + description: The timezone. + weekdays: + type: array + description: 'An array of day values. Ex [1, 3, 5] is Monday, Wednesday, Friday.' + items: + type: integer + variables: + type: array + description: '[Early Access] Populate variables from event payloads and use those variables in other event actions.' + items: + type: object + properties: + type: + type: string + description: The type of operation to populate the variable. + enum: + - regex + name: + type: string + description: The name of the variable. + parameters: + type: object + description: The parameters for performing the operation to populate the + properties: + value: + type: string + description: 'The value for the operation. For example, an RE2 regular expression for regex-type variables.' + path: + type: string + description: 'Path to a field in an event, in dot-notation. For Event Rules on a Service, this will have to be a PD-CEF field.' + required: + - value + - path + required: + - type + - name + - parameters + - type: object + properties: + position: + type: integer + description: 'Position/index of the Event Rule in the Ruleset. Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching rule is found.' + catch_all: + type: boolean + readOnly: true + description: Indicates whether the Event Rule is the last Event Rule of the Ruleset that serves as a catch-all. It has limited functionality compared to other rules and always matches. + actions: + description: 'When an event matches this rule, the actions that will be taken to change the resulting alert and incident.' + allOf: + - $ref: '#/components/schemas/EventRuleActionsCommon' + - type: object + properties: + route: + description: Set the service ID of the target service for the resulting alert. You can find the service you want to route to by calling the services endpoint. + type: object + required: + - value + nullable: true + properties: + value: + type: string + description: The target service's ID. + EventRuleActionsCommon: + type: object + description: 'When an event matches this Event Rule, the actions that will be taken to change the resulting Alert and Incident.' + properties: + annotate: + description: Set a note on the resulting incident. + type: object + nullable: true + required: + - value + properties: + value: + type: string + description: The content of the note. + event_action: + description: Set whether the resulting alert status is trigger or resolve. + type: object + required: + - value + nullable: true + properties: + value: + type: string + enum: + - trigger + - resolve + extractions: + type: array + description: Dynamically extract values to set and modify new and existing PD-CEF fields. + items: + oneOf: + - type: object + required: + - target + - source + - regex + properties: + target: + type: string + description: The PD-CEF field that will be set with the value from the regex. + source: + type: string + description: The path to the event field where the regex will be applied to extract a value. + regex: + type: string + description: 'A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used.' + - type: object + required: + - target + - template + properties: + target: + type: string + description: The PD-CEF field that will be set with the value from the regex. + template: + type: string + description: A value that will be used to populate the target PD-CEF field. You can include variables extracted from the payload by using string interpolation. + example: 'Error number {{count}} on host {{host}}' + priority: + description: Set the priority ID for the resulting incident. You can find the priority you want by calling the priorities endpoint. + type: object + required: + - value + nullable: true + properties: + value: + type: string + description: The priority ID. + severity: + description: Set the severity of the resulting alert. + type: object + required: + - value + nullable: true + properties: + value: + type: string + enum: + - info + - warning + - error + - critical + suppress: + description: Set whether the resulting alert is suppressed. Can optionally be used with a threshold where resulting alerts will be suppressed until the threshold is met in a window of time. If using a threshold the rule must also set a route action. + type: object + required: + - value + properties: + value: + type: boolean + threshold_value: + type: integer + description: The number of occurences needed during the window of time to trigger the theshold. + threshold_time_unit: + type: string + description: The time unit for the window of time. + enum: + - seconds + - minutes + - hours + threshold_time_amount: + type: integer + description: The amount of time units for the window of time. + suspend: + description: 'Set the length of time to suspend the resulting alert before triggering. Rules with a suspend action must also set a route action, and cannot have a suppress with threshold action' + type: object + required: + - value + nullable: true + properties: + value: + type: integer + description: The amount of time to suspend the alert in seconds. + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + NotAllowed: + description: 'The request was received and recognized by the server, but its HTTP method was rejected for the requested resource.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + rulesets: + id: pagerduty.rulesets.rulesets + name: rulesets + title: Rulesets + methods: + list_rulesets: + operation: + $ref: '#/paths/~1rulesets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.rulesets + _list_rulesets: + operation: + $ref: '#/paths/~1rulesets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_ruleset: + operation: + $ref: '#/paths/~1rulesets/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_ruleset: + operation: + $ref: '#/paths/~1rulesets~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.ruleset + _get_ruleset: + operation: + $ref: '#/paths/~1rulesets~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_ruleset: + operation: + $ref: '#/paths/~1rulesets~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_ruleset: + operation: + $ref: '#/paths/~1rulesets~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rulesets/methods/get_ruleset' + - $ref: '#/components/x-stackQL-resources/rulesets/methods/list_rulesets' + insert: + - $ref: '#/components/x-stackQL-resources/rulesets/methods/create_ruleset' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/rulesets/methods/delete_ruleset' + rules: + id: pagerduty.rulesets.rules + name: rules + title: Rules + methods: + list_ruleset_event_rules: + operation: + $ref: '#/paths/~1rulesets~1{id}~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.rules + _list_ruleset_event_rules: + operation: + $ref: '#/paths/~1rulesets~1{id}~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_ruleset_event_rule: + operation: + $ref: '#/paths/~1rulesets~1{id}~1rules/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_ruleset_event_rule: + operation: + $ref: '#/paths/~1rulesets~1{id}~1rules~1{rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.rule + _get_ruleset_event_rule: + operation: + $ref: '#/paths/~1rulesets~1{id}~1rules~1{rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_ruleset_event_rule: + operation: + $ref: '#/paths/~1rulesets~1{id}~1rules~1{rule_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_ruleset_event_rule: + operation: + $ref: '#/paths/~1rulesets~1{id}~1rules~1{rule_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rules/methods/get_ruleset_event_rule' + - $ref: '#/components/x-stackQL-resources/rules/methods/list_ruleset_event_rules' + insert: + - $ref: '#/components/x-stackQL-resources/rules/methods/create_ruleset_event_rule' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete_ruleset_event_rule' +paths: + /rulesets: + get: + x-pd-requires-scope: event_rules.read + tags: + - Rulesets + operationId: listRulesets + description: | + List all Rulesets + + > ### 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets) + + Scoped OAuth requires: `event_rules.read` + summary: List Rulesets + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + responses: + '200': + description: A paginated array of Ruleset objects. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + rulesets: + type: array + items: + $ref: '#/components/schemas/Ruleset' + examples: + response: + summary: Response Example + value: + rulesets: + - id: 0e84de00-9511-4380-9f4f-a7b568bb49a0 + name: MySQL Clusters + type: global + routing_keys: + - R0212P1QXGEIQE2NMTQ7L7WXD00DWHIN + self: 'https://api.pagerduty.com/rulesets/0e84de00-9511-4380-9f4f-a7b568bb49a0' + created_at: '2019-12-24T21:18:52Z' + creator: + type: user_reference + self: 'https://api.pagerduty.com/users/PABO808' + id: PABO808 + updated_at: '2019-12-25T14:54:23Z' + updater: + type: user_reference + self: 'https://api.pagerduty.com/users/PABO808' + id: PABO808 + team: + type: team_reference + self: 'https://api.pagerduty.com/teams/P3ZQXDF' + id: P3ZQXDF + limit: 25 + offset: 0 + more: false + total: null + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + post: + x-pd-requires-scope: event_rules.write + tags: + - Rulesets + operationId: createRuleset + description: | + Create a new Ruleset. + + > ### 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets) + + Scoped OAuth requires: `event_rules.write` + summary: Create a Ruleset + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + requestBody: + content: + application/json: + schema: + type: object + properties: + ruleset: + allOf: + - $ref: '#/components/schemas/Ruleset' + - type: object + required: + - name + required: + - ruleset + examples: + request: + summary: Request Example + value: + ruleset: + name: MySQL Clusters + team: + id: PWL7QXS + type: team_reference + responses: + '201': + description: The Ruleset that was created. + content: + application/json: + schema: + type: object + properties: + ruleset: + $ref: '#/components/schemas/Ruleset' + examples: + response: + summary: Response Example + value: + rulesets: + id: 0e84de00-9511-4380-9f4f-a7b568bb49a0 + name: MySQL Clusters + type: global + routing_keys: + - R0212P1QXGEIQE2NMTQ7L7WXD00DWHIN + self: 'https://api.pagerduty.com/rulesets/0e84de00-9511-4380-9f4f-a7b568bb49a0' + created_at: '2019-12-24T21:18:52Z' + creator: + type: user_reference + self: 'https://api.pagerduty.com/users/PABO808' + id: PABO808 + updated_at: '2019-12-25T14:54:23Z' + updater: + type: user_reference + self: 'https://api.pagerduty.com/users/PABO808' + id: PABO808 + team: + type: team_reference + self: 'https://api.pagerduty.com/teams/P3ZQXDF' + id: P3ZQXDF + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '/rulesets/{id}': + get: + x-pd-requires-scope: event_rules.read + tags: + - Rulesets + operationId: getRuleset + description: | + Get a Ruleset. + + > ### 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets) + + Scoped OAuth requires: `event_rules.read` + summary: Get a Ruleset + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: The Ruleset object. + content: + application/json: + schema: + type: object + properties: + ruleset: + $ref: '#/components/schemas/Ruleset' + examples: + response: + summary: Response Example + value: + ruleset: + id: 0e84de00-9511-4380-9f4f-a7b568bb49a0 + name: MySQL Clusters + type: global + routing_keys: + - R0212P1QXGEIQE2NMTQ7L7WXD00DWHIN + self: 'https://api.pagerduty.com/rulesets/0e84de00-9511-4380-9f4f-a7b568bb49a0' + created_at: '2019-12-24T21:18:52Z' + creator: + type: user_reference + self: 'https://api.pagerduty.com/users/PABO808' + id: PABO808 + updated_at: '2019-12-25T14:54:23Z' + updater: + type: user_reference + self: 'https://api.pagerduty.com/users/PABO808' + id: PABO808 + team: + type: team_reference + self: 'https://api.pagerduty.com/teams/P3ZQXDF' + id: P3ZQXDF + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + put: + x-pd-requires-scope: event_rules.write + tags: + - Rulesets + operationId: updateRuleset + description: | + Update a Ruleset. + + > ### 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets) + + Scoped OAuth requires: `event_rules.write` + summary: Update a Ruleset + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + ruleset: + $ref: '#/components/schemas/Ruleset' + required: + - ruleset + examples: + change_name: + summary: 'Example: Change name' + value: + ruleset: + name: MySQL Clusters + change_team: + summary: 'Example: Change team' + value: + ruleset: + team: + id: PWL7QXS + type: team_reference + responses: + '200': + description: The Ruleset that was updated. + content: + application/json: + schema: + type: object + properties: + ruleset: + $ref: '#/components/schemas/Ruleset' + examples: + response: + summary: Response Example + value: + rulesets: + id: 0e84de00-9511-4380-9f4f-a7b568bb49a0 + name: MySQL Clusters + type: global + routing_keys: + - R0212P1QXGEIQE2NMTQ7L7WXD00DWHIN + self: 'https://api.pagerduty.com/rulesets/0e84de00-9511-4380-9f4f-a7b568bb49a0' + created_at: '2019-12-24T21:18:52Z' + creator: + type: user_reference + self: 'https://api.pagerduty.com/users/PABO808' + id: PABO808 + updated_at: '2019-12-25T14:54:23Z' + updater: + type: user_reference + self: 'https://api.pagerduty.com/users/PABO808' + id: PABO808 + team: + type: team_reference + self: 'https://api.pagerduty.com/teams/P3ZQXDF' + id: P3ZQXDF + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' + delete: + x-pd-requires-scope: event_rules.write + tags: + - Rulesets + operationId: deleteRuleset + description: | + Delete a Ruleset. + + > ### 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets) + + Scoped OAuth requires: `event_rules.write` + summary: Delete a Ruleset + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '204': + description: The Ruleset was deleted successfully. + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' + '/rulesets/{id}/rules': + get: + x-pd-requires-scope: event_rules.read + tags: + - Rulesets + operationId: listRulesetEventRules + description: | + List all Event Rules on a Ruleset. + + > ### 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](https://developer.pagerduty.com/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` + summary: List Event Rules + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/id' + responses: + '200': + description: A paginated array of Event Rule objects. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + rules: + type: array + description: The paginated list of rules of the Ruleset. + items: + $ref: '#/components/schemas/EventRule' + examples: + response: + summary: Response Example + value: + rules: + - id: 14e56445-ebab-4dd0-ba9d-fc28a41b7e7b + position: 0 + disabled: false + catch_all: false + self: 'https://api.pagerduty.com/rulesets/0e84de00-9511-4380-9f4f-a7b568bb49a0/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b' + conditions: + operator: and + subconditions: + - operator: contains + parameters: + value: mysql + path: details.host + time_frame: + active_between: + start_time: 1577880000000 + end_time: 1580558400000 + actions: + annotate: + value: This incident was created by a Global Event Rule + route: + value: PI2KBWI + priority: + value: PCMUB6F + severity: + value: warning + extractions: + - target: dedup_key + source: details.error_summary + regex: Host (.*) is experiencing errors + - id: 0d819a5a-b714-4bae-9333-dc73ea0daefb + position: 1 + disabled: false + catch_all: true + self: 'https://api.pagerduty.com/rulesets/0e84de00-9511-4380-9f4f-a7b568bb49a0/rules/0d819a5a-b714-4bae-9333-dc73ea0daefb' + actions: + suppress: + value: true + severity: null + route: null + priority: null + extractions: [] + event_action: null + annotate: null + limit: 25 + offset: 0 + more: false + total: null + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + post: + x-pd-requires-scope: event_rules.write + tags: + - Rulesets + operationId: createRulesetEventRule + description: | + Create a new Event Rule. + + > ### 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](https://developer.pagerduty.com/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` + summary: Create an Event Rule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + rule: + $ref: '#/components/schemas/EventRule' + required: + - rule + examples: + request: + summary: Request Example + value: + rule: + id: 14e56445-ebab-4dd0-ba9d-fc28a41b7e7b + position: 0 + disabled: false + catch_all: false + conditions: + operator: and + subconditions: + - operator: contains + parameters: + value: mysql + path: details.host + time_frame: + active_between: + start_time: 1577880000000 + end_time: 1580558400000 + actions: + annotate: + value: This incident was created by a Global Event Rule + route: + value: PI2KBWI + priority: + value: PCMUB6F + severity: + value: warning + extractions: + - target: dedup_key + source: details.error_summary + regex: Host (.*) is experiencing errors + responses: + '201': + description: The Event Rule that was created. + content: + application/json: + schema: + type: object + properties: + rule: + $ref: '#/components/schemas/EventRule' + examples: + response: + summary: Response Example + value: + ruleset: + id: 14e56445-ebab-4dd0-ba9d-fc28a41b7e7b + position: 0 + disabled: false + catch_all: false + self: 'https://api.pagerduty.com/rulesets/0e84de00-9511-4380-9f4f-a7b568bb49a0/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b' + conditions: + operator: and + subconditions: + - operator: contains + parameters: + value: mysql + path: details.host + time_frame: + active_between: + start_time: 1577880000000 + end_time: 1580558400000 + actions: + annotate: + value: This incident was created by a Global Event Rule + route: + value: PI2KBWI + priority: + value: PCMUB6F + severity: + value: warning + extractions: + - target: dedup_key + source: details.error_summary + regex: Host (.*) is experiencing errors + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '409': + $ref: '#/components/responses/Conflict' + '/rulesets/{id}/rules/{rule_id}': + get: + x-pd-requires-scope: event_rules.read + tags: + - Rulesets + operationId: getRulesetEventRule + description: | + Get an Event Rule. + + > ### 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](https://developer.pagerduty.com/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` + summary: Get an Event Rule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/rule_id' + responses: + '200': + description: The Event Rule object. + content: + application/json: + schema: + type: object + properties: + rule: + $ref: '#/components/schemas/EventRule' + examples: + response: + summary: Response Example + value: + rule: + id: 14e56445-ebab-4dd0-ba9d-fc28a41b7e7b + position: 0 + disabled: false + catch_all: false + self: 'https://api.pagerduty.com/rulesets/0e84de00-9511-4380-9f4f-a7b568bb49a0/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b' + conditions: + operator: and + subconditions: + - operator: contains + parameters: + value: mysql + path: details.host + time_frame: + active_between: + start_time: 1577880000000 + end_time: 1580558400000 + actions: + annotate: + value: This incident was created by a Global Event Rule + route: + value: PI2KBWI + priority: + value: PCMUB6F + severity: + value: warning + extractions: + - target: dedup_key + template: '{{error_level}} error on host {{host}}' + variables: + - name: error_level + type: regex + parameters: + value: .*error level is (\w+)\. + path: payload.summary + - name: host + type: regex + parameters: + value: (.*)-USW2 + path: payload.host.human_name + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + put: + x-pd-requires-scope: event_rules.write + tags: + - Rulesets + operationId: updateRulesetEventRule + summary: Update an Event Rule + description: | + Update an Event Rule. Note that the endpoint supports partial updates, so any number of the writable fields can be provided. + + > ### 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](https://developer.pagerduty.com/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` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/rule_id' + requestBody: + content: + application/json: + schema: + type: object + properties: + rule: + $ref: '#/components/schemas/EventRule' + rule_id: + description: The id of the Event Rule to update. + type: string + required: + - rule_id + examples: + suppress_action: + summary: 'Example: Enable suppress action' + value: + rule_id: 7123bdd1-74e8-4aa7-aa38-4a9ebe123456 + rule: + actions: + suppress: + value: true + disable_rule: + summary: 'Example: Disable rule' + value: + rule_id: 7123bdd1-74e8-4aa7-aa38-4a9ebe123456 + rule: + disabled: true + actions: + suppress: + value: true + responses: + '200': + description: The Event Rule that was updated. + content: + application/json: + schema: + type: object + properties: + rule: + $ref: '#/components/schemas/EventRule' + examples: + response: + summary: Response Example + value: + rule: + id: 14e56445-ebab-4dd0-ba9d-fc28a41b7e7b + position: 0 + disabled: false + catch_all: false + self: 'https://api.pagerduty.com/rulesets/0e84de00-9511-4380-9f4f-a7b568bb49a0/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b' + conditions: + operator: and + subconditions: + - operator: contains + parameters: + value: mysql + path: details.host + time_frame: + active_between: + start_time: 1577880000000 + end_time: 1580558400000 + actions: + annotate: + value: This incident was created by a Global Event Rule + route: + value: PI2KBWI + priority: + value: PCMUB6F + severity: + value: warning + extractions: + - target: dedup_key + source: details.error_summary + regex: Host (.*) is experiencing errors + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' + delete: + x-pd-requires-scope: event_rules.write + tags: + - Rulesets + operationId: deleteRulesetEventRule + description: | + Delete an Event Rule. + + > ### 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets) + + Scoped OAuth requires: `event_rules.write` + summary: Delete an Event Rule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/rule_id' + responses: + '204': + description: The Event Rule was deleted successfully. + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/schedules.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/schedules.yaml new file mode 100644 index 0000000..06d5e6c --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/schedules.yaml @@ -0,0 +1,4291 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - schedules + description: | + A Schedule determines the time periods that users are On-Call. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + Schedule: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + type: + type: string + description: The type of object being created. + default: schedule + enum: + - schedule + schedule_layers: + type: array + description: A list of schedule layers. + items: + $ref: '#/components/schemas/ScheduleLayer' + time_zone: + type: string + format: activesupport-time-zone + description: The time zone of the schedule. + name: + type: string + description: The name of the schedule + description: + type: string + description: The description of the schedule + final_schedule: + $ref: '#/components/schemas/SubSchedule' + overrides_subschedule: + $ref: '#/components/schemas/SubSchedule' + escalation_policies: + type: array + readOnly: true + description: An array of all of the escalation policies that uses this schedule. + items: + $ref: '#/components/schemas/EscalationPolicyReference' + users: + type: array + readOnly: true + description: An array of all of the users on the schedule. + items: + $ref: '#/components/schemas/UserReference' + teams: + type: array + readOnly: true + description: An array of all of the teams on the schedule. + items: + $ref: '#/components/schemas/TeamReference' + required: + - time_zone + - type + example: + name: Daily Engineering Rotation + type: schedule + time_zone: America/New_York + description: Rotation schedule for engineering + schedule_layers: + - name: Night Shift + start: '2015-11-06T20:00:00-05:00' + end: '2016-11-06T20:00:00-05:00' + rotation_virtual_start: '2015-11-06T20:00:00-05:00' + rotation_turn_length_seconds: 86400 + users: + - user: + id: PXPGF42 + type: user_reference + restrictions: + - type: daily_restriction + start_time_of_day: '08:00:00' + duration_seconds: 32400 + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + ScheduleLayer: + type: object + properties: + id: + type: string + start: + type: string + format: date-time + description: The start time of this layer. + end: + type: string + format: date-time + description: 'The end time of this layer. If `null`, the layer does not end.' + users: + type: array + description: The ordered list of users on this layer. The position of the user on the list determines their order in the layer. + items: + $ref: '#/components/schemas/ScheduleLayerUser' + restrictions: + type: array + description: An array of restrictions for the layer. A restriction is a limit on which period of the day or week the schedule layer can accept assignments. + items: + $ref: '#/components/schemas/Restriction' + rotation_virtual_start: + type: string + format: date-time + description: The effective start time of the layer. This can be before the start time of the schedule. + rotation_turn_length_seconds: + type: integer + description: The duration of each on-call shift in seconds. + name: + type: string + description: The name of the schedule layer. + rendered_schedule_entries: + type: array + readOnly: true + description: This is a list of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated. + items: + $ref: '#/components/schemas/ScheduleLayerEntry' + rendered_coverage_percentage: + type: number + readOnly: true + description: The percentage of the time range covered by this layer. Returns null unless since or until are set. + required: + - start + - users + - rotation_virtual_start + - rotation_turn_length_seconds + SubSchedule: + type: object + properties: + name: + type: string + readOnly: true + description: The name of the subschedule + enum: + - Final Schedule + - Overrides + rendered_schedule_entries: + type: array + readOnly: true + description: This is a list of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated. + items: + $ref: '#/components/schemas/ScheduleLayerEntry' + rendered_coverage_percentage: + type: number + readOnly: true + description: The percentage of the time range covered by this layer. Returns null unless since or until are set. + required: + - name + EscalationPolicyReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - escalation_policy_reference + UserReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - user_reference + TeamReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - team_reference + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + ScheduleLayerUser: + type: object + properties: + user: + $ref: '#/components/schemas/UserReference' + required: + - user + Restriction: + type: object + properties: + type: + type: string + description: Specify the types of `restriction`. + enum: + - daily_restriction + - weekly_restriction + duration_seconds: + type: integer + description: The duration of the restriction in seconds. + start_time_of_day: + type: string + format: partial-time + description: 'The start time in HH:mm:ss format.' + start_day_of_week: + type: integer + description: 'Only required for use with a `weekly_restriction` restriction type. The first day of the weekly rotation schedule as [ISO 8601 day](https://en.wikipedia.org/wiki/ISO_week_date) (1 is Monday, etc.)' + minimum: 1 + maximum: 7 + discriminator: + propertyName: type + required: + - type + - duration_seconds + - start_time_of_day + ScheduleLayerEntry: + type: object + properties: + user: + $ref: '#/components/schemas/UserReference' + start: + type: string + format: date-time + readOnly: true + description: The start time of this entry. + end: + type: string + format: date-time + readOnly: true + description: 'The end time of this entry. If null, the entry does not end.' + required: + - start + - end + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + AuditRecordResponseSchema: + allOf: + - type: object + properties: + records: + type: array + items: + $ref: '#/components/schemas/AuditRecord' + response_metadata: + nullable: true + anyOf: + - $ref: '#/components/schemas/AuditMetadata' + required: + - records + - $ref: '#/components/schemas/CursorPagination' + AuditRecord: + type: object + readOnly: true + description: An Audit Trail record + properties: + id: + type: string + self: + type: string + nullable: true + description: Record URL. + execution_time: + type: string + format: date-time + description: 'The date/time the action executed, in ISO8601 format and millisecond precision.' + execution_context: + type: object + description: Action execution context + properties: + request_id: + type: string + nullable: true + description: Request Id + remote_address: + type: string + nullable: true + description: remote address + nullable: true + actors: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + method: + type: object + description: The method information + properties: + description: + type: string + nullable: true + truncated_token: + description: Truncated token containing the last 4 chars of the token's actual value. + type: string + nullable: true + example: 3xyz + type: + $ref: '#/components/parameters/audit_method_type/schema' + required: + - type + root_resource: + $ref: '#/components/schemas/Reference' + action: + type: string + example: create + details: + type: object + nullable: true + description: | + Additional details to provide further information about the action or + the resource that has been audited. + properties: + resource: + $ref: '#/components/schemas/Reference' + fields: + description: | + A set of fields that have been affected. + The fields that have not been affected MAY be returned. + type: array + nullable: true + items: + type: object + description: | + Information about the affected field. + When available, field's before and after values are returned: + + #### Resource creation + - `value` MAY be returned + + #### Resource update + - `value` MAY be returned + - `before_value` MAY be returned + + #### Resource deletion + - `before_value` MAY be returned + properties: + name: + type: string + description: Name of the resource field + example: name + description: + type: string + nullable: true + description: Human readable description of the resource field + example: First and Last name + value: + type: string + nullable: true + description: new or updated value of the field + example: Jonathan + before_value: + type: string + nullable: true + description: previous or deleted value of the field + example: John + required: + - name + references: + description: A set of references that have been affected. + type: array + nullable: true + items: + type: object + properties: + name: + type: string + description: Name of the reference field + example: team_members + description: + type: string + nullable: true + description: Human readable description of the references field + example: First and Last name + added: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + removed: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + required: + - name + required: + - resource + required: + - id + - execution_time + - method + - root_resource + - action + AuditMetadata: + type: object + properties: + messages: + type: array + nullable: true + items: + type: string + example: Message about the result + CursorPagination: + type: object + properties: + limit: + type: integer + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + readOnly: true + next_cursor: + type: string + description: | + An opaque string than will deliver the next set of results when provided as the `cursor` parameter in a subsequent request. A `null` value for this field indicates that there are no additional results. + example: dXNlcjaVMzc5V0ZYTlo= + nullable: true + readOnly: true + required: + - limit + - next_cursor + Override: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + id: + type: string + readOnly: true + start: + description: The start date and time for the override. + type: string + format: date-time + end: + description: The end date and time for the override. + type: string + format: date-time + user: + $ref: '#/components/schemas/UserReference' + required: + - start + - end + - user + example: + start: '2012-07-01T00:00:00-04:00' + end: '2012-07-02T00:00:00-04:00' + user: + id: PEYSGVF + type: user_reference + User: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + name: + type: string + description: The name of the user. + maxLength: 100 + type: + type: string + description: The type of object being created. + default: user + enum: + - user + email: + type: string + format: email + description: The user's email address. + minLength: 6 + maxLength: 100 + time_zone: + type: string + format: tzinfo + description: 'The preferred time zone name. If null, the account''s time zone will be used.' + color: + type: string + description: The schedule color. + role: + description: 'The user role. Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`.' + type: string + enum: + - admin + - limited_user + - observer + - owner + - read_only_user + - restricted_access + - read_only_limited_user + - user + avatar_url: + type: string + format: url + description: The URL of the user's avatar. + readOnly: true + description: + type: string + description: The user's bio. + nullable: true + invitation_sent: + type: boolean + readOnly: true + description: 'If true, the user has an outstanding invitation.' + job_title: + type: string + description: The user's title. + maxLength: 100 + teams: + type: array + readOnly: true + description: The list of teams to which the user belongs. Account must have the `teams` ability to set this. + items: + $ref: '#/components/schemas/TeamReference' + contact_methods: + type: array + readOnly: true + description: The list of contact methods for the user. + items: + $ref: '#/components/schemas/ContactMethodReference' + notification_rules: + readOnly: true + type: array + description: The list of notification rules for the user. + items: + $ref: '#/components/schemas/NotificationRuleReference' + license: + description: The License assigned to the User + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - license_reference + required: + - name + - email + - type + example: + type: user + name: Earline Greenholt + email: 125.greenholt.earline@graham.name + time_zone: America/Lima + color: green + role: admin + job_title: Director of Engineering + avatar_url: 'https://secure.gravatar.com/avatar/1d1a39d4635208d5664082a6c654a73f.png?d=mm&r=PG' + description: I'm the boss + ContactMethodReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - email_contact_method_reference + - phone_contact_method_reference + - push_notification_contact_method_reference + - sms_contact_method_reference + NotificationRuleReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - assignment_notification_rule_reference + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + PaymentRequired: + description: | + Account does not have the abilities to perform the action. Please review the response for the required abilities. + You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + InternalServerError: + description: Internal Server Error the PagerDuty server experienced an error. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + schedules: + id: pagerduty.schedules.schedules + name: schedules + title: Schedules + methods: + list_schedules: + operation: + $ref: '#/paths/~1schedules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.schedules + _list_schedules: + operation: + $ref: '#/paths/~1schedules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_schedule: + operation: + $ref: '#/paths/~1schedules/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_schedule: + operation: + $ref: '#/paths/~1schedules~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.schedule + _get_schedule: + operation: + $ref: '#/paths/~1schedules~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_schedule: + operation: + $ref: '#/paths/~1schedules~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_schedule: + operation: + $ref: '#/paths/~1schedules~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create_schedule_preview: + operation: + $ref: '#/paths/~1schedules~1preview/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schedules/methods/get_schedule' + - $ref: '#/components/x-stackQL-resources/schedules/methods/list_schedules' + insert: + - $ref: '#/components/x-stackQL-resources/schedules/methods/create_schedule' + - $ref: '#/components/x-stackQL-resources/schedules/methods/create_schedule_preview' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/schedules/methods/delete_schedule' + audit_records: + id: pagerduty.schedules.audit_records + name: audit_records + title: Audit Records + methods: + list_schedules_audit_records: + operation: + $ref: '#/paths/~1schedules~1{id}~1audit~1records/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.records + _list_schedules_audit_records: + operation: + $ref: '#/paths/~1schedules~1{id}~1audit~1records/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/audit_records/methods/list_schedules_audit_records' + insert: [] + update: [] + delete: [] + overrides: + id: pagerduty.schedules.overrides + name: overrides + title: Overrides + methods: + list_schedule_overrides: + operation: + $ref: '#/paths/~1schedules~1{id}~1overrides/get' + response: + mediaType: application/json + openAPIDocKey: '201' + objectKey: $.overrides + _list_schedule_overrides: + operation: + $ref: '#/paths/~1schedules~1{id}~1overrides/get' + response: + mediaType: application/json + openAPIDocKey: '201' + create_schedule_override: + operation: + $ref: '#/paths/~1schedules~1{id}~1overrides/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete_schedule_override: + operation: + $ref: '#/paths/~1schedules~1{id}~1overrides~1{override_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/overrides/methods/list_schedule_overrides' + insert: + - $ref: '#/components/x-stackQL-resources/overrides/methods/create_schedule_override' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/overrides/methods/delete_schedule_override' + users: + id: pagerduty.schedules.users + name: users + title: Users + methods: + list_schedule_users: + operation: + $ref: '#/paths/~1schedules~1{id}~1users/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.users + _list_schedule_users: + operation: + $ref: '#/paths/~1schedules~1{id}~1users/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/users/methods/list_schedule_users' + insert: [] + update: [] + delete: [] +paths: + /schedules: + get: + tags: + - Schedules + x-pd-requires-scope: schedules.read + operationId: listSchedules + description: | + List the on-call schedules. + + A Schedule determines the time periods that users are On-Call. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules) + + Scoped OAuth requires: `schedules.read` + summary: List schedules + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/include_schedules' + responses: + '200': + description: A paginated array of schedule objects. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + schedules: + type: array + items: + $ref: '#/components/schemas/Schedule' + required: + - schedules + examples: + Basic Example: + value: + schedules: + - id: PI7DH85 + type: schedule + summary: Daily Engineering Rotation + self: 'https://api.pagerduty.com/schedules/PI7DH85' + html_url: 'https://subdomain.pagerduty.com/schedules/PI7DH85' + name: Daily Engineering Rotation + time_zone: America/New_York + description: Rotation schedule for engineering + escalation_policies: + - id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + users: + - id: PEYSGVF + type: user_reference + summary: PagerDuty Admin + self: 'https://api.pagerduty.com/users/PEYSGVF' + html_url: 'https://subdomain.pagerduty.com/users/PEYSGVF' + limit: 100 + offset: 0 + more: false + total: null + With Schedule Layers: + summary: With Schedule Layers Included + value: + schedules: + - id: PI7DH85 + type: schedule + summary: Daily Engineering Rotation + self: 'https://api.pagerduty.com/schedules/PI7DH85' + html_url: 'https://subdomain.pagerduty.com/schedules/PI7DH85' + name: Daily Engineering Rotation + time_zone: America/New_York + description: Rotation schedule for engineering + escalation_policies: + - id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + users: + - id: PEYSGVF + type: user_reference + summary: PagerDuty Admin + self: 'https://api.pagerduty.com/users/PEYSGVF' + html_url: 'https://subdomain.pagerduty.com/users/PEYSGVF' + schedule_layers: + - name: Night Shift + start: '2015-11-06T20:00:00-05:00' + end: '2016-11-06T20:00:00-05:00' + rotation_virtual_start: '2015-11-06T20:00:00-05:00' + rotation_turn_length_seconds: 86400 + users: + - user: + id: PEYSGVF + type: user_reference + summary: PagerDuty Admin + self: 'https://api.pagerduty.com/users/PEYSGVF' + html_url: 'https://subdomain.pagerduty.com/users/PEYSGVF' + restrictions: + - type: daily_restriction + start_time_of_day: '08:00:00' + duration_seconds: 32400 + limit: 100 + offset: 0 + more: false + total: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + tags: + - Schedules + x-pd-requires-scope: schedules.write + operationId: createSchedule + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules) + + Scoped OAuth requires: `schedules.write` + summary: Create a schedule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/schedule_overflow' + requestBody: + content: + application/json: + schema: + type: object + properties: + schedule: + $ref: '#/components/schemas/Schedule' + required: + - schedule + examples: + request: + summary: Request Example + value: + schedule: + name: Daily Engineering Rotation + type: schedule + time_zone: America/New_York + description: Rotation schedule for engineering + schedule_layers: + - name: Night Shift + start: '2015-11-06T20:00:00-05:00' + rotation_virtual_start: '2015-11-06T20:00:00-05:00' + rotation_turn_length_seconds: 86400 + users: + - user: + id: PXPGF42 + type: user_reference + restrictions: + - type: daily_restriction + start_time_of_day: '08:00:00' + duration_seconds: 32400 + description: The schedule to be created. + responses: + '201': + description: The schedule object created. + content: + application/json: + schema: + type: object + properties: + schedule: + $ref: '#/components/schemas/Schedule' + required: + - schedule + examples: + response: + summary: Response Example + value: + schedule: + id: PI7DH85 + type: schedule + summary: Daily Engineering Rotation + self: 'https://api.pagerduty.com/schedules/PI7DH85' + html_url: 'https://subdomain.pagerduty.com/schedules/PI7DH85' + name: Daily Engineering Rotation + time_zone: America/New_York + description: Rotation schedule for engineering + escalation_policies: + - id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + users: + - id: PEYSGVF + type: user_reference + summary: PagerDuty Admin + self: 'https://api.pagerduty.com/users/PEYSGVF' + html_url: 'https://subdomain.pagerduty.com/users/PEYSGVF' + teams: [] + schedule_layers: + - name: Layer 1 + rendered_schedule_entries: [] + id: PG68P1M + start: '2015-11-06T20:00:00-05:00' + rotation_virtual_start: '2015-11-06T20:00:00-05:00' + rotation_turn_length_seconds: 86400 + users: + - user: + id: PEYSGVF + type: user_reference + summary: PagerDuty Admin + self: 'https://api.pagerduty.com/users/PEYSGVF' + html_url: 'https://subdomain.pagerduty.com/users/PEYSGVF' + restrictions: + - type: daily_restriction + start_time_of_day: '08:00:00' + duration_seconds: 32400 + overrides_subschedule: + name: Overrides + rendered_schedule_entries: [] + final_schedule: + name: Final Schedule + rendered_schedule_entries: [] + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/schedules/{id}': + get: + tags: + - Schedules + x-pd-requires-scope: schedules.read + operationId: getSchedule + description: | + Show detailed information about a schedule, including entries for each layer and sub-schedule. + Scoped OAuth requires: `schedules.read` + summary: Get a schedule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/time_zone' + - $ref: '#/components/parameters/schedule_since' + - $ref: '#/components/parameters/schedule_until' + - $ref: '#/components/parameters/id' + responses: + '200': + description: The schedule object. + content: + application/json: + schema: + type: object + properties: + schedule: + $ref: '#/components/schemas/Schedule' + required: + - schedule + examples: + response: + summary: Response Example + value: + schedule: + id: PI7DH85 + type: schedule + summary: Daily Engineering Rotation + self: 'https://api.pagerduty.com/schedules/PI7DH85' + html_url: 'https://subdomain.pagerduty.com/schedules/PI7DH85' + name: Daily Engineering Rotation + time_zone: America/New_York + description: Rotation schedule for engineering + escalation_policies: + - id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + users: + - id: PXPGF42 + type: user_reference + summary: Regina Phalange + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + schedule_layers: + - name: Layer 1 + rendered_schedule_entries: + - start: '2015-11-09T08:00:00-05:00' + end: '2015-11-09T17:00:00-05:00' + user: + id: PXPGF42 + type: user_reference + summary: Regina Phalange + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + rendered_coverage_percentage: 37.5 + id: PG68P1M + start: '2015-11-06T21:00:00-05:00' + rotation_virtual_start: '2015-11-06T20:00:00-05:00' + rotation_turn_length_seconds: 86400 + users: + - user: + id: PXPGF42 + type: user_reference + summary: Regina Phalange + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + restrictions: + - type: daily_restriction + start_time_of_day: '08:00:00' + duration_seconds: 32400 + overrides_subschedule: + name: Overrides + rendered_schedule_entries: [] + rendered_coverage_percentage: 0 + final_schedule: + name: Final Schedule + rendered_schedule_entries: + - start: '2015-11-10T08:00:00-05:00' + end: '2015-11-10T17:00:00-05:00' + user: + id: PXPGF42 + type: user_reference + summary: Regina Phalange + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + rendered_coverage_percentage: 37.5 + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + delete: + tags: + - Schedules + x-pd-requires-scope: schedules.write + operationId: deleteSchedule + description: | + Delete an on-call schedule. + + A Schedule determines the time periods that users are On-Call. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules) + + Scoped OAuth requires: `schedules.write` + summary: Delete a schedule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '204': + description: The schedule was deleted successfully. + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + tags: + - Schedules + x-pd-requires-scope: schedules.write + operationId: updateSchedule + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules) + + Scoped OAuth requires: `schedules.write` + summary: Update a schedule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/schedule_overflow' + requestBody: + content: + application/json: + schema: + type: object + properties: + schedule: + $ref: '#/components/schemas/Schedule' + required: + - schedule + examples: + request: + summary: Request Example + value: + schedule: + name: Daily Engineering Rotation + type: schedule + time_zone: America/New_York + description: Rotation schedule for engineering + schedule_layers: + - name: Night Shift + start: '2015-11-06T20:00:00-05:00' + end: '2016-11-06T20:00:00-05:00' + rotation_virtual_start: '2015-11-06T20:00:00-05:00' + rotation_turn_length_seconds: 86400 + users: + - user: + id: PXPGF42 + type: user_reference + restrictions: + - type: daily_restriction + start_time_of_day: '08:00:00' + duration_seconds: 32400 + description: The schedule to be updated. + responses: + '200': + description: The updated schedule. + content: + application/json: + schema: + type: object + properties: + schedule: + $ref: '#/components/schemas/Schedule' + required: + - schedule + examples: + response: + summary: Response Example + value: + schedule: + id: PI7DH85 + type: schedule + summary: Daily Engineering Rotation + self: 'https://api.pagerduty.com/schedules/PI7DH85' + html_url: 'https://subdomain.pagerduty.com/schedules/PI7DH85' + name: Daily Engineering Rotation + time_zone: America/New_York + description: Rotation schedule for engineering + escalation_policies: + - id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + users: + - id: PXPGF42 + type: user_reference + summary: Regina Phalange + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + schedule_layers: + - name: Layer 1 + rendered_schedule_entries: [] + id: PG68P1M + start: '2015-11-06T20:00:00-05:00' + rotation_virtual_start: '2015-11-06T20:00:00-05:00' + rotation_turn_length_seconds: 86400 + users: + - user: + id: PXPGF42 + type: user_reference + summary: Regina Phalange + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + restrictions: + - type: daily_restriction + start_time_of_day: '08:00:00' + duration_seconds: 32400 + overrides_subschedule: + name: Overrides + rendered_schedule_entries: [] + final_schedule: + name: Final Schedule + rendered_schedule_entries: [] + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/schedules/{id}/audit/records': + get: + x-pd-requires-scope: audit_records.read + tags: + - Schedules + operationId: listSchedulesAuditRecords + summary: List audit records for a schedule + description: | + 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` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/cursor_limit' + - $ref: '#/components/parameters/cursor_cursor' + - $ref: '#/components/parameters/audit_since' + - $ref: '#/components/parameters/audit_until' + responses: + '200': + description: Records matching the query criteria. + content: + application/json: + schema: + $ref: '#/components/schemas/AuditRecordResponseSchema' + examples: + response: + $ref: '#/components/examples/AuditRecordScheduleResponse' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '/schedules/{id}/overrides': + get: + tags: + - Schedules + x-pd-requires-scope: schedules.read + operationId: listScheduleOverrides + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules) + + Scoped OAuth requires: `schedules.read` + summary: List overrides + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/since_schedules' + - $ref: '#/components/parameters/until_schedules' + - $ref: '#/components/parameters/editable_schedules' + - $ref: '#/components/parameters/overflow_schedules' + responses: + '201': + description: The collection of override objects returned by the query. + content: + application/json: + schema: + type: object + properties: + overrides: + type: array + items: + $ref: '#/components/schemas/Override' + required: + - overrides + examples: + response: + summary: Response Example + value: + overrides: + - id: PQ47DCP + start: '2012-07-01T00:00:00-04:00' + end: '2012-07-02T00:00:00-04:00' + user: + id: PEYSGVF + type: user_reference + summary: Aurelio Rice + self: 'https://api.pagerduty.com/users/PEYSGVF' + html_url: 'https://subdomain.pagerduty.com/users/PEYSGVF' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + tags: + - Schedules + x-pd-requires-scope: schedules.write + operationId: createScheduleOverride + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules) + + Scoped OAuth requires: `schedules.write` + summary: Create one or more overrides + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + description: '' + type: object + properties: + overrides: + type: array + items: + $ref: '#/components/schemas/Override' + examples: + request: + summary: Request Example + value: + overrides: + - start: '2012-07-01T00:00:00-04:00' + end: '2012-07-02T00:00:00-04:00' + user: + id: PEYSGVA + type: user_reference + time_zone: UTC + - start: '2012-07-03T00:00:00-04:00' + end: '2012-07-04T00:00:00-04:00' + user: + id: PEYSGVF + type: user_reference + time_zone: UTC + description: The overrides to be created + required: true + responses: + '201': + description: A list of overrides requested and a status code indicating whether they were created or rejected + content: + application/json: + schema: + type: array + description: '' + minItems: 1 + uniqueItems: true + items: + type: object + properties: + status: + type: number + description: 'HTTP Status Code reflecting the result of creating this specific override, e.g. 201 for success, 400 for invalid parameters.' + errors: + type: array + description: 'If present, an array of strings representing human-readable explanations for errors found.' + items: + type: string + override: + $ref: '#/components/schemas/Override' + required: + - override + examples: + response: + summary: Response Example + value: + - status: 201 + override: + start: '2021-03-09T05:00:00Z' + end: '2021-03-09T17:00:00Z' + user: + id: P37CSDJ + type: user_reference + summary: Scott + self: 'https://api.pd-staging.com/users/P37CSDJ' + html_url: 'https://pdt-braythwayt.pd-staging.com/users/P37CSDJ' + id: Q3X6MJ1LUKD6QW + - status: 201 + override: + start: '2021-03-10T05:00:00Z' + end: '2021-03-10T17:00:00Z' + user: + id: P37CSDJ + type: user_reference + summary: Scott + self: 'https://api.pd-staging.com/users/P37CSDJ' + html_url: 'https://pdt-braythwayt.pd-staging.com/users/P37CSDJ' + id: Q37A85CJZP1DTT + - status: 400 + errors: + - Override must end after its start + override: + start: '2021-03-11T05:00:00Z' + end: '2021-03-11T05:00:00Z' + user: + id: P37CSDJ + type: user_reference + summary: Scott + self: 'https://api.pd-staging.com/users/P37CSDJ' + html_url: 'https://pdt-braythwayt.pd-staging.com/users/P37CSDJ' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/schedules/{id}/overrides/{override_id}': + delete: + tags: + - Schedules + x-pd-requires-scope: schedules.write + operationId: deleteScheduleOverride + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules) + + Scoped OAuth requires: `schedules.write` + summary: Delete an override + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/schedule_override_id' + responses: + '200': + description: The override was truncated. + '204': + description: The override was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/schedules/{id}/users': + get: + tags: + - Schedules + x-pd-requires-scope: users.read + operationId: listScheduleUsers + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules) + + Scoped OAuth requires: `users.read` + summary: List users on call. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/until' + responses: + '200': + description: The users on the given schedule. + content: + application/json: + schema: + type: object + properties: + users: + type: array + readOnly: true + items: + $ref: '#/components/schemas/User' + required: + - users + examples: + response: + summary: Response Example + value: + users: + - id: PAM4FGS + type: user + summary: Kyler Kuhn + self: 'https://api.pagerduty.com/users/PAM4FGS' + html_url: 'https://subdomain.pagerduty.com/users/PAM4FGS' + name: Kyler Kuhn + email: 126_dvm_kyler_kuhn@beahan.name + time_zone: Asia/Hong_Kong + color: red + role: admin + avatar_url: 'https://secure.gravatar.com/avatar/47857d059adacf9a41dc4030c2e14b0a.png?d=mm&r=PG' + description: Engineer based in HK + invitation_sent: false + contact_methods: + - id: PVMGSML + type: email_contact_method_reference + summary: Work + self: 'https://api.pagerduty.com/users/PAM4FGS/contact_methods/PVMGSMLL' + notification_rules: + - id: P8GRWKZ + type: assignment_notification_rule_reference + summary: Default + self: 'https://api.pagerduty.com/users/PAM4FGS/notification_rules/P8GRWKZ' + html_url: null + job_title: Senior Engineer + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + - id: PXPGF42 + type: user + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + name: Earline Greenholt + email: 125.greenholt.earline@graham.name + time_zone: America/Lima + color: green + role: admin + avatar_url: 'https://secure.gravatar.com/avatar/a8b714a39626f2444ee05990b078995f.png?d=mm&r=PG' + description: I'm the boss + invitation_sent: false + contact_methods: + - id: PTDVERC + type: email_contact_method_reference + summary: Default + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PTDVERC' + notification_rules: + - id: P8GRWKK + type: assignment_notification_rule_reference + summary: Default + self: 'https://api.pagerduty.com/users/PXPGF42/notification_rules/P8GRWKK' + html_url: null + job_title: Director of Engineering + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + /schedules/preview: + post: + tags: + - Schedules + x-pd-requires-scope: schedules.write + operationId: createSchedulePreview + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules) + + Scoped OAuth requires: `schedules.write` + summary: Preview a schedule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/until' + - $ref: '#/components/parameters/schedule_overflow' + requestBody: + content: + application/json: + schema: + type: object + properties: + schedule: + $ref: '#/components/schemas/Schedule' + required: + - schedule + examples: + request: + summary: Request Example + value: + schedule: + name: Daily Engineering Rotation + type: schedule + time_zone: America/New_York + description: Rotation schedule for engineering + schedule_layers: + - name: Night Shift + start: '2015-11-06T20:00:00-05:00' + end: '2016-11-06T20:00:00-05:00' + rotation_virtual_start: '2015-11-06T20:00:00-05:00' + rotation_turn_length_seconds: 86400 + users: + - user: + id: PXPGF42 + type: user_reference + restrictions: + - type: daily_restriction + start_time_of_day: '08:00:00' + duration_seconds: 32400 + description: The schedule to be previewed. + responses: + '200': + description: What the schedule will look like if posted. + content: + application/json: + schema: + type: object + properties: + schedule: + $ref: '#/components/schemas/Schedule' + required: + - schedule + examples: + response: + summary: Response Example + value: + schedule: + id: PI7DH85 + type: schedule + summary: Daily Engineering Rotation + self: 'https://api.pagerduty.com/schedules/PI7DH85' + html_url: 'https://subdomain.pagerduty.com/schedules/PI7DH85' + name: Daily Engineering Rotation + time_zone: America/New_York + description: Rotation schedule for engineering + escalation_policies: [] + users: + - id: PXPGF42 + type: user_reference + summary: Regina Phalange + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + schedule_layers: + - name: Layer 1 + rendered_schedule_entries: [] + id: PG68P1M + start: '2015-11-06T20:00:00-05:00' + rotation_virtual_start: '2015-11-06T20:00:00-05:00' + rotation_turn_length_seconds: 86400 + users: + - user: + id: PXPGF42 + type: user_reference + summary: Regina Phalange + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + restrictions: + - type: daily_restriction + start_time_of_day: '08:00:00' + duration_seconds: 32400 + overrides_subschedule: + name: Overrides + rendered_schedule_entries: [] + final_schedule: + name: Final Schedule + rendered_schedule_entries: [] + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/service_dependencies.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/service_dependencies.yaml new file mode 100644 index 0000000..78078ae --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/service_dependencies.yaml @@ -0,0 +1,2951 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - service_dependencies + description: Service_Dependencies +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + technical_services: + id: pagerduty.service_dependencies.technical_services + name: technical_services + title: Technical Services + methods: + create_service_dependency: + operation: + $ref: '#/paths/~1service_dependencies~1associate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_service_dependency: + operation: + $ref: '#/paths/~1service_dependencies~1disassociate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_technical_service_service_dependencies: + operation: + $ref: '#/paths/~1service_dependencies~1technical_services~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.relationships + _get_technical_service_service_dependencies: + operation: + $ref: '#/paths/~1service_dependencies~1technical_services~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/technical_services/methods/get_technical_service_service_dependencies' + insert: + - $ref: '#/components/x-stackQL-resources/technical_services/methods/create_service_dependency' + update: [] + delete: [] + business_services: + id: pagerduty.service_dependencies.business_services + name: business_services + title: Business Services + methods: + get_business_service_service_dependencies: + operation: + $ref: '#/paths/~1service_dependencies~1business_services~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.relationships + _get_business_service_service_dependencies: + operation: + $ref: '#/paths/~1service_dependencies~1business_services~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/business_services/methods/get_business_service_service_dependencies' + insert: [] + update: [] + delete: [] +paths: + /service_dependencies/associate: + post: + x-pd-requires-scope: services.write + tags: + - Service Dependencies + operationId: createServiceDependency + summary: Associate service dependencies + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services) + + Scoped OAuth requires: `services.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + requestBody: + content: + application/json: + schema: + type: object + properties: + relationships: + type: array + description: List of all service dependencies to be created. + items: + type: object + properties: + supporting_service: + type: object + description: The reference to the service that supports the dependent service. + properties: + id: + type: string + type: + type: string + dependent_service: + type: object + description: The reference to the service that is dependent on the supporting service. + properties: + id: + type: string + type: + type: string + examples: + request: + summary: Request Example + value: + relationships: + - supporting_service: + id: P7AD56 + type: service + dependent_service: + id: P99DJ6 + type: business_service + - supporting_service: + id: DT93K1 + type: business_service + dependent_service: + id: RS34D9 + type: service + responses: + '200': + description: An array of service relationships that were successfully associated. + content: + application/json: + schema: + type: object + properties: + relationships: + type: array + description: List of all the technical service's dependencies + items: + type: object + properties: + supporting_service: + type: object + description: The reference to the service that supports the technical service. + properties: + id: + type: string + type: + type: string + dependent_service: + type: object + description: The reference to the service that is dependent on the technical service. + properties: + id: + type: string + type: + type: string + id: + type: string + type: + type: string + examples: + relationships: + summary: Response Example + value: + relationships: + - supporting_service: + id: P7AD56 + type: technical_service_reference + dependent_service: + id: P99DJ6 + type: business_service_reference + id: DQVP7E6G0E8AC3NR + type: service_dependency + - supporting_service: + id: DT93K1 + type: business_service_reference + dependent_service: + id: RS34D9 + type: technical_service_reference + id: D3PG0QVACE87RNE6 + type: service_dependency + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '/service_dependencies/business_services/{id}': + get: + x-pd-requires-scope: services.read + tags: + - Service Dependencies + operationId: getBusinessServiceServiceDependencies + summary: Get Business Service dependencies + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services) + + Scoped OAuth requires: `services.read` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: An array of service relationships. + content: + application/json: + schema: + type: object + properties: + relationships: + type: array + description: List of all the Business Service's dependencies. + items: + type: object + properties: + supporting_service: + type: object + description: The reference to the service that supports the Business Service. + properties: + id: + type: string + type: + type: string + dependent_service: + type: object + description: The reference to the service that is dependent on the Business Service. + properties: + id: + type: string + type: + type: string + id: + type: string + type: + type: string + examples: + relationships: + summary: Response Example + value: + relationships: + - supporting_service: + id: P7AD56 + type: technical_service_reference + dependent_service: + id: P99DJ6 + type: business_service_reference + id: DQVP7E6G0E8AC3NR + type: service_dependency + - supporting_service: + id: P99DJ6 + type: business_service_reference + dependent_service: + id: RS34D9 + type: business_service_reference + id: D3PG0QVACE87RNE6 + type: service_dependency + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + /service_dependencies/disassociate: + post: + x-pd-requires-scope: services.write + tags: + - Service Dependencies + operationId: deleteServiceDependency + summary: Disassociate service dependencies + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services) + + Scoped OAuth requires: `services.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + requestBody: + content: + application/json: + schema: + type: object + properties: + relationships: + type: array + description: List of all service dependencies to be deleted. + items: + type: object + properties: + supporting_service: + type: object + description: The reference to the service that supports the dependent service. + properties: + id: + type: string + type: + type: string + dependent_service: + type: object + description: The reference to the service that is dependent on the supporting service. + properties: + id: + type: string + type: + type: string + examples: + request: + summary: Request Example + value: + relationships: + - supporting_service: + id: P7AD56 + type: service + dependent_service: + id: P99DJ6 + type: business_service + - supporting_service: + id: DT93K1 + type: business_service + dependent_service: + id: RS34D9 + type: service + responses: + '200': + description: An array of service relationships that were successfully disassociated. + content: + application/json: + schema: + type: object + properties: + relationships: + type: array + description: List of all the technical service's dependencies + items: + type: object + properties: + supporting_service: + type: object + description: The reference to the service that supports the technical service. + properties: + id: + type: string + type: + type: string + dependent_service: + type: object + description: The reference to the service that is dependent on the technical service. + properties: + id: + type: string + type: + type: string + id: + type: string + type: + type: string + examples: + relationships: + summary: Example Response + value: + relationships: + - supporting_service: + id: P7AD56 + type: technical_service_reference + dependent_service: + id: P99DJ6 + type: business_service_reference + id: DQVP7E6G0E8AC3NR + type: service_dependency + - supporting_service: + id: DT93K1 + type: business_service_reference + dependent_service: + id: RS34D9 + type: technical_service_reference + id: D3PG0QVACE87RNE6 + type: service_dependency + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '/service_dependencies/technical_services/{id}': + get: + x-pd-requires-scope: services.read + tags: + - Service Dependencies + operationId: getTechnicalServiceServiceDependencies + summary: Get technical service dependencies + description: | + Get all immediate dependencies of any technical service. + Technical services are also known as `services`. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services) + + Scoped OAuth requires: `services.read` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: An array of service relationships. + content: + application/json: + schema: + type: object + properties: + relationships: + type: array + description: List of all the technical service's dependencies + items: + type: object + properties: + supporting_service: + type: object + description: The reference to the service that supports the technical service. + properties: + id: + type: string + type: + type: string + dependent_service: + type: object + description: The reference to the service that is dependent on the technical service. + properties: + id: + type: string + type: + type: string + id: + type: string + type: + type: string + examples: + relationships: + summary: Response Example + value: + relationships: + - supporting_service: + id: P7AD56 + type: technical_service_reference + dependent_service: + id: P99DJ6 + type: business_service_reference + id: DQVP7E6G0E8AC3NR + type: service_dependency + - supporting_service: + id: R87DK4 + type: technical_service_reference + dependent_service: + id: P7AD56 + type: technical_service_reference + id: D3PG0QVACE87RNE6 + type: service_dependency + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/services.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/services.yaml new file mode 100644 index 0000000..b3ecf87 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/services.yaml @@ -0,0 +1,5085 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - services + description: | + A Service may represent an application, component, or team you wish to open incidents against. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + Service: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + type: + type: string + description: The type of object being created. + default: service + enum: + - service + name: + type: string + description: The name of the service. + description: + type: string + description: The user-provided description of the service. + auto_resolve_timeout: + type: integer + description: 'Time in seconds that an incident is automatically resolved if left open for that long. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature.' + default: 14400 + acknowledgement_timeout: + type: integer + description: 'Time in seconds that an incident changes to the Triggered State after being Acknowledged. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature.' + default: 1800 + created_at: + type: string + format: date-time + description: The date/time when this service was created + readOnly: true + status: + type: string + description: | + The current state of the Service. Valid statuses are: + + + - `active`: The service is enabled and has no open incidents. This is the only status a service can be created with. + - `warning`: The service is enabled and has one or more acknowledged incidents. + - `critical`: The service is enabled and has one or more triggered incidents. + - `maintenance`: The service is under maintenance, no new incidents will be triggered during maintenance mode. + - `disabled`: The service is disabled and will not have any new triggered incidents. + enum: + - active + - warning + - critical + - maintenance + - disabled + default: active + last_incident_timestamp: + type: string + format: date-time + description: The date/time when the most recent incident was created for this service. + readOnly: true + escalation_policy: + $ref: '#/components/schemas/EscalationPolicyReference' + response_play: + deprecated: true + description: Response plays associated with this service. + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - response_play_reference + teams: + type: array + description: The set of teams associated with this service. + items: + $ref: '#/components/schemas/TeamReference' + readOnly: true + integrations: + type: array + description: 'An array containing Integration objects that belong to this service. If `integrations` is passed as an argument, these are full objects - otherwise, these are references.' + items: + $ref: '#/components/schemas/IntegrationReference' + readOnly: true + incident_urgency_rule: + $ref: '#/components/schemas/IncidentUrgencyRule' + support_hours: + $ref: '#/components/schemas/SupportHours' + scheduled_actions: + type: array + description: An array containing scheduled actions for the service. + items: + $ref: '#/components/schemas/ScheduledAction' + addons: + type: array + description: The array of Add-ons associated with this service. + items: + $ref: '#/components/schemas/AddonReference' + readOnly: true + alert_creation: + type: string + description: | + Whether a service creates only incidents, or both alerts and incidents. A service must create alerts in order to enable incident merging. + * "create_incidents" - The service will create one incident and zero alerts for each incoming event. + * "create_alerts_and_incidents" - The service will create one incident and one associated alert for each incoming event. + enum: + - create_incidents + - create_alerts_and_incidents + alert_grouping_parameters: + $ref: '#/components/schemas/AlertGroupingParameters' + alert_grouping: + type: string + deprecated: true + description: | + Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. There are three available options: + * null - No alert grouping on the service. Each alert will create a separate incident; + * "time" - All alerts within a specified duration will be grouped into the same incident. This duration is set in the `alert_grouping_timeout` setting (described below). Available on Standard, Enterprise, and Event Intelligence plans; + * "intelligent" - Alerts will be intelligently grouped based on a machine learning model that looks at the alert summary, timing, and the history of grouped alerts. Available on Enterprise and Event Intelligence plans + enum: + - time + - intelligent + alert_grouping_timeout: + type: integer + deprecated: true + description: | + The duration in minutes within which to automatically group incoming alerts. This setting applies only when `alert_grouping` is set to `time`. To continue grouping alerts until the Incident is resolved, set this value to `0`. + auto_pause_notifications_parameters: + $ref: '#/components/schemas/AutoPauseNotificationsParameters' + required: + - type + - escalation_policy + example: + id: PSI2I2O + summary: string + type: service + self: string + html_url: string + name: My Web App + description: My cool web application that does things. + auto_resolve_timeout: 14400 + acknowledgement_timeout: 600 + status: active + escalation_policy: + id: PWIP6CQ + type: escalation_policy_reference + response_play: + id: 1677af3c-44cf-50f4-6c68-818f7f514802 + type: response_play_reference + incident_urgency_rule: + type: use_support_hours + during_support_hours: + type: constant + urgency: high + outside_support_hours: + type: constant + urgency: low + support_hours: + type: fixed_time_per_day + time_zone: America/Lima + start_time: '09:00:00' + end_time: '17:00:00' + days_of_week: + - 1 + - 2 + - 3 + - 4 + - 5 + scheduled_actions: + - type: urgency_change + at: + type: named_time + name: support_hours_start + to_urgency: high + alert_creation: create_alerts_and_incidents + alert_grouping_parameters: + type: time + config: + timeout: 2 + auto_pause_notifications_parameters: + enabled: true + timeout: 300 + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + EscalationPolicyReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - escalation_policy_reference + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + TeamReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - team_reference + IntegrationReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - aws_cloudwatch_inbound_integration_reference + - cloudkick_inbound_integration_reference + - event_transformer_api_inbound_integration_reference + - generic_email_inbound_integration_reference + - generic_events_api_inbound_integration_reference + - keynote_inbound_integration_reference + - nagios_inbound_integration_reference + - pingdom_inbound_integration_reference + - sql_monitor_inbound_integration_reference + - events_api_v2_inbound_integration_reference + - inbound_integration_reference + IncidentUrgencyRule: + allOf: + - $ref: '#/components/schemas/IncidentUrgencyType' + - type: object + properties: + during_support_hours: + $ref: '#/components/schemas/IncidentUrgencyType' + outside_support_hours: + $ref: '#/components/schemas/IncidentUrgencyType' + SupportHours: + type: object + properties: + type: + type: string + description: The type of support hours + default: fixed_time_per_day + enum: + - fixed_time_per_day + time_zone: + type: string + format: activesupport-time-zone + description: The time zone for the support hours + days_of_week: + type: array + readOnly: true + items: + type: integer + readOnly: true + description: 'The days of the week (1 through 7, for Monday through Sunday)' + start_time: + type: string + format: time + description: The support hours' starting time of day (date portion is ignored) + end_time: + type: string + format: time + description: The support hours' ending time of day (date portion is ignored) + ScheduledAction: + type: object + properties: + type: + type: string + description: The type of schedule action. Must be set to urgency_change. + enum: + - urgency_change + at: + type: object + description: Represents when scheduled action will occur. + properties: + type: + type: string + description: Must be set to named_time. + enum: + - named_time + name: + type: string + description: Designates either the start or the end of support hours. + enum: + - support_hours_start + - support_hours_end + required: + - type + - name + to_urgency: + type: string + description: Urgency level. Must be set to high. + enum: + - high + required: + - type + - at + - to_urgency + AddonReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + src: + type: string + format: url + description: The URL source of the Addon + name: + type: string + description: The user entered name of the Addon. + type: + type: string + enum: + - full_page_addon_reference + - incident_show_addon_reference + AlertGroupingParameters: + type: object + description: | + Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. To turn grouping off set the type to null. + properties: + type: + type: string + enum: + - time + - intelligent + - content_based + - null + config: + anyOf: + - type: object + description: The configuration for Intelligent Alert Grouping. Note that this configuration is only available for certain plans. + properties: + time_window: + type: integer + minimum: 300 + maximum: 3600 + description: 'The maximum amount of time allowed between Alerts. Any Alerts arriving greater than `time_window` seconds apart will not be grouped together. This is a rolling time window and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours. To use the "recommended_time_window," set the value to 0, otherwise the value must be between 300 and 3600.' + recommended_time_window: + readOnly: true + type: integer + description: 'In order to ensure your Service has the optimal grouping window, we use data science to calculate your Service''s average Alert inter-arrival time. We encourage customer''s to use this value, please set `time_window` to 0 to use the `recommended_time_window`.' + - $ref: '#/components/schemas/TimeBasedAlertGroupingConfiguration' + - $ref: '#/components/schemas/ContentBasedAlertGroupingConfiguration' + AutoPauseNotificationsParameters: + title: AutoPauseNotificationsParameters + type: object + description: 'Defines how alerts on this service are automatically suspended for a period of time before triggering, when identified as likely being transient. Note that automatically pausing notifications is only available on certain plans.' + properties: + enabled: + type: boolean + default: false + description: Indicates whether alerts should be automatically suspended when identified as transient + timeout: + type: integer + enum: + - 120 + - 180 + - 300 + - 600 + - 900 + description: Indicates in seconds how long alerts should be suspended before triggering + example: + enabled: true + timeout: 300 + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + IncidentUrgencyType: + type: object + properties: + type: + type: string + description: 'The type of incident urgency: whether it''s constant, or it''s dependent on the support hours.' + default: constant + enum: + - constant + - use_support_hours + urgency: + type: string + description: 'The incidents'' urgency, if type is constant.' + default: high + enum: + - low + - high + - severity_based + TimeBasedAlertGroupingConfiguration: + type: object + description: The configuration for Time Based Alert Grouping + properties: + timeout: + type: integer + description: 'The duration in minutes within which to automatically group incoming Alerts. To continue grouping Alerts until the Incident is resolved, set this value to 0.' + ContentBasedAlertGroupingConfiguration: + type: object + description: The configuration for Content Based Alert Grouping + properties: + aggregate: + type: string + description: 'Whether Alerts should be grouped if `all` or `any` specified fields match. If `all` is selected, an exact match on every specified field name must occur for Alerts to be grouped. If `any` is selected, Alerts will be grouped when there is an exact match on at least one of the specified fields.' + enum: + - 'all, any' + fields: + type: array + description: 'The fields with which to group against. Depending on the aggregate, Alerts will group if some or all the fields match' + AuditRecordResponseSchema: + allOf: + - type: object + properties: + records: + type: array + items: + $ref: '#/components/schemas/AuditRecord' + response_metadata: + nullable: true + anyOf: + - $ref: '#/components/schemas/AuditMetadata' + required: + - records + - $ref: '#/components/schemas/CursorPagination' + AuditRecord: + type: object + readOnly: true + description: An Audit Trail record + properties: + id: + type: string + self: + type: string + nullable: true + description: Record URL. + execution_time: + type: string + format: date-time + description: 'The date/time the action executed, in ISO8601 format and millisecond precision.' + execution_context: + type: object + description: Action execution context + properties: + request_id: + type: string + nullable: true + description: Request Id + remote_address: + type: string + nullable: true + description: remote address + nullable: true + actors: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + method: + type: object + description: The method information + properties: + description: + type: string + nullable: true + truncated_token: + description: Truncated token containing the last 4 chars of the token's actual value. + type: string + nullable: true + example: 3xyz + type: + $ref: '#/components/parameters/audit_method_type/schema' + required: + - type + root_resource: + $ref: '#/components/schemas/Reference' + action: + type: string + example: create + details: + type: object + nullable: true + description: | + Additional details to provide further information about the action or + the resource that has been audited. + properties: + resource: + $ref: '#/components/schemas/Reference' + fields: + description: | + A set of fields that have been affected. + The fields that have not been affected MAY be returned. + type: array + nullable: true + items: + type: object + description: | + Information about the affected field. + When available, field's before and after values are returned: + + #### Resource creation + - `value` MAY be returned + + #### Resource update + - `value` MAY be returned + - `before_value` MAY be returned + + #### Resource deletion + - `before_value` MAY be returned + properties: + name: + type: string + description: Name of the resource field + example: name + description: + type: string + nullable: true + description: Human readable description of the resource field + example: First and Last name + value: + type: string + nullable: true + description: new or updated value of the field + example: Jonathan + before_value: + type: string + nullable: true + description: previous or deleted value of the field + example: John + required: + - name + references: + description: A set of references that have been affected. + type: array + nullable: true + items: + type: object + properties: + name: + type: string + description: Name of the reference field + example: team_members + description: + type: string + nullable: true + description: Human readable description of the references field + example: First and Last name + added: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + removed: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + required: + - name + required: + - resource + required: + - id + - execution_time + - method + - root_resource + - action + AuditMetadata: + type: object + properties: + messages: + type: array + nullable: true + items: + type: string + example: Message about the result + CursorPagination: + type: object + properties: + limit: + type: integer + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + readOnly: true + next_cursor: + type: string + description: | + An opaque string than will deliver the next set of results when provided as the `cursor` parameter in a subsequent request. A `null` value for this field indicates that there are no additional results. + example: dXNlcjaVMzc5V0ZYTlo= + nullable: true + readOnly: true + required: + - limit + - next_cursor + Integration: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + type: + type: string + enum: + - aws_cloudwatch_inbound_integration + - cloudkick_inbound_integration + - event_transformer_api_inbound_integration + - generic_email_inbound_integration + - generic_events_api_inbound_integration + - keynote_inbound_integration + - nagios_inbound_integration + - pingdom_inbound_integration + - sql_monitor_inbound_integration + - events_api_v2_inbound_integration + name: + type: string + description: The name of this integration. + service: + $ref: '#/components/schemas/ServiceReference' + created_at: + type: string + format: date-time + description: The date/time when this integration was created. + readOnly: true + vendor: + $ref: '#/components/schemas/VendorReference' + integration_email: + type: string + description: Specify for generic_email_inbound_integration. Must be set to an email address @your-subdomain.pagerduty.com + email_incident_creation: + type: string + description: Specify for generic_email_inbound_integration + enum: + - on_new_email + - on_new_email_subject + - only_if_no_open_incidents + - use_rules + email_filter_mode: + type: string + description: Specify for generic_email_inbound_integration. May override email_incident_creation + enum: + - all-email + - or-rules-email + - and-rules-email + email_parsers: + type: array + description: Specify for generic_email_inbound_integration. + uniqueItems: true + minItems: 1 + items: + $ref: '#/components/schemas/EmailParser' + email_parsing_fallback: + type: string + description: Specify for generic_email_inbound_integration. + enum: + - open_new_incident + - discard + email_filters: + type: array + description: Specify for generic_email_inbound_integration. + uniqueItems: true + minItems: 1 + items: + type: object + properties: + subject_mode: + type: string + enum: + - match + - no-match + - always + subject_regex: + type: string + description: Specify if subject_mode is set to match or no-match + body_mode: + type: string + enum: + - match + - no-match + - always + body_regex: + type: string + description: Specify if body_mode is set to match or no-match + from_email_mode: + type: string + enum: + - match + - no-match + - always + from_email_regex: + type: string + description: Specify if from_email_mode is set to match or no-match + required: + - subject_mode + - body_mode + - from_email_mode + required: + - type + - name + ServiceReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - service_reference + VendorReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - vendor_reference + EmailParser: + type: object + properties: + action: + type: string + enum: + - trigger + - resolve + match_predicate: + $ref: '#/components/schemas/MatchPredicate' + value_extractors: + type: array + description: Additional values that will be pulled in to the Incident object. Exactly one value extractor must have a `value_name` of `incident_key`. + uniqueItems: true + minItems: 1 + items: + type: object + properties: + type: + type: string + enum: + - entire + - regex + - between + part: + type: string + enum: + - body + - subject + - from_addresses + value_name: + type: string + minLength: 1 + description: The field name to set in the Incident object. Exactly one must use the `value_name` of `incident_key` + regex: + type: string + starts_after: + type: string + ends_with: + type: string + required: + - type + - part + - value_name + required: + - action + - match_predicate + MatchPredicate: + type: object + properties: + type: + type: string + enum: + - all + - any + - not + - contains + - exactly + - regex + matcher: + type: string + description: 'Required if the type is `contains`, `exactly` or `regex`.' + minLength: 1 + part: + type: string + description: 'The email field that will attempt to use the matcher expression. Required if the type is `contains`, `exactly` or `regex`.' + enum: + - body + - subject + - from_addresses + children: + type: array + description: 'Additional matchers to be run. Must be not empty if the type is `all`, `any`, or `not`.' + items: + $ref: '#/components/schemas/MatchPredicate' + required: + - type + - part + - children + ServiceEventRule: + allOf: + - $ref: '#/components/schemas/EventRule/allOf/0' + - type: object + properties: + position: + type: integer + description: 'Position/index of the Event Rule on the Service. Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching Event Rule is found or the end of the list is reached.' + actions: + $ref: '#/components/schemas/EventRuleActionsCommon' + EventRule: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + description: ID of the Event Rule. + self: + type: string + format: url + description: the API show URL at which the object is accessible. + readOnly: true + disabled: + type: boolean + description: Indicates whether the Event Rule is disabled and would therefore not be evaluated. + conditions: + type: object + description: 'Conditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though.' + properties: + operator: + type: string + description: Operator to combine sub-conditions. + enum: + - and + - or + subconditions: + type: array + description: Array of sub-conditions. + items: + type: object + properties: + operator: + type: string + description: The type of operator to apply. + enum: + - exists + - nexists + - equals + - nequals + - contains + - ncontains + - matches + - nmatches + parameters: + type: object + properties: + path: + type: string + description: 'Path to a field in an event, in dot-notation. For Event Rules on a serivce, this will have to be a PD-CEF field.' + value: + type: string + description: Value to apply to the operator. + options: + type: object + description: Options to configure the operator. + required: + - value + - path + required: + - operator + - parameters + required: + - operator + - subconditions + time_frame: + description: Time-based conditions for limiting when the rule is active. + type: object + properties: + active_between: + type: object + required: + - start_time + - end_time + description: A fixed window of time during which the rule is active. + properties: + start_time: + type: integer + description: The start time in milliseconds. + end_time: + type: integer + description: End time in milliseconds. + scheduled_weekly: + type: object + required: + - start_time + - duration + - timezone + - weekdays + description: 'A reccuring window of time based on the day of the week, during which the rule is active.' + properties: + start_time: + type: integer + description: The amount of milliseconds into the day at which the window starts. + duration: + type: integer + description: The duration of the window in milliseconds. + timezone: + type: string + description: The timezone. + weekdays: + type: array + description: 'An array of day values. Ex [1, 3, 5] is Monday, Wednesday, Friday.' + items: + type: integer + variables: + type: array + description: '[Early Access] Populate variables from event payloads and use those variables in other event actions.' + items: + type: object + properties: + type: + type: string + description: The type of operation to populate the variable. + enum: + - regex + name: + type: string + description: The name of the variable. + parameters: + type: object + description: The parameters for performing the operation to populate the + properties: + value: + type: string + description: 'The value for the operation. For example, an RE2 regular expression for regex-type variables.' + path: + type: string + description: 'Path to a field in an event, in dot-notation. For Event Rules on a Service, this will have to be a PD-CEF field.' + required: + - value + - path + required: + - type + - name + - parameters + - type: object + properties: + position: + type: integer + description: 'Position/index of the Event Rule in the Ruleset. Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching rule is found.' + catch_all: + type: boolean + readOnly: true + description: Indicates whether the Event Rule is the last Event Rule of the Ruleset that serves as a catch-all. It has limited functionality compared to other rules and always matches. + actions: + description: 'When an event matches this rule, the actions that will be taken to change the resulting alert and incident.' + allOf: + - $ref: '#/components/schemas/EventRuleActionsCommon' + - type: object + properties: + route: + description: Set the service ID of the target service for the resulting alert. You can find the service you want to route to by calling the services endpoint. + type: object + required: + - value + nullable: true + properties: + value: + type: string + description: The target service's ID. + EventRuleActionsCommon: + type: object + description: 'When an event matches this Event Rule, the actions that will be taken to change the resulting Alert and Incident.' + properties: + annotate: + description: Set a note on the resulting incident. + type: object + nullable: true + required: + - value + properties: + value: + type: string + description: The content of the note. + event_action: + description: Set whether the resulting alert status is trigger or resolve. + type: object + required: + - value + nullable: true + properties: + value: + type: string + enum: + - trigger + - resolve + extractions: + type: array + description: Dynamically extract values to set and modify new and existing PD-CEF fields. + items: + oneOf: + - type: object + required: + - target + - source + - regex + properties: + target: + type: string + description: The PD-CEF field that will be set with the value from the regex. + source: + type: string + description: The path to the event field where the regex will be applied to extract a value. + regex: + type: string + description: 'A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used.' + - type: object + required: + - target + - template + properties: + target: + type: string + description: The PD-CEF field that will be set with the value from the regex. + template: + type: string + description: A value that will be used to populate the target PD-CEF field. You can include variables extracted from the payload by using string interpolation. + example: 'Error number {{count}} on host {{host}}' + priority: + description: Set the priority ID for the resulting incident. You can find the priority you want by calling the priorities endpoint. + type: object + required: + - value + nullable: true + properties: + value: + type: string + description: The priority ID. + severity: + description: Set the severity of the resulting alert. + type: object + required: + - value + nullable: true + properties: + value: + type: string + enum: + - info + - warning + - error + - critical + suppress: + description: Set whether the resulting alert is suppressed. Can optionally be used with a threshold where resulting alerts will be suppressed until the threshold is met in a window of time. If using a threshold the rule must also set a route action. + type: object + required: + - value + properties: + value: + type: boolean + threshold_value: + type: integer + description: The number of occurences needed during the window of time to trigger the theshold. + threshold_time_unit: + type: string + description: The time unit for the window of time. + enum: + - seconds + - minutes + - hours + threshold_time_amount: + type: integer + description: The amount of time units for the window of time. + suspend: + description: 'Set the length of time to suspend the resulting alert before triggering. Rules with a suspend action must also set a route action, and cannot have a suppress with threshold action' + type: object + required: + - value + nullable: true + properties: + value: + type: integer + description: The amount of time to suspend the alert in seconds. + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + PaymentRequired: + description: | + Account does not have the abilities to perform the action. Please review the response for the required abilities. + You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + InternalServerError: + description: Internal Server Error the PagerDuty server experienced an error. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + NotAllowed: + description: 'The request was received and recognized by the server, but its HTTP method was rejected for the requested resource.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + services: + id: pagerduty.services.services + name: services + title: Services + methods: + list_services: + operation: + $ref: '#/paths/~1services/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.services + _list_services: + operation: + $ref: '#/paths/~1services/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_service: + operation: + $ref: '#/paths/~1services/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_service: + operation: + $ref: '#/paths/~1services~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.service + _get_service: + operation: + $ref: '#/paths/~1services~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_service: + operation: + $ref: '#/paths/~1services~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_service: + operation: + $ref: '#/paths/~1services~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/services/methods/get_service' + - $ref: '#/components/x-stackQL-resources/services/methods/list_services' + insert: + - $ref: '#/components/x-stackQL-resources/services/methods/create_service' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/services/methods/delete_service' + audit_records: + id: pagerduty.services.audit_records + name: audit_records + title: Audit Records + methods: + list_service_audit_records: + operation: + $ref: '#/paths/~1services~1{id}~1audit~1records/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.records + _list_service_audit_records: + operation: + $ref: '#/paths/~1services~1{id}~1audit~1records/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/audit_records/methods/list_service_audit_records' + insert: [] + update: [] + delete: [] + integrations: + id: pagerduty.services.integrations + name: integrations + title: Integrations + methods: + create_service_integration: + operation: + $ref: '#/paths/~1services~1{id}~1integrations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + update_service_integration: + operation: + $ref: '#/paths/~1services~1{id}~1integrations~1{integration_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + get_service_integration: + operation: + $ref: '#/paths/~1services~1{id}~1integrations~1{integration_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.integration + _get_service_integration: + operation: + $ref: '#/paths/~1services~1{id}~1integrations~1{integration_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/integrations/methods/get_service_integration' + insert: + - $ref: '#/components/x-stackQL-resources/integrations/methods/create_service_integration' + update: [] + delete: [] + rules: + id: pagerduty.services.rules + name: rules + title: Rules + methods: + list_service_event_rules: + operation: + $ref: '#/paths/~1services~1{id}~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.rules + _list_service_event_rules: + operation: + $ref: '#/paths/~1services~1{id}~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_service_event_rule: + operation: + $ref: '#/paths/~1services~1{id}~1rules/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_service_event_rule: + operation: + $ref: '#/paths/~1services~1{id}~1rules~1{rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.rule + _get_service_event_rule: + operation: + $ref: '#/paths/~1services~1{id}~1rules~1{rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_service_event_rule: + operation: + $ref: '#/paths/~1services~1{id}~1rules~1{rule_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_service_event_rule: + operation: + $ref: '#/paths/~1services~1{id}~1rules~1{rule_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rules/methods/get_service_event_rule' + - $ref: '#/components/x-stackQL-resources/rules/methods/list_service_event_rules' + insert: + - $ref: '#/components/x-stackQL-resources/rules/methods/create_service_event_rule' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete_service_event_rule' +paths: + /services: + get: + tags: + - Services + operationId: listServices + x-pd-requires-scope: services.read + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services) + + Scoped OAuth requires: `services.read` + summary: List services + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/team_ids' + - $ref: '#/components/parameters/time_zone' + - $ref: '#/components/parameters/sort_by_service' + - $ref: '#/components/parameters/include_services' + responses: + '200': + description: A paginated array of services. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + services: + type: array + items: + $ref: '#/components/schemas/Service' + required: + - services + examples: + response: + summary: Response Example + value: + services: + - id: PIJ90N7 + summary: My Application Service + type: service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + name: My Application Service + auto_resolve_timeout: 14400 + acknowledgement_timeout: 600 + created_at: '2015-11-06T11:12:51-05:00' + status: active + alert_creation: create_alerts_and_incidents + alert_grouping_parameters: + type: intelligent + integrations: + - id: PQ12345 + type: generic_email_inbound_integration_reference + summary: Email Integration + self: 'https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345' + escalation_policy: + id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + incident_urgency_rule: + type: use_support_hours + during_support_hours: + type: constant + urgency: high + outside_support_hours: + type: constant + urgency: low + support_hours: + type: fixed_time_per_day + time_zone: America/Lima + start_time: '09:00:00' + end_time: '17:00:00' + days_of_week: + - 1 + - 2 + - 3 + - 4 + - 5 + scheduled_actions: + - type: urgency_change + at: + type: named_time + name: support_hours_start + to_urgency: high + auto_pause_notifications_parameters: + enabled: true + timeout: 300 + limit: 25 + offset: 0 + more: false + total: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + post: + x-pd-requires-scope: services.write + tags: + - Services + operationId: createService + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services) + + Scoped OAuth requires: `services.write` + summary: Create a service + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + requestBody: + content: + application/json: + schema: + type: object + properties: + service: + $ref: '#/components/schemas/Service' + required: + - service + examples: + request: + summary: Request Example + value: + service: + type: service + name: My Web App + description: My cool web application that does things. + auto_resolve_timeout: 14400 + acknowledgement_timeout: 600 + status: active + escalation_policy: + id: PWIP6CQ + type: escalation_policy_reference + incident_urgency_rule: + type: use_support_hours + during_support_hours: + type: constant + urgency: high + outside_support_hours: + type: constant + urgency: low + support_hours: + type: fixed_time_per_day + time_zone: America/Lima + start_time: '09:00:00' + end_time: '17:00:00' + days_of_week: + - 1 + - 2 + - 3 + - 4 + - 5 + scheduled_actions: + - type: urgency_change + at: + type: named_time + name: support_hours_start + to_urgency: high + alert_creation: create_alerts_and_incidents + alert_grouping_parameters: + type: time + config: + timeout: 2 + auto_pause_notifications_parameters: + enabled: true + timeout: 300 + description: The service to be created + responses: + '201': + description: The service that was created + content: + application/json: + schema: + type: object + properties: + service: + $ref: '#/components/schemas/Service' + required: + - service + examples: + response: + summary: Response Example + value: + service: + id: PIJ90N7 + summary: My Application Service + type: service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + name: My Application Service + auto_resolve_timeout: 14400 + acknowledgement_timeout: 600 + created_at: '2015-11-06T11:12:51-05:00' + status: active + alert_creation: create_alerts_and_incidents + integrations: + - id: PQ12345 + type: generic_email_inbound_integration_reference + summary: Email Integration + self: 'https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345' + escalation_policy: + id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + incident_urgency_rule: + type: use_support_hours + during_support_hours: + type: constant + urgency: high + outside_support_hours: + type: constant + urgency: low + support_hours: + type: fixed_time_per_day + time_zone: America/Lima + start_time: '09:00:00' + end_time: '17:00:00' + days_of_week: + - 1 + - 2 + - 3 + - 4 + - 5 + scheduled_actions: + - type: urgency_change + at: + type: named_time + name: support_hours_start + to_urgency: high + auto_pause_notifications_parameters: + enabled: true + timeout: 300 + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '/services/{id}': + get: + tags: + - Services + operationId: getService + x-pd-requires-scope: services.read + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services) + + Scoped OAuth requires: `services.read` + summary: Get a service + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/include_services_id' + responses: + '200': + description: The service requested. + content: + application/json: + schema: + type: object + properties: + service: + $ref: '#/components/schemas/Service' + required: + - service + examples: + response: + summary: Response Example + value: + service: + id: PIJ90N7 + type: service + summary: My Application Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + name: My Application Service + auto_resolve_timeout: 14400 + acknowledgement_timeout: 600 + created_at: '2015-11-06T11:12:51-05:00' + status: active + alert_creation: create_alerts_and_incidents + integrations: + - id: PQ12345 + type: generic_email_inbound_integration_reference + summary: Email Integration + self: 'https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345' + escalation_policy: + id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + incident_urgency_rule: + type: use_support_hours + during_support_hours: + type: constant + urgency: high + outside_support_hours: + type: constant + urgency: low + support_hours: + type: fixed_time_per_day + time_zone: America/Lima + start_time: '09:00:00' + end_time: '17:00:00' + days_of_week: + - 1 + - 2 + - 3 + - 4 + - 5 + scheduled_actions: + - type: urgency_change + at: + type: named_time + name: support_hours_start + to_urgency: high + auto_pause_notifications_parameters: + enabled: true + timeout: 300 + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + delete: + x-pd-requires-scope: services.write + tags: + - Services + operationId: deleteService + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services) + + Scoped OAuth requires: `services.write` + summary: Delete a service + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '204': + description: The service was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + put: + x-pd-requires-scope: services.write + tags: + - Services + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services) + + Scoped OAuth requires: `services.write` + summary: Update a service + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + operationId: updateService + requestBody: + content: + application/json: + schema: + type: object + properties: + service: + $ref: '#/components/schemas/Service' + required: + - service + examples: + request: + summary: Request Example + value: + service: + type: service + name: My Web App + description: My cool web application that does things. + auto_resolve_timeout: 14400 + acknowledgement_timeout: 600 + status: active + escalation_policy: + id: PWIP6CQ + type: escalation_policy_reference + incident_urgency_rule: + type: use_support_hours + during_support_hours: + type: constant + urgency: high + outside_support_hours: + type: constant + urgency: low + support_hours: + type: fixed_time_per_day + time_zone: America/Lima + start_time: '09:00:00' + end_time: '17:00:00' + days_of_week: + - 1 + - 2 + - 3 + - 4 + - 5 + scheduled_actions: + - type: urgency_change + at: + type: named_time + name: support_hours_start + to_urgency: high + alert_creation: create_alerts_and_incidents + alert_grouping_parameters: + type: time + config: + timeout: 2 + auto_pause_notifications_parameters: + enabled: true + timeout: 300 + description: The service to be updated. + responses: + '200': + description: The service that was updated. + content: + application/json: + schema: + type: object + properties: + service: + $ref: '#/components/schemas/Service' + required: + - service + examples: + response: + summary: Response Example + value: + service: + id: PIJ90N7 + type: service + summary: My Application Service + self: 'https://api.pagerduty.com/services/PIJ90N7' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7' + name: My Application Service + auto_resolve_timeout: 14400 + acknowledgement_timeout: 600 + created_at: '2015-11-06T11:12:51-05:00' + status: active + alert_creation: create_alerts_and_incidents + alert_grouping_parameters: + type: time + config: + timeout: 2 + integrations: + - id: PQ12345 + type: generic_email_inbound_integration_reference + summary: Email Integration + self: 'https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345' + html_url: 'https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345' + escalation_policy: + id: PT20YPA + type: escalation_policy_reference + summary: Another Escalation Policy + self: 'https://api.pagerduty.com/escalation_policies/PT20YPA' + html_url: 'https://subdomain.pagerduty.com/escalation_policies/PT20YPA' + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + incident_urgency_rule: + type: use_support_hours + during_support_hours: + type: constant + urgency: high + outside_support_hours: + type: constant + urgency: low + support_hours: + type: fixed_time_per_day + time_zone: America/Lima + start_time: '09:00:00' + end_time: '17:00:00' + days_of_week: + - 1 + - 2 + - 3 + - 4 + - 5 + scheduled_actions: + - type: urgency_change + at: + type: named_time + name: support_hours_start + to_urgency: high + auto_pause_notifications_parameters: + enabled: true + timeout: 300 + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '/services/{id}/audit/records': + get: + x-pd-requires-scope: audit_records.read + tags: + - Services + operationId: listServiceAuditRecords + summary: List audit records for a service + description: | + 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` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/cursor_limit' + - $ref: '#/components/parameters/cursor_cursor' + - $ref: '#/components/parameters/audit_since' + - $ref: '#/components/parameters/audit_until' + responses: + '200': + description: Records matching the query criteria. + content: + application/json: + schema: + $ref: '#/components/schemas/AuditRecordResponseSchema' + examples: + response: + $ref: '#/components/examples/AuditRecordServiceResponse' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '/services/{id}/integrations': + post: + x-pd-requires-scope: services.write + tags: + - Services + operationId: createServiceIntegration + summary: Create a new integration + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services) + + Scoped OAuth requires: `services.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + integration: + $ref: '#/components/schemas/Integration' + required: + - integration + examples: + email_integration: + summary: Request Example for Email Integration + value: + integration: + type: generic_email_inbound_integration + name: Email + service: + id: PQL78HM + type: service_reference + integration_email: my-email-based-integration@subdomain.pagerduty.com + vendor: + type: vendor_reference + id: PZD94QK + email_integration_with_filters: + summary: Email Integration With Filters + value: + integration: + type: generic_email_inbound_integration + name: Email with Filters + integration_email: your-service@subdomain.pd-staging.com + email_incident_creation: on_new_email_subject + email_filter_mode: or-rules-email + email_parsers: + - action: trigger + match_predicate: + type: any + matcher: this thing + part: body + children: [] + value_extractors: + - type: entire + part: body + value_name: incident_key + email_parsing_fallback: discard + email_filters: + - subject_mode: match + subject_regex: alert + body_mode: match + body_regex: alert + from_email_mode: match + from_email_regex: alert + events_v2_integration: + summary: Request Example for Events v2 Integration + value: + integration: + type: events_api_v2_inbound_integration + name: Events V2 + service: + id: PQL78HM + type: service_reference + description: The integration to be created + responses: + '201': + description: The integration that was created. + content: + application/json: + schema: + type: object + properties: + integration: + $ref: '#/components/schemas/Integration' + required: + - integration + examples: + response: + summary: Response Example + value: + integration: + id: PE1U9CH + type: generic_email_inbound_integration + summary: Email + self: 'https://api.pagerduty.com/services/PQL78HM/integrations/PE1U9CH' + html_url: 'https://subdomain.pagerduty.com/services/PQL78HM/integrations/PE1U9CH' + name: Email + service: + id: PQL78HM + type: service_reference + summary: My Email-Based Integration + self: 'https://api.pagerduty.com/services/PQL78HM' + html_url: 'https://subdomain.pagerduty.com/services/PQL78HM' + created_at: '2015-10-14T13:33:02-07:00' + integration_email: my-email-based-integration@subdomain.pagerduty.com + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/services/{id}/integrations/{integration_id}': + put: + x-pd-requires-scope: services.write + tags: + - Services + operationId: updateServiceIntegration + summary: Update an existing integration + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services) + + Scoped OAuth requires: `services.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/integration_id' + requestBody: + content: + application/json: + schema: + type: object + properties: + integration: + $ref: '#/components/schemas/Integration' + required: + - integration + examples: + request: + summary: Request Example + value: + integration: + type: generic_email_inbound_integration + name: Email + service: + id: PQL78HM + type: service_reference + summary: My Email-Based Integration + self: 'https://api.pagerduty.com/services/PQL78HM' + html_url: 'https://subdomain.pagerduty.com/services/PQL78HM' + integration_email: my-email-based-integration@subdomain.pagerduty.com + vendor: + type: vendor_reference + id: PZD94QK + description: The integration to be updated + responses: + '200': + description: The integration that was updated. + content: + application/json: + schema: + type: object + properties: + integration: + $ref: '#/components/schemas/Integration' + required: + - integration + examples: + response: + summary: Response Example + value: + integration: + id: PE1U9CH + type: generic_email_inbound_integration + summary: Email + self: 'https://api.pagerduty.com/services/PQL78HM/integrations/PE1U9CH' + html_url: 'https://subdomain.pagerduty.com/services/PQL78HM/integrations/PE1U9CH' + name: Email + service: + id: PQL78HM + type: service_reference + summary: My Email-Based Integration + self: 'https://api.pagerduty.com/services/PQL78HM' + html_url: 'https://subdomain.pagerduty.com/services/PQL78HM' + created_at: '2015-10-14T13:33:02-07:00' + integration_email: my-email-based-integration@subdomain.pagerduty.com + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + get: + x-pd-requires-scope: services.read + tags: + - Services + operationId: getServiceIntegration + summary: View an integration + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services) + + Scoped OAuth requires: `services.read` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/integration_id' + - $ref: '#/components/parameters/include_services_integrations' + responses: + '200': + description: The integration that was requested. + content: + application/json: + schema: + type: object + properties: + integration: + $ref: '#/components/schemas/Integration' + required: + - integration + examples: + response: + summary: Response Example + value: + integration: + id: PE1U9CH + type: generic_email_inbound_integration + summary: Email + self: 'https://api.pagerduty.com/services/PQL78HM/integrations/PE1U9CH' + html_url: 'https://subdomain.pagerduty.com/services/PQL78HM/integrations/PE1U9CH' + name: Email + service: + id: PQL78HM + type: service_reference + summary: My Email-Based Integration + self: 'https://api.pagerduty.com/services/PQL78HM' + html_url: 'https://subdomain.pagerduty.com/services/PQL78HM' + created_at: '2015-10-14T13:33:02-07:00' + vendor: + id: P8JX75F + type: vendor_reference + summary: Autotask + self: 'https://api.pagerduty.com/vendors/P8JX75F' + integration_email: my-email-based-integration@subdomain.pagerduty.com + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/services/{id}/rules': + get: + x-pd-requires-scope: services.read + tags: + - Services + operationId: listServiceEventRules + description: | + List Event Rules on a Service. + + > ### 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` + summary: List Service's Event Rules + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/id' + responses: + '200': + description: A paginated array of Event Rule objects. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + rules: + type: array + description: The paginated list of Event Rules of the Service. + items: + $ref: '#/components/schemas/ServiceEventRule' + examples: + response: + summary: Response Example + value: + rules: + - id: 14e56445-ebab-4dd0-ba9d-fc28a41b7e7b + position: 0 + disabled: false + self: 'https://api.pagerduty.com/services/PI2KBWI/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b' + conditions: + operator: and + subconditions: + - operator: contains + parameters: + value: mysql + path: class + time_frame: + active_between: + start_time: 1577880000000 + end_time: 1580558400000 + actions: + severity: + value: info + extractions: + - target: dedup_key + template: '{{error_level}} error on host {{host}}' + variables: + - name: error_level + type: regex + parameters: + value: .*error level is (\w+)\. + path: summary + - name: host + type: regex + parameters: + value: (.*)-USW2 + path: source + limit: 25 + offset: 0 + more: false + total: null + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + post: + x-pd-requires-scope: services.write + tags: + - Services + operationId: createServiceEventRule + description: | + Create a new Event Rule on a Service. + + > ### 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` + summary: Create an Event Rule on a Service + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + rule: + $ref: '#/components/schemas/ServiceEventRule' + required: + - rule + examples: + request: + summary: Request Example + value: + rule: + id: 14e56445-ebab-4dd0-ba9d-fc28a41b7e7b + position: 0 + disabled: false + conditions: + operator: and + subconditions: + - operator: contains + parameters: + value: mysql + path: class + time_frame: + active_between: + start_time: 1577880000000 + end_time: 1580558400000 + actions: + annotate: + value: This incident was modified by an Event Rule + priority: + value: PCMUB6F + severity: + value: warning + extractions: + - target: dedup_key + source: custom_details.error_summary + regex: Host (.*) is experiencing errors + responses: + '201': + description: The Event Rule that was created. + content: + application/json: + schema: + type: object + properties: + rule: + $ref: '#/components/schemas/ServiceEventRule' + examples: + response: + summary: Response Example + value: + ruleset: + id: 14e56445-ebab-4dd0-ba9d-fc28a41b7e7b + position: 0 + disabled: false + self: 'https://api.pagerduty.com/services/PI2KBWI/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b' + conditions: + operator: and + subconditions: + - operator: contains + parameters: + value: mysql + path: class + time_frame: + active_between: + start_time: 1577880000000 + end_time: 1580558400000 + actions: + annotate: + value: This incident was modified by an Event Rule + priority: + value: PCMUB6F + severity: + value: warning + extractions: + - target: dedup_key + source: custom_details.error_summary + regex: Host (.*) is experiencing errors + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '409': + $ref: '#/components/responses/Conflict' + '/services/{id}/rules/{rule_id}': + get: + x-pd-requires-scope: services.read + tags: + - Services + operationId: getServiceEventRule + description: | + Get an Event Rule from a Service. + + > ### 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` + summary: Get an Event Rule from a Service + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/rule_id' + responses: + '200': + description: The Event Rule object. + content: + application/json: + schema: + type: object + properties: + rule: + $ref: '#/components/schemas/ServiceEventRule' + examples: + response: + summary: Response Example + value: + rule: + id: 14e56445-ebab-4dd0-ba9d-fc28a41b7e7b + position: 0 + disabled: false + self: 'https://api.pagerduty.com/services/PI2KBWI/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b' + conditions: + operator: and + subconditions: + - operator: contains + parameters: + value: mysql + path: class + time_frame: + active_between: + start_time: 1577880000000 + end_time: 1580558400000 + actions: + annotate: + value: This incident was modified by an Event Rule + priority: + value: PCMUB6F + severity: + value: warning + extractions: + - target: dedup_key + source: custom_details.error_summary + regex: Host (.*) is experiencing errors + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + put: + x-pd-requires-scope: services.write + tags: + - Services + operationId: updateServiceEventRule + summary: Update an Event Rule on a Service + description: | + Update an Event Rule on a Service. Note that the endpoint supports partial updates, so any number of the writable fields can be provided. + + > ### 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` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/rule_id' + requestBody: + content: + application/json: + schema: + type: object + properties: + rule: + $ref: '#/components/schemas/ServiceEventRule' + rule_id: + description: The id of the Event Rule to update on the Service. + type: string + required: + - rule_id + examples: + suppress_action: + summary: 'Example: Enable suppress action' + value: + rule_id: 7123bdd1-74e8-4aa7-aa38-4a9ebe123456 + rule: + actions: + suppress: + value: true + disable_rule: + summary: 'Example: Disable rule' + value: + rule_id: 7123bdd1-74e8-4aa7-aa38-4a9ebe123456 + rule: + disabled: true + responses: + '200': + description: The Event Rule that was updated. + content: + application/json: + schema: + type: object + properties: + rule: + $ref: '#/components/schemas/ServiceEventRule' + examples: + response: + summary: Response Example + value: + rule: + id: 14e56445-ebab-4dd0-ba9d-fc28a41b7e7b + position: 0 + disabled: false + self: 'https://api.pagerduty.com/services/PI2KBWI/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b' + conditions: + operator: and + subconditions: + - operator: contains + parameters: + value: mysql + path: class + time_frame: + active_between: + start_time: 1577880000000 + end_time: 1580558400000 + actions: + annotate: + value: This incident was modified by an Event Rule + priority: + value: PCMUB6F + severity: + value: warning + extractions: + - target: dedup_key + source: custom_details.error_summary + regex: Host (.*) is experiencing errors + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' + delete: + x-pd-requires-scope: services.write + tags: + - Services + operationId: deleteServiceEventRule + description: | + Delete an Event Rule from a Service. + + > ### 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` + summary: Delete an Event Rule from a Service + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/rule_id' + responses: + '204': + description: The Event Rule was deleted successfully. + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/NotAllowed' + '409': + $ref: '#/components/responses/Conflict' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/status_dashboards.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/status_dashboards.yaml new file mode 100644 index 0000000..260bde9 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/status_dashboards.yaml @@ -0,0 +1,2951 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - status_dashboards + description: Status_Dashboards +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + CursorPagination: + type: object + properties: + limit: + type: integer + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + readOnly: true + next_cursor: + type: string + description: | + An opaque string than will deliver the next set of results when provided as the `cursor` parameter in a subsequent request. A `null` value for this field indicates that there are no additional results. + example: dXNlcjaVMzc5V0ZYTlo= + nullable: true + readOnly: true + required: + - limit + - next_cursor + StatusDashboard: + title: StatusDashboard + type: object + properties: + id: + type: string + url_slug: + type: string + name: + type: string + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + LiveListResponse: + type: object + properties: + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + Impact: + title: Impact + type: object + properties: + id: + type: string + readOnly: true + name: + type: string + readOnly: true + type: + type: string + description: The kind of object that has been impacted + enum: + - business_service + status: + type: string + description: The current impact status of the object + enum: + - impacted + - not_impacted + additional_fields: + type: object + properties: + highest_impacting_priority: + type: object + nullable: true + description: Priority information for the highest priority level that is affecting the impacted object. + properties: + id: + type: string + readOnly: true + order: + type: integer + readOnly: true + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + UnprocessableEntity: + description: Unprocessable Entity. Some arguments failed validation checks. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + status_dashboards: + id: pagerduty.status_dashboards.status_dashboards + name: status_dashboards + title: Status Dashboards + methods: + list_status_dashboards: + operation: + $ref: '#/paths/~1status_dashboards/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.status_dashboards + _list_status_dashboards: + operation: + $ref: '#/paths/~1status_dashboards/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_status_dashboard_by_id: + operation: + $ref: '#/paths/~1status_dashboards~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.status_dashboard + _get_status_dashboard_by_id: + operation: + $ref: '#/paths/~1status_dashboards~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/status_dashboards/methods/get_status_dashboard_by_id' + - $ref: '#/components/x-stackQL-resources/status_dashboards/methods/list_status_dashboards' + insert: [] + update: [] + delete: [] + service_impacts: + id: pagerduty.status_dashboards.service_impacts + name: service_impacts + title: Service Impacts + methods: + get_status_dashboard_service_impacts_by_id: + operation: + $ref: '#/paths/~1status_dashboards~1{id}~1service_impacts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.services + _get_status_dashboard_service_impacts_by_id: + operation: + $ref: '#/paths/~1status_dashboards~1{id}~1service_impacts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/service_impacts/methods/get_status_dashboard_service_impacts_by_id' + insert: [] + update: [] + delete: [] + url_slugs: + id: pagerduty.status_dashboards.url_slugs + name: url_slugs + title: Url Slugs + methods: + get_status_dashboard_by_url_slug: + operation: + $ref: '#/paths/~1status_dashboards~1url_slugs~1{url_slug}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.status_dashboard + _get_status_dashboard_by_url_slug: + operation: + $ref: '#/paths/~1status_dashboards~1url_slugs~1{url_slug}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/url_slugs/methods/get_status_dashboard_by_url_slug' + insert: [] + update: [] + delete: [] + url_slugs_service_impacts: + id: pagerduty.status_dashboards.url_slugs_service_impacts + name: url_slugs_service_impacts + title: Url Slugs Service Impacts + methods: + get_status_dashboard_service_impacts_by_url_slug: + operation: + $ref: '#/paths/~1status_dashboards~1url_slugs~1{url_slug}~1service_impacts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.services + _get_status_dashboard_service_impacts_by_url_slug: + operation: + $ref: '#/paths/~1status_dashboards~1url_slugs~1{url_slug}~1service_impacts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/url_slugs_service_impacts/methods/get_status_dashboard_service_impacts_by_url_slug' + insert: [] + update: [] + delete: [] +paths: + /status_dashboards: + get: + tags: + - Status Dashboards + operationId: listStatusDashboards + summary: List Status Dashboards + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/CursorPagination' + - type: object + properties: + status_dashboards: + type: array + items: + $ref: '#/components/schemas/StatusDashboard' + examples: + response: + summary: Response Example + value: + limit: 100 + next_cursor: null + status_dashboards: + - id: PFCVPS0 + url_slug: analytics-api + name: Analytics API + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + description: |- + Get all your account's custom Status Dashboard views + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/early_access_status_dashboards' + '/status_dashboards/{id}': + get: + tags: + - Status Dashboards + operationId: getStatusDashboardById + summary: Get a single Status Dashboard by `id` + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + status_dashboard: + $ref: '#/components/schemas/StatusDashboard' + examples: + response: + summary: Response Example + value: + status_dashboard: + id: PFCVPS0 + url_slug: analytics-api + name: Analytics API + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '429': + $ref: '#/components/responses/TooManyRequests' + description: |- + Get a Status Dashboard by its PagerDuty `id`. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/early_access_status_dashboards' + '/status_dashboards/{id}/service_impacts': + get: + tags: + - Status Dashboards + operationId: getStatusDashboardServiceImpactsById + summary: Get impacted Business Services for a Status Dashboard by `id`. + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/LiveListResponse' + - type: object + properties: + services: + type: array + items: + $ref: '#/components/schemas/Impact' + - type: object + properties: + additional_fields: + type: object + properties: + total_impacted_count: + type: integer + examples: + response: + summary: Response Example + value: + limit: 100 + more: false + services: + - id: PD1234 + name: Web API + type: business_service + status: impacted + additional_fields: + highest_impacting_priority: + id: PQOMK4S + order: 128 + - id: PF9KMXH + name: Analytics Backend + type: business_service + status: not_impacted + additional_fields: + highest_impacting_priority: null + additional_fields: + total_impacted_count: 1 + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '429': + $ref: '#/components/responses/TooManyRequests' + description: |- + 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. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/impacts_additional_fields' + - $ref: '#/components/parameters/early_access_status_dashboards' + '/status_dashboards/url_slugs/{url_slug}': + get: + tags: + - Status Dashboards + operationId: getStatusDashboardByUrlSlug + summary: Get a single Status Dashboard by `url_slug` + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + status_dashboard: + $ref: '#/components/schemas/StatusDashboard' + examples: + response: + summary: Response Example + value: + status_dashboard: + id: PFCVPS0 + url_slug: analytics-api + name: Analytics API + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '429': + $ref: '#/components/responses/TooManyRequests' + description: |- + 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`. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/url_slug' + - $ref: '#/components/parameters/early_access_status_dashboards' + '/status_dashboards/url_slugs/{url_slug}/service_impacts': + get: + tags: + - Status Dashboards + operationId: getStatusDashboardServiceImpactsByUrlSlug + summary: Get impacted Business Services for a Status Dashboard by `url_slug` + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/LiveListResponse' + - type: object + properties: + services: + type: array + items: + $ref: '#/components/schemas/Impact' + - type: object + properties: + additional_fields: + type: object + properties: + total_impacted_count: + type: integer + examples: + response: + summary: Response Example + value: + limit: 100 + more: false + services: + - id: PD1234 + name: Web API + type: business_service + status: impacted + additional_fields: + highest_impacting_priority: + id: PQOMK4S + order: 128 + - id: PF9KMXH + name: Analytics Backend + type: business_service + status: not_impacted + additional_fields: + highest_impacting_priority: null + additional_fields: + total_impacted_count: 1 + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '429': + $ref: '#/components/responses/TooManyRequests' + description: |- + 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. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/url_slug' + - $ref: '#/components/parameters/impacts_additional_fields' + - $ref: '#/components/parameters/early_access_status_dashboards' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/tags.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/tags.yaml new file mode 100644 index 0000000..93a9903 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/tags.yaml @@ -0,0 +1,3091 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + EntityReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - user_reference + - team_reference + - escalation_policy_reference + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + tags: + id: pagerduty.tags.tags + name: tags + title: Tags + methods: + create_entity_type_by_id_change_tags: + operation: + $ref: '#/paths/~1{entity_type}~1{id}~1change_tags/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_entity_type_by_id_tags: + operation: + $ref: '#/paths/~1{entity_type}~1{id}~1tags/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tags + _get_entity_type_by_id_tags: + operation: + $ref: '#/paths/~1{entity_type}~1{id}~1tags/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_tags: + operation: + $ref: '#/paths/~1tags/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tags + _list_tags: + operation: + $ref: '#/paths/~1tags/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_tags: + operation: + $ref: '#/paths/~1tags/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_tag: + operation: + $ref: '#/paths/~1tags~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tag + _get_tag: + operation: + $ref: '#/paths/~1tags~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_tag: + operation: + $ref: '#/paths/~1tags~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + get_tags_by_entity_type: + operation: + $ref: '#/paths/~1tags~1{id}~1{entity_type}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.type + _get_tags_by_entity_type: + operation: + $ref: '#/paths/~1tags~1{id}~1{entity_type}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tags/methods/get_entity_type_by_id_tags' + - $ref: '#/components/x-stackQL-resources/tags/methods/get_tags_by_entity_type' + - $ref: '#/components/x-stackQL-resources/tags/methods/get_tag' + - $ref: '#/components/x-stackQL-resources/tags/methods/list_tags' + insert: + - $ref: '#/components/x-stackQL-resources/tags/methods/create_entity_type_by_id_change_tags' + - $ref: '#/components/x-stackQL-resources/tags/methods/create_tags' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/tags/methods/delete_tag' +paths: + '/{entity_type}/{id}/change_tags': + post: + x-pd-requires-scope: tags.write + tags: + - Tags + operationId: createEntityTypeByIdChangeTags + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags) + + Scoped OAuth requires: `tags.write` + summary: Assign tags + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/entity_type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + description: Tags to add to or remove from the entity. + properties: + add: + type: array + description: | + Array of tags and/or tag references to add to the entity. + For elements with type `tag_reference`, the tag with the corresponding `id` is added to the entity. + For elements with type `tag`, if there is an existing tag with the given + label that tag is added to the entity. If there is no existing tag with that label and the user has permission + to create tags, a new tag is created with that label and assigned to the entity. + items: + title: Tags to add + type: object + properties: + type: + type: string + enum: + - tag + - tag_reference + label: + type: string + description: The label of the tag. Should be used when type is "tag". + maxLength: 191 + id: + type: string + description: The id of the tag. Should be used when type is "tag_reference". + readOnly: true + required: + - type + remove: + type: array + description: Array of tag references to remove from the entity. + items: + title: Tags to remove. + type: object + properties: + type: + type: string + enum: + - tag_reference + id: + type: string + description: The id of the tag + readOnly: true + required: + - type + - id + examples: + tags: + summary: Request Example + value: + add: + - type: tag + label: Batman + - type: tag_reference + id: P5IYCNZ + remove: + - type: tag_reference + id: POE7RY8 + - type: tag_reference + id: PG68P1M + responses: + '200': + description: The tags were added and/or removed. + content: + application/json: + schema: + type: object + examples: + response: + summary: Request Example + value: + add: + - type: tag + label: Batman + - type: tag_reference + id: P5IYCNZ + remove: + - type: tag_reference + id: POE7RY8 + - type: tag_reference + id: PG68P1M + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/{entity_type}/{id}/tags': + get: + x-pd-requires-scope: tags.read + tags: + - Tags + operationId: getEntityTypeByIdTags + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags) + + Scoped OAuth requires: `tags.read` + summary: Get tags for entities + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/entity_type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: An array of tags. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + tags: + type: array + items: + $ref: '#/components/schemas/Tag' + required: + - tags + examples: + response: + summary: Response Example + value: + tags: + - type: tag + summary: Batman + self: 'https://api.pagerduty.com/tags/P5IYCNZ' + label: Batman + id: P5IYCNZ + html_url: null + limit: 100 + offset: 0 + total: 1 + more: false + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + /tags: + get: + x-pd-requires-scope: tags.read + tags: + - Tags + operationId: listTags + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags) + + Scoped OAuth requires: `tags.read` + summary: List tags + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/tag_query' + responses: + '200': + description: An array of tags names. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + tags: + type: array + items: + $ref: '#/components/schemas/Tag' + required: + - tags + examples: + response: + summary: Response Example + value: + tags: + - type: tag + summary: Batman + self: 'https://api.pagerduty.com/tags/P5IYCNZ' + label: Batman + id: P5IYCNZ + html_url: null + limit: 100 + offset: 0 + total: 1 + more: false + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + x-pd-requires-scope: tags.write + tags: + - Tags + operationId: createTags + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags) + + Scoped OAuth requires: `tags.write` + summary: Create a tag + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + requestBody: + content: + application/json: + schema: + type: object + properties: + tag: + $ref: '#/components/schemas/Tag' + required: + - tag + examples: + request: + summary: Request Example + value: + tag: + type: tag + label: Batman + responses: + '201': + description: The tag that was created. + content: + application/json: + schema: + type: object + properties: + tag: + $ref: '#/components/schemas/Tag' + required: + - tag + examples: + response: + summary: Response Example + value: + tag: + type: tag + summary: Batman + self: 'https://api.pagerduty.com/tags/P5IYCNZ' + label: Batman + id: P5IYCNZ + html_url: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/tags/{id}': + get: + x-pd-requires-scope: tags.read + tags: + - Tags + operationId: getTag + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags) + + Scoped OAuth requires: `tags.read` + summary: Get a tag + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: The tag requested. + content: + application/json: + schema: + type: object + properties: + tag: + $ref: '#/components/schemas/Tag' + required: + - tag + examples: + response: + summary: Response Example + value: + tag: + type: tag + summary: Batman + self: 'https://api.pagerduty.com/tags/P5IYCNZ' + label: Batman + id: P5IYCNZ + html_url: null + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + delete: + x-pd-requires-scope: tags.write + tags: + - Tags + operationId: deleteTag + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags) + + Scoped OAuth requires: `tags.write` + summary: Delete a tag + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '204': + description: The tag was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/tags/{id}/{entity_type}': + get: + x-pd-requires-scope: tags.read + tags: + - Tags + operationId: getTagsByEntityType + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags) + + Scoped OAuth requires: `tags.read` + summary: Get connected entities + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/entity_type' + responses: + '200': + description: An array of connected entities. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + users: + type: array + items: + $ref: '#/components/schemas/EntityReference' + teams: + type: array + items: + $ref: '#/components/schemas/EntityReference' + escalation_policies: + type: array + items: + $ref: '#/components/schemas/EntityReference' + examples: + response: + summary: Response Example + value: + users: + - id: PXPGF42 + type: user_reference + - id: PAM4FGS + type: user_reference + limit: 100 + offset: 0 + total: 2 + more: false + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/teams.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/teams.yaml new file mode 100644 index 0000000..fca6c20 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/teams.yaml @@ -0,0 +1,3870 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Team: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + type: + type: string + description: The type of object being created. + default: team + enum: + - team + name: + type: string + description: The name of the team. + maxLength: 100 + description: + type: string + description: The description of the team. + maxLength: 1024 + parent: + $ref: '#/components/schemas/TeamReference' + required: + - name + - type + example: + type: team + name: Engineering + description: The engineering team + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + TeamReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - team_reference + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + AuditRecordResponseSchema: + allOf: + - type: object + properties: + records: + type: array + items: + $ref: '#/components/schemas/AuditRecord' + response_metadata: + nullable: true + anyOf: + - $ref: '#/components/schemas/AuditMetadata' + required: + - records + - $ref: '#/components/schemas/CursorPagination' + AuditRecord: + type: object + readOnly: true + description: An Audit Trail record + properties: + id: + type: string + self: + type: string + nullable: true + description: Record URL. + execution_time: + type: string + format: date-time + description: 'The date/time the action executed, in ISO8601 format and millisecond precision.' + execution_context: + type: object + description: Action execution context + properties: + request_id: + type: string + nullable: true + description: Request Id + remote_address: + type: string + nullable: true + description: remote address + nullable: true + actors: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + method: + type: object + description: The method information + properties: + description: + type: string + nullable: true + truncated_token: + description: Truncated token containing the last 4 chars of the token's actual value. + type: string + nullable: true + example: 3xyz + type: + $ref: '#/components/parameters/audit_method_type/schema' + required: + - type + root_resource: + $ref: '#/components/schemas/Reference' + action: + type: string + example: create + details: + type: object + nullable: true + description: | + Additional details to provide further information about the action or + the resource that has been audited. + properties: + resource: + $ref: '#/components/schemas/Reference' + fields: + description: | + A set of fields that have been affected. + The fields that have not been affected MAY be returned. + type: array + nullable: true + items: + type: object + description: | + Information about the affected field. + When available, field's before and after values are returned: + + #### Resource creation + - `value` MAY be returned + + #### Resource update + - `value` MAY be returned + - `before_value` MAY be returned + + #### Resource deletion + - `before_value` MAY be returned + properties: + name: + type: string + description: Name of the resource field + example: name + description: + type: string + nullable: true + description: Human readable description of the resource field + example: First and Last name + value: + type: string + nullable: true + description: new or updated value of the field + example: Jonathan + before_value: + type: string + nullable: true + description: previous or deleted value of the field + example: John + required: + - name + references: + description: A set of references that have been affected. + type: array + nullable: true + items: + type: object + properties: + name: + type: string + description: Name of the reference field + example: team_members + description: + type: string + nullable: true + description: Human readable description of the references field + example: First and Last name + added: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + removed: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + required: + - name + required: + - resource + required: + - id + - execution_time + - method + - root_resource + - action + AuditMetadata: + type: object + properties: + messages: + type: array + nullable: true + items: + type: string + example: Message about the result + CursorPagination: + type: object + properties: + limit: + type: integer + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + readOnly: true + next_cursor: + type: string + description: | + An opaque string than will deliver the next set of results when provided as the `cursor` parameter in a subsequent request. A `null` value for this field indicates that there are no additional results. + example: dXNlcjaVMzc5V0ZYTlo= + nullable: true + readOnly: true + required: + - limit + - next_cursor + UserReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - user_reference + NotificationSubscription: + title: NotificationSubscription + description: An object describing the relationship of a NotificationSubscriber and a NotificationSubscribable. + type: object + properties: + subscriber_id: + type: string + description: The ID of the entity being subscribed + subscriber_type: + type: string + description: The type of the entity being subscribed + enum: + - user + - team + subscribable_id: + type: string + description: The ID of the entity being subscribed to + subscribable_type: + type: string + description: The type of the entity being subscribed to + enum: + - incident + - business_service + account_id: + type: string + description: The ID of the account belonging to the subscriber entity + x-examples: + example-1: + subscriber_id: string + subscriber_type: user + subscribable_id: string + subscribable_type: incident + account_id: string + NotificationSubscriptionWithContext: + title: NotificationSubscriptionWithContext + type: object + description: An object describing the relationship of a NotificationSubscriber and a NotificationSubscribable with additional context on status of subscription attempt. + x-examples: + example-1: + subscriber_id: string + subscriber_type: user + subscribable_id: string + subscribable_type: incident + account_id: string + result: success + properties: + subscriber_id: + type: string + description: The ID of the entity being subscribed + subscriber_type: + type: string + enum: + - user + - team + description: The type of the entity being subscribed + subscribable_id: + type: string + description: The ID of the entity being subscribed to + subscribable_type: + type: string + enum: + - incident + - business_service + description: The type of the entity being subscribed to + account_id: + type: string + description: The type of the entity being subscribed to + result: + type: string + enum: + - success + - duplicate + - unauthorized + description: The resulting status of the subscription + NotificationSubscribable: + title: NotificationSubscribable + description: A reference of a subscribable entity. + type: object + properties: + subscribable_id: + type: string + description: The ID of the entity to subscribe to + subscribable_type: + type: string + description: The type of the entity being subscribed to + enum: + - incident + - business_service + example: + subscribable_id: PD1234 + subscribable_type: incident + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + PaymentRequired: + description: | + Account does not have the abilities to perform the action. Please review the response for the required abilities. + You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + InternalServerError: + description: Internal Server Error the PagerDuty server experienced an error. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + UnprocessableEntity: + description: Unprocessable Entity. Some arguments failed validation checks. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + teams: + id: pagerduty.teams.teams + name: teams + title: Teams + methods: + create_team: + operation: + $ref: '#/paths/~1teams/post' + response: + mediaType: application/json + openAPIDocKey: '201' + list_teams: + operation: + $ref: '#/paths/~1teams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.teams + _list_teams: + operation: + $ref: '#/paths/~1teams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_team: + operation: + $ref: '#/paths/~1teams~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.team + _get_team: + operation: + $ref: '#/paths/~1teams~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_team: + operation: + $ref: '#/paths/~1teams~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_team: + operation: + $ref: '#/paths/~1teams~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/teams/methods/get_team' + - $ref: '#/components/x-stackQL-resources/teams/methods/list_teams' + insert: + - $ref: '#/components/x-stackQL-resources/teams/methods/create_team' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/teams/methods/delete_team' + audit_records: + id: pagerduty.teams.audit_records + name: audit_records + title: Audit Records + methods: + list_teams_audit_records: + operation: + $ref: '#/paths/~1teams~1{id}~1audit~1records/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.records + _list_teams_audit_records: + operation: + $ref: '#/paths/~1teams~1{id}~1audit~1records/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/audit_records/methods/list_teams_audit_records' + insert: [] + update: [] + delete: [] + escalation_policies: + id: pagerduty.teams.escalation_policies + name: escalation_policies + title: Escalation Policies + methods: + delete_team_escalation_policy: + operation: + $ref: '#/paths/~1teams~1{id}~1escalation_policies~1{escalation_policy_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_team_escalation_policy: + operation: + $ref: '#/paths/~1teams~1{id}~1escalation_policies~1{escalation_policy_id}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/escalation_policies/methods/delete_team_escalation_policy' + members: + id: pagerduty.teams.members + name: members + title: Members + methods: + list_team_users: + operation: + $ref: '#/paths/~1teams~1{id}~1members/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.members + _list_team_users: + operation: + $ref: '#/paths/~1teams~1{id}~1members/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_team_user: + operation: + $ref: '#/paths/~1teams~1{id}~1users~1{user_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_team_user: + operation: + $ref: '#/paths/~1teams~1{id}~1users~1{user_id}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/members/methods/list_team_users' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/members/methods/delete_team_user' + notification_subscriptions: + id: pagerduty.teams.notification_subscriptions + name: notification_subscriptions + title: Notification Subscriptions + methods: + get_team_notification_subscriptions: + operation: + $ref: '#/paths/~1teams~1{id}~1notification_subscriptions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.subscriptions + _get_team_notification_subscriptions: + operation: + $ref: '#/paths/~1teams~1{id}~1notification_subscriptions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_team_notification_subscriptions: + operation: + $ref: '#/paths/~1teams~1{id}~1notification_subscriptions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + remove_team_notification_subscriptions: + operation: + $ref: '#/paths/~1teams~1{id}~1notification_subscriptions~1unsubscribe/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/notification_subscriptions/methods/get_team_notification_subscriptions' + insert: + - $ref: '#/components/x-stackQL-resources/notification_subscriptions/methods/create_team_notification_subscriptions' + update: [] + delete: [] +paths: + /teams: + post: + x-pd-requires-scope: teams.write + tags: + - Teams + operationId: createTeam + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams) + + Scoped OAuth requires: `teams.write` + summary: Create a team + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + requestBody: + content: + application/json: + schema: + type: object + properties: + team: + $ref: '#/components/schemas/Team' + required: + - team + examples: + request: + summary: Request Example + value: + team: + type: team + name: Engineering + description: The engineering team + description: The team to be created. + responses: + '201': + description: The team that was created. + content: + application/json: + schema: + type: object + properties: + team: + $ref: '#/components/schemas/Team' + required: + - team + examples: + response: + summary: Response Example + value: + team: + id: PQ9K7I8 + type: team + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + name: Engineering + description: All engineering + base_role: observer + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + get: + x-pd-requires-scope: teams.read + tags: + - Teams + operationId: listTeams + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams) + + Scoped OAuth requires: `teams.read` + summary: List teams + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/query' + responses: + '200': + description: A paginated array of teams. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + teams: + type: array + items: + $ref: '#/components/schemas/Team' + required: + - teams + examples: + response: + summary: Response Example + value: + teams: + - id: PQ9K7I8 + type: team + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + name: Engineering + description: All engineering + limit: 100 + offset: 0 + more: false + total: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/teams/{id}': + get: + x-pd-requires-scope: teams.read + tags: + - Teams + operationId: getTeam + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams) + + Scoped OAuth requires: `teams.read` + summary: Get a team + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/include_teams' + responses: + '200': + description: The team requested. + content: + application/json: + schema: + type: object + properties: + team: + $ref: '#/components/schemas/Team' + required: + - team + examples: + response: + summary: Response Example + value: + team: + id: PQ9K7I8 + type: team + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + name: Engineering + description: All engineering + default_role: observer + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + delete: + x-pd-requires-scope: teams.write + tags: + - Teams + operationId: deleteTeam + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams) + + Scoped OAuth requires: `teams.write` + summary: Delete a team + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/reassignment_team' + - $ref: '#/components/parameters/id' + responses: + '204': + description: The team was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + x-pd-requires-scope: teams.write + tags: + - Teams + operationId: updateTeam + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams) + + Scoped OAuth requires: `teams.write` + summary: Update a team + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + team: + $ref: '#/components/schemas/Team' + required: + - team + examples: + request: + summary: Request Example + value: + team: + type: team + name: Engineering + description: The engineering team + description: The team to be updated. + responses: + '200': + description: The team that was updated. + content: + application/json: + schema: + type: object + properties: + team: + $ref: '#/components/schemas/Team' + required: + - team + examples: + response: + summary: Response Example + value: + team: + id: PQ9K7I8 + type: team + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + name: Engineering + description: All engineering + default_role: observer + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/teams/{id}/audit/records': + get: + x-pd-requires-scope: audit_records.read + tags: + - Teams + operationId: listTeamsAuditRecords + summary: List audit records for a team + description: | + 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` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/cursor_limit' + - $ref: '#/components/parameters/cursor_cursor' + - $ref: '#/components/parameters/audit_since' + - $ref: '#/components/parameters/audit_until' + responses: + '200': + description: Records matching the query criteria. + content: + application/json: + schema: + $ref: '#/components/schemas/AuditRecordResponseSchema' + examples: + response: + $ref: '#/components/examples/AuditRecordTeamResponse' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '/teams/{id}/escalation_policies/{escalation_policy_id}': + delete: + tags: + - Teams + x-pd-requires-scope: teams.write + operationId: deleteTeamEscalationPolicy + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams) + + Scoped OAuth requires: `teams.write` + summary: Remove an escalation policy from a team + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/team_escalation_policy_id' + responses: + '204': + description: The escalation policy was removed from the team. + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + tags: + - Teams + x-pd-requires-scope: teams.write + operationId: updateTeamEscalationPolicy + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams) + + Scoped OAuth requires: `teams.write` + summary: Add an escalation policy to a team + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/team_escalation_policy_id' + responses: + '204': + description: The escalation policy was added to the team. + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/teams/{id}/members': + get: + x-pd-requires-scope: teams.read + tags: + - Teams + operationId: listTeamUsers + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams) + + Scoped OAuth requires: `teams.read` + summary: List members of a team + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/include_teams_members' + responses: + '200': + description: A paginated array of users within the requested team. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + members: + type: array + uniqueItems: false + items: + type: object + properties: + user: + $ref: '#/components/schemas/UserReference' + role: + type: string + examples: + response: + summary: Response Example + value: + members: + - user: + id: P0XJYI9 + type: user_reference + summary: Jane Doe + self: 'https://api.pagerduty.com/users/P0XJYI9' + html_url: 'https://subdomain.pagerduty.com/users/P0XJYI9' + role: manager + limit: 100 + offset: 0 + more: false + total: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/teams/{id}/notification_subscriptions': + get: + x-pd-requires-scope: subscribers.read + summary: List Team Notification Subscriptions + tags: + - Teams + operationId: getTeamNotificationSubscriptions + description: | + Retrieve a list of Notification Subscriptions the given Team has. + + + > Teams must be added through `POST /teams/{id}/notification_subscriptions` to be returned from this endpoint. + + Scoped OAuth requires: `subscribers.read` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + subscriptions: + type: array + items: + type: object + properties: + subscription: + $ref: '#/components/schemas/NotificationSubscription' + subscribable_name: + type: string + nullable: true + description: The name of the subscribable + required: + - subscriptions + examples: + response: + summary: Response Example + value: + subscriptions: + - subscription: + subscriber_id: PD1234 + subscriber_type: team + subscribable_id: PD1234 + subscribable_type: incident + subscribable_name: null + account_id: PD1234 + - subscription: + subscriber_id: PD1234 + subscriber_type: team + subscribable_id: PD1234 + subscribable_type: business_service + subscribable_name: Online Payment + account_id: PD1234 + limit: 2 + offset: 0 + total: 1000 + more: true + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + x-pd-requires-scope: subscribers.write + summary: Create Team Notification Subscriptions + tags: + - Teams + operationId: createTeamNotificationSubscriptions + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + subscriptions: + type: array + items: + $ref: '#/components/schemas/NotificationSubscriptionWithContext' + examples: + response: + summary: Response Example + value: + subscriptions: + - account_id: PD1234 + subscribable_id: PD1234 + subscribable_type: incident + subscriber_id: PD1234 + subscriber_type: team + result: success + - account_id: PD1234 + subscribable_id: PD1234 + subscribable_type: business_service + subscriber_id: PD1234 + subscriber_type: team + result: duplicate + - account_id: PD1234 + subscribable_id: PD1235 + subscribable_type: business_service + subscriber_id: PD1234 + subscriber_type: team + result: unauthorized + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + description: | + Create new Notification Subscriptions for the given Team. + + Scoped OAuth requires: `subscribers.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + subscribables: + type: array + uniqueItems: true + minItems: 1 + items: + $ref: '#/components/schemas/NotificationSubscribable' + required: + - subscribables + examples: + request: + summary: Request Example + value: + subscribables: + - subscribable_type: incident + subscribable_id: PD1234 + - subscribable_type: business_service + subscribable_id: PD1234 + - subscribable_type: business_service + subscribable_id: PD1235 + description: The entities to subscribe to. + '/teams/{id}/notification_subscriptions/unsubscribe': + post: + x-pd-requires-scope: subscribers.write + tags: + - Teams + operationId: removeTeamNotificationSubscriptions + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + deleted_count: + type: number + unauthorized_count: + type: number + non_existent_count: + type: number + required: + - deleted_count + - unauthorized_count + - non_existent_count + examples: + response: + summary: Response Example + value: + deleted_count: 1 + unauthorized_count: 1 + non_existent_count: 0 + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '422': + $ref: '#/components/responses/UnprocessableEntity' + description: | + Unsubscribe the given Team from Notifications on the matching Subscribable entities. + + Scoped OAuth requires: `subscribers.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + subscribables: + type: array + uniqueItems: true + minItems: 1 + items: + $ref: '#/components/schemas/NotificationSubscribable' + required: + - subscribables + examples: + request: + summary: Response Example + value: + subscribables: + - subscribable_type: incident + subscribable_id: PD1234 + - subscribable_type: business_service + subscribable_id: PD1234 + description: The entities to unsubscribe from. + '/teams/{id}/users/{user_id}': + delete: + x-pd-requires-scope: teams.write + tags: + - Teams + operationId: deleteTeamUser + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams) + + Scoped OAuth requires: `teams.write` + summary: Remove a user from a team + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/team_user_id' + responses: + '204': + description: The user was removed to the team. + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + x-pd-requires-scope: teams.write + tags: + - Teams + operationId: updateTeamUser + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams) + + Scoped OAuth requires: `teams.write` + summary: Add a user to a team + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/team_user_id' + requestBody: + content: + application/json: + schema: + type: object + properties: + role: + type: string + description: The role of the user on the team. + enum: + - observer + - responder + - manager + examples: + role: + summary: Request Example + value: + role: observer + description: The role of the user on the team. + responses: + '204': + description: The user was added to the team. + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/templates.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/templates.yaml new file mode 100644 index 0000000..aed5cb2 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/templates.yaml @@ -0,0 +1,3121 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + Template: + allOf: + - $ref: '#/components/schemas/EditableTemplate' + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + type: + type: string + enum: + - template + created_by: + description: User/Account object reference of the creator + oneOf: + - $ref: '#/components/schemas/UserReference' + - allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - account_reference + updated_by: + description: User/Account object reference of the updator + oneOf: + - $ref: '#/components/schemas/UserReference' + - $ref: '#/components/schemas/Template/allOf/1/properties/created_by/oneOf/1' + EditableTemplate: + type: object + properties: + template_type: + type: string + description: The type of template (`status_update` is the only supported template at this time) + enum: + - status_update + name: + type: string + description: The name of the template + description: + type: string + nullable: true + description: Description of the template + templated_fields: + type: object + properties: + email_subject: + type: string + nullable: true + description: The subject of the e-mail + email_body: + type: string + nullable: true + description: The HTML body of the e-mail message + message: + type: string + nullable: true + description: |- + The short-message of the template (SMS, Push notification, Slack, + etc) + UserReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - user_reference + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + StatusUpdateTemplateInput: + type: object + properties: + incident_id: + type: string + description: The incident id to render the template for + status_update: + type: object + properties: + message: + type: string + description: An optional status update message that will be sent to the template + external: + description: An optional object collection that can be referenced in the template. + RenderedTemplate: + type: object + properties: + templated_fields: + type: object + properties: + email_subject: + type: string + description: The rendered e-mail subject + email_body: + type: string + description: The rendered e-mail body + message: + type: string + description: 'The rendered short message (SMS, Push, Slack, etc)' + warnings: + description: |- + List of render warnings messages for each rendered field. + (Ex: ["{{incident.invalid_field}} does not exist."]) + type: object + properties: + email_subject: + type: array + description: List of warnings for email_subject + email_body: + type: array + description: List of warnings for email_body + message: + type: array + description: List of warnings for message field + errors: + description: List of errors + type: array + items: + type: string + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + PaymentRequired: + description: | + Account does not have the abilities to perform the action. Please review the response for the required abilities. + You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + InternalServerError: + description: Internal Server Error the PagerDuty server experienced an error. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + templates: + id: pagerduty.templates.templates + name: templates + title: Templates + methods: + get_templates: + operation: + $ref: '#/paths/~1templates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.templates + _get_templates: + operation: + $ref: '#/paths/~1templates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_template: + operation: + $ref: '#/paths/~1templates/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_template: + operation: + $ref: '#/paths/~1templates~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.template + _get_template: + operation: + $ref: '#/paths/~1templates~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_template: + operation: + $ref: '#/paths/~1templates~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_template: + operation: + $ref: '#/paths/~1templates~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + render_template: + operation: + $ref: '#/paths/~1templates~1{id}~1render/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/templates/methods/get_template' + - $ref: '#/components/x-stackQL-resources/templates/methods/get_templates' + insert: + - $ref: '#/components/x-stackQL-resources/templates/methods/create_template' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/templates/methods/delete_template' +paths: + /templates: + get: + x-pd-requires-scope: templates.read + tags: + - Templates + operationId: getTemplates + description: | + Get a list of all the template on an account + + Scoped OAuth requires: `templates.read` + summary: List templates + parameters: + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/template_query' + - $ref: '#/components/parameters/template_type' + - $ref: '#/components/parameters/sort_by_template' + responses: + '200': + description: A paginated array of templates. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + templates: + type: array + items: + $ref: '#/components/schemas/Template' + required: + - templates + examples: + response: + summary: Response Example + value: + limit: 25 + more: false + offset: 0 + templates: + - created_at: '2022-12-30T16:00:00Z' + created_by: + id: PDZR4CN + self: 'https://api.pagerduty.com/users/PDZR4CN' + type: user_reference + description: Sample template description + id: PBZUP2B + name: Sample Template 160 + self: 'https://api.pagerduty.com/templates/PBZUP2B' + template_type: status_update + type: template + updated_at: '2022-12-30T16:00:00Z' + updated_by: + id: PGY287N + self: 'https://api.pagerduty.com/users/PGY287N' + type: user_reference + total: null + '400': + $ref: '#/components/responses/ArgumentError' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '500': + $ref: '#/components/responses/InternalServerError' + post: + x-pd-requires-scope: templates.write + tags: + - Templates + operationId: createTemplate + description: | + Create a new template + + Scoped OAuth requires: `templates.write` + summary: Create a template + requestBody: + content: + application/json: + schema: + type: object + properties: + template: + $ref: '#/components/schemas/EditableTemplate' + required: + - template + examples: + request: + summary: Request Example + value: + template: + description: Sample template description + templated_fields: + email_body:
sample
+ email_subject: Sample email Subject + message: Sample SMS message + name: Sample Template + template_type: status_update + required: true + responses: + '201': + description: Template successfully created + content: + application/json: + x-type: true + schema: + type: object + properties: + template: + $ref: '#/components/schemas/Template' + required: + - template + examples: + response: + summary: Response Example + value: + template: + created_at: '2022-08-19T13:46:22Z' + created_by: + id: PF9KMXH + self: 'https://api.pagerduty.com/users/PF9KMXH' + type: user_reference + description: Sample template description + templated_fields: + email_body:
sample
+ email_subject: Sample email Subject + message: Sample SMS message + id: PCCR863 + name: Sample Template + self: 'https://api.pagerduty.com/templates/PCCR863' + template_type: status_update + type: template + updated_at: '2022-08-19T13:46:22Z' + updated_by: + id: PF9KMXH + self: 'https://api.pagerduty.com/users/PF9KMXH' + type: user_reference + '400': + $ref: '#/components/responses/ArgumentError' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '500': + $ref: '#/components/responses/InternalServerError' + '/templates/{id}': + get: + x-pd-requires-scope: templates.read + tags: + - Templates + operationId: getTemplate + description: | + Get a single template on the account + + Scoped OAuth requires: `templates.read` + summary: Get a template + parameters: + - $ref: '#/components/parameters/id' + responses: + '200': + description: Successful operation + content: + application/json: + schema: + type: object + properties: + template: + $ref: '#/components/schemas/Template' + required: + - template + examples: + response: + summary: Response Example + value: + template: + created_at: '2022-12-30T16:00:00Z' + created_by: + id: PDZR4CN + self: 'https://api.pagerduty.com/users/PDZR4CN' + type: user_reference + description: Sample template description + templated_fields: + email_body:
sample
+ email_subject: Sample email Subject + message: Sample template message + id: PBZUP2B + name: Sample Template 160 + self: 'https://api.pagerduty.com/templates/PBZUP2B' + template_type: status_update + type: template + updated_at: '2022-12-30T16:00:00Z' + updated_by: + id: PGY287N + self: 'https://api.pagerduty.com/users/PGY287N' + type: user_reference + '400': + $ref: '#/components/responses/ArgumentError' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + put: + x-pd-requires-scope: templates.write + tags: + - Templates + operationId: updateTemplate + description: | + Update an existing template + + Scoped OAuth requires: `templates.write` + summary: Update a template + parameters: + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + template: + $ref: '#/components/schemas/EditableTemplate' + required: + - template + examples: + request: + summary: Request Example + value: + template: + description: Sample template description + templated_fields: + email_body:
sample
+ email_subject: Sample email Subject + message: Sample SMS message + name: Sample Template + template_type: status_update + required: true + responses: + '200': + description: Successful operation + content: + application/json: + schema: + type: object + properties: + template: + $ref: '#/components/schemas/Template' + required: + - template + examples: + response: + summary: Response Example + value: + template: + created_at: '2022-08-19T13:46:22Z' + created_by: + id: PF9KMXH + self: 'https://api.pagerduty.com/users/PF9KMXH' + type: user_reference + description: Sample template description + templated_fields: + email_body:
sample
+ email_subject: Sample email Subject + message: Sample SMS message + id: PCCR863 + name: Sample Template + self: 'https://api.pagerduty.com/templates/PCCR863' + template_type: status_update + type: template + updated_at: '2022-08-19T13:46:22Z' + updated_by: + id: PF9KMXH + self: 'https://api.pagerduty.com/users/PF9KMXH' + type: user_reference + '400': + $ref: '#/components/responses/ArgumentError' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + delete: + x-pd-requires-scope: templates.write + tags: + - Templates + operationId: deleteTemplate + description: | + Delete a specific of templates on the account + + Scoped OAuth requires: `templates.write` + summary: Delete a template + parameters: + - $ref: '#/components/parameters/id' + responses: + '204': + description: Successful operation + '400': + $ref: '#/components/responses/ArgumentError' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + '/templates/{id}/render': + post: + x-pd-requires-scope: templates.read + tags: + - Templates + operationId: renderTemplate + summary: Render a template + description: | + 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` + parameters: + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/StatusUpdateTemplateInput' + examples: + request: + summary: Request Example + value: + incident_id: QT4KHLK034QWE34 + status_update: + message: Status update message + required: true + responses: + '200': + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/RenderedTemplate' + examples: + response: + value: + templated_fields: + email_subject: 'Update: Status update message' + email_body:
Status update message
+ message: 'Update: Status update message' + warnings: + - email_body: + - '{{incident.bad_value}} does not exist.' + errors: [] + '400': + $ref: '#/components/responses/ArgumentError' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/users.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/users.yaml new file mode 100644 index 0000000..191ee19 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/users.yaml @@ -0,0 +1,5949 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + User: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + name: + type: string + description: The name of the user. + maxLength: 100 + type: + type: string + description: The type of object being created. + default: user + enum: + - user + email: + type: string + format: email + description: The user's email address. + minLength: 6 + maxLength: 100 + time_zone: + type: string + format: tzinfo + description: 'The preferred time zone name. If null, the account''s time zone will be used.' + color: + type: string + description: The schedule color. + role: + description: 'The user role. Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`.' + type: string + enum: + - admin + - limited_user + - observer + - owner + - read_only_user + - restricted_access + - read_only_limited_user + - user + avatar_url: + type: string + format: url + description: The URL of the user's avatar. + readOnly: true + description: + type: string + description: The user's bio. + nullable: true + invitation_sent: + type: boolean + readOnly: true + description: 'If true, the user has an outstanding invitation.' + job_title: + type: string + description: The user's title. + maxLength: 100 + teams: + type: array + readOnly: true + description: The list of teams to which the user belongs. Account must have the `teams` ability to set this. + items: + $ref: '#/components/schemas/TeamReference' + contact_methods: + type: array + readOnly: true + description: The list of contact methods for the user. + items: + $ref: '#/components/schemas/ContactMethodReference' + notification_rules: + readOnly: true + type: array + description: The list of notification rules for the user. + items: + $ref: '#/components/schemas/NotificationRuleReference' + license: + description: The License assigned to the User + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - license_reference + required: + - name + - email + - type + example: + type: user + name: Earline Greenholt + email: 125.greenholt.earline@graham.name + time_zone: America/Lima + color: green + role: admin + job_title: Director of Engineering + avatar_url: 'https://secure.gravatar.com/avatar/1d1a39d4635208d5664082a6c654a73f.png?d=mm&r=PG' + description: I'm the boss + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + TeamReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - team_reference + ContactMethodReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - email_contact_method_reference + - phone_contact_method_reference + - push_notification_contact_method_reference + - sms_contact_method_reference + NotificationRuleReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: object + properties: + type: + type: string + enum: + - assignment_notification_rule_reference + Reference: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + required: + - type + - id + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + AuditRecordResponseSchema: + allOf: + - type: object + properties: + records: + type: array + items: + $ref: '#/components/schemas/AuditRecord' + response_metadata: + nullable: true + anyOf: + - $ref: '#/components/schemas/AuditMetadata' + required: + - records + - $ref: '#/components/schemas/CursorPagination' + AuditRecord: + type: object + readOnly: true + description: An Audit Trail record + properties: + id: + type: string + self: + type: string + nullable: true + description: Record URL. + execution_time: + type: string + format: date-time + description: 'The date/time the action executed, in ISO8601 format and millisecond precision.' + execution_context: + type: object + description: Action execution context + properties: + request_id: + type: string + nullable: true + description: Request Id + remote_address: + type: string + nullable: true + description: remote address + nullable: true + actors: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + method: + type: object + description: The method information + properties: + description: + type: string + nullable: true + truncated_token: + description: Truncated token containing the last 4 chars of the token's actual value. + type: string + nullable: true + example: 3xyz + type: + $ref: '#/components/parameters/audit_method_type/schema' + required: + - type + root_resource: + $ref: '#/components/schemas/Reference' + action: + type: string + example: create + details: + type: object + nullable: true + description: | + Additional details to provide further information about the action or + the resource that has been audited. + properties: + resource: + $ref: '#/components/schemas/Reference' + fields: + description: | + A set of fields that have been affected. + The fields that have not been affected MAY be returned. + type: array + nullable: true + items: + type: object + description: | + Information about the affected field. + When available, field's before and after values are returned: + + #### Resource creation + - `value` MAY be returned + + #### Resource update + - `value` MAY be returned + - `before_value` MAY be returned + + #### Resource deletion + - `before_value` MAY be returned + properties: + name: + type: string + description: Name of the resource field + example: name + description: + type: string + nullable: true + description: Human readable description of the resource field + example: First and Last name + value: + type: string + nullable: true + description: new or updated value of the field + example: Jonathan + before_value: + type: string + nullable: true + description: previous or deleted value of the field + example: John + required: + - name + references: + description: A set of references that have been affected. + type: array + nullable: true + items: + type: object + properties: + name: + type: string + description: Name of the reference field + example: team_members + description: + type: string + nullable: true + description: Human readable description of the references field + example: First and Last name + added: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + removed: + type: array + nullable: true + items: + $ref: '#/components/schemas/Reference' + required: + - name + required: + - resource + required: + - id + - execution_time + - method + - root_resource + - action + AuditMetadata: + type: object + properties: + messages: + type: array + nullable: true + items: + type: string + example: Message about the result + CursorPagination: + type: object + properties: + limit: + type: integer + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + readOnly: true + next_cursor: + type: string + description: | + An opaque string than will deliver the next set of results when provided as the `cursor` parameter in a subsequent request. A `null` value for this field indicates that there are no additional results. + example: dXNlcjaVMzc5V0ZYTlo= + nullable: true + readOnly: true + required: + - limit + - next_cursor + PhoneContactMethod: + description: 'The Phone Contact Method of the User, used for Voice or SMS.' + allOf: + - $ref: '#/components/schemas/ContactMethod' + - type: object + properties: + type: + type: string + enum: + - phone_contact_method + - sms_contact_method + country_code: + type: integer + description: The 1-to-3 digit country calling code. + minimum: 1 + maximum: 1999 + enabled: + type: boolean + description: 'If true, this phone is capable of receiving SMS messages.' + readOnly: true + blacklisted: + type: boolean + description: 'If true, this phone has been blacklisted by PagerDuty and no messages will be sent to it.' + readOnly: true + required: + - country_code + example: + type: phone_contact_method + label: work + country_code: 123 + address: '1234567' + PushContactMethod: + description: The Push Contact Method of the User. + allOf: + - $ref: '#/components/schemas/ContactMethod' + - type: object + properties: + type: + type: string + enum: + - push_notification_contact_method + device_type: + type: string + description: The type of device. + enum: + - android + - ios + readOnly: true + sounds: + type: array + items: + $ref: '#/components/schemas/PushContactMethodSound' + created_at: + type: string + format: date-time + description: Time at which the contact method was created. + blacklisted: + type: boolean + description: 'If true, this phone has been blacklisted by PagerDuty and no messages will be sent to it.' + readOnly: true + required: + - device_type + example: + type: push_notification_contact_method + label: work + device_type: android + address: '12341234' + EmailContactMethod: + description: The Email Contact Method of the User. + allOf: + - $ref: '#/components/schemas/ContactMethod' + - type: object + properties: + type: + type: string + enum: + - email_contact_method + send_short_email: + type: boolean + description: Send an abbreviated email message instead of the standard email output. Useful for email-to-SMS gateways and email based pagers. + default: false + example: + type: email_contact_method + label: work + address: grady.haylie.126@hickle.net + send_short_email: false + ContactMethod: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + description: The method to contact a user. + properties: + type: + type: string + description: The type of contact method being created. + enum: + - email_contact_method + - phone_contact_method + - push_notification_contact_method + - sms_contact_method + label: + type: string + description: 'The label (e.g., "Work", "Mobile", etc.).' + address: + type: string + description: 'The "address" to deliver to: email, phone number, etc., depending on the type.' + discriminator: + propertyName: type + required: + - type + - label + - address + PushContactMethodSound: + type: object + properties: + type: + type: string + description: The type of sound. + enum: + - alert_high_urgency + - alert_low_urgency + file: + type: string + description: The sound file name. + LicenseWithCounts: + allOf: + - type: object + required: + - id + - description + - name + - valid_roles + properties: + id: + type: string + description: Uniquely identifies the resource + description: + type: string + description: | + Description of the License. May include the names of add-ons associated with + the License, if there are any. + name: + type: string + description: | + Name of the License. + valid_roles: + type: array + description: The roles a User with this License can have + items: + type: string + role_group: + type: string + enum: + - FullUser + - Stakeholder + description: Indicates whether this License is assignable to full or stakeholder Users + example: FullUser + type: + type: string + description: Type of object + self: + type: string + description: API URL to access the License + html_url: + type: string + description: HTML URL to access the License + summary: + type: string + description: Summary of the License + - type: object + properties: + current_value: + type: integer + description: How many of these Licenses are currently allocated to Users + allocations_available: + type: integer + nullable: true + description: | + How many of these licenses are available to be allocated to a user. If this + value is "null" then there is no limit on the number of allocations allowed. + NotificationRule: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + description: A rule for contacting the user. + properties: + type: + type: string + description: The type of object being created. + default: assignment_notification_rule + enum: + - assignment_notification_rule + start_delay_in_minutes: + type: integer + description: 'The delay before firing the rule, in minutes.' + minimum: 0 + contact_method: + $ref: '#/components/schemas/ContactMethodReference' + urgency: + type: string + enum: + - high + - low + description: Which incident urgency this rule is used for. Account must have the `urgencies` ability to have a low urgency notification rule. + required: + - start_delay_in_minutes + - urgency + - contact_method + - type + example: + type: assignment_notification_rule + start_delay_in_minutes: 0 + contact_method: + id: PXPGF42 + type: email_contact_method_reference + urgency: high + NotificationSubscription: + title: NotificationSubscription + description: An object describing the relationship of a NotificationSubscriber and a NotificationSubscribable. + type: object + properties: + subscriber_id: + type: string + description: The ID of the entity being subscribed + subscriber_type: + type: string + description: The type of the entity being subscribed + enum: + - user + - team + subscribable_id: + type: string + description: The ID of the entity being subscribed to + subscribable_type: + type: string + description: The type of the entity being subscribed to + enum: + - incident + - business_service + account_id: + type: string + description: The ID of the account belonging to the subscriber entity + x-examples: + example-1: + subscriber_id: string + subscriber_type: user + subscribable_id: string + subscribable_type: incident + account_id: string + NotificationSubscriptionWithContext: + title: NotificationSubscriptionWithContext + type: object + description: An object describing the relationship of a NotificationSubscriber and a NotificationSubscribable with additional context on status of subscription attempt. + x-examples: + example-1: + subscriber_id: string + subscriber_type: user + subscribable_id: string + subscribable_type: incident + account_id: string + result: success + properties: + subscriber_id: + type: string + description: The ID of the entity being subscribed + subscriber_type: + type: string + enum: + - user + - team + description: The type of the entity being subscribed + subscribable_id: + type: string + description: The ID of the entity being subscribed to + subscribable_type: + type: string + enum: + - incident + - business_service + description: The type of the entity being subscribed to + account_id: + type: string + description: The type of the entity being subscribed to + result: + type: string + enum: + - success + - duplicate + - unauthorized + description: The resulting status of the subscription + NotificationSubscribable: + title: NotificationSubscribable + description: A reference of a subscribable entity. + type: object + properties: + subscribable_id: + type: string + description: The ID of the entity to subscribe to + subscribable_type: + type: string + description: The type of the entity being subscribed to + enum: + - incident + - business_service + example: + subscribable_id: PD1234 + subscribable_type: incident + HandoffNotificationRule: + type: object + description: A rule for contacting the user for Handoff Notifications. + properties: + id: + type: string + readOnly: true + notify_advance_in_minutes: + type: integer + description: 'The delay before firing the rule, in minutes.' + minimum: 0 + handoff_type: + type: string + description: The type of handoff being created. + default: both + enum: + - both + - oncall + - offcall + contact_method: + $ref: '#/components/schemas/ContactMethodReference' + required: + - id + - handoff_type + - contact_method + example: + id: PXPGF42 + notify_advance_in_minutes: 180 + handoff_type: both + contact_method: + id: PXPGF42 + type: email_contact_method_reference + UserSession: + type: object + properties: + id: + type: string + readOnly: true + user_id: + type: string + readOnly: true + created_at: + type: string + format: date-time + readOnly: true + description: The date/time the user session was first created. + type: + type: string + readOnly: true + description: The type of the session + enum: + - browser + - oauth + summary: + type: string + readOnly: true + description: The summary of the session + required: + - id + - user_id + - created_at + - type + - summary + example: + id: PXPGF42 + user_id: PXPGF42 + created_at: '2018-10-06T21:30:42Z' + summary: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.131 Safari/537.36' + type: browser + StatusUpdateNotificationRule: + type: object + description: A rule for contacting the user for Incident Status Updates. + properties: + contact_method: + $ref: '#/components/schemas/ContactMethodReference' + required: + - contact_method + example: + contact_method: + id: PXPGF42 + type: email_contact_method_reference + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + PaymentRequired: + description: | + Account does not have the abilities to perform the action. Please review the response for the required abilities. + You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + InternalServerError: + description: Internal Server Error the PagerDuty server experienced an error. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + UnprocessableEntity: + description: Unprocessable Entity. Some arguments failed validation checks. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + users: + id: pagerduty.users.users + name: users + title: Users + methods: + list_users: + operation: + $ref: '#/paths/~1users/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.users + _list_users: + operation: + $ref: '#/paths/~1users/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_user: + operation: + $ref: '#/paths/~1users/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_user: + operation: + $ref: '#/paths/~1users~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.user + _get_user: + operation: + $ref: '#/paths/~1users~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_user: + operation: + $ref: '#/paths/~1users~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_user: + operation: + $ref: '#/paths/~1users~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/users/methods/get_user' + - $ref: '#/components/x-stackQL-resources/users/methods/list_users' + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create_user' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete_user' + audit_records: + id: pagerduty.users.audit_records + name: audit_records + title: Audit Records + methods: + list_users_audit_records: + operation: + $ref: '#/paths/~1users~1{id}~1audit~1records/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.records + _list_users_audit_records: + operation: + $ref: '#/paths/~1users~1{id}~1audit~1records/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/audit_records/methods/list_users_audit_records' + insert: [] + update: [] + delete: [] + contact_methods: + id: pagerduty.users.contact_methods + name: contact_methods + title: Contact Methods + methods: + get_user_contact_methods: + operation: + $ref: '#/paths/~1users~1{id}~1contact_methods/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.methods + _get_user_contact_methods: + operation: + $ref: '#/paths/~1users~1{id}~1contact_methods/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_user_contact_method: + operation: + $ref: '#/paths/~1users~1{id}~1contact_methods/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_user_contact_method: + operation: + $ref: '#/paths/~1users~1{id}~1contact_methods~1{contact_method_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.contact_method + _get_user_contact_method: + operation: + $ref: '#/paths/~1users~1{id}~1contact_methods~1{contact_method_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_user_contact_method: + operation: + $ref: '#/paths/~1users~1{id}~1contact_methods~1{contact_method_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_user_contact_method: + operation: + $ref: '#/paths/~1users~1{id}~1contact_methods~1{contact_method_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/contact_methods/methods/get_user_contact_method' + - $ref: '#/components/x-stackQL-resources/contact_methods/methods/get_user_contact_methods' + insert: + - $ref: '#/components/x-stackQL-resources/contact_methods/methods/create_user_contact_method' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/contact_methods/methods/delete_user_contact_method' + license: + id: pagerduty.users.license + name: license + title: License + methods: + get_user_license: + operation: + $ref: '#/paths/~1users~1{id}~1license/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.license + _get_user_license: + operation: + $ref: '#/paths/~1users~1{id}~1license/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/license/methods/get_user_license' + insert: [] + update: [] + delete: [] + notification_rules: + id: pagerduty.users.notification_rules + name: notification_rules + title: Notification Rules + methods: + get_user_notification_rules: + operation: + $ref: '#/paths/~1users~1{id}~1notification_rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.rules + _get_user_notification_rules: + operation: + $ref: '#/paths/~1users~1{id}~1notification_rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_user_notification_rule: + operation: + $ref: '#/paths/~1users~1{id}~1notification_rules/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_user_notification_rule: + operation: + $ref: '#/paths/~1users~1{id}~1notification_rules~1{notification_rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.notification_rule + _get_user_notification_rule: + operation: + $ref: '#/paths/~1users~1{id}~1notification_rules~1{notification_rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_user_notification_rule: + operation: + $ref: '#/paths/~1users~1{id}~1notification_rules~1{notification_rule_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_user_notification_rule: + operation: + $ref: '#/paths/~1users~1{id}~1notification_rules~1{notification_rule_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/notification_rules/methods/get_user_notification_rule' + - $ref: '#/components/x-stackQL-resources/notification_rules/methods/get_user_notification_rules' + insert: + - $ref: '#/components/x-stackQL-resources/notification_rules/methods/create_user_notification_rule' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/notification_rules/methods/delete_user_notification_rule' + notification_subscriptions: + id: pagerduty.users.notification_subscriptions + name: notification_subscriptions + title: Notification Subscriptions + methods: + get_user_notification_subscriptions: + operation: + $ref: '#/paths/~1users~1{id}~1notification_subscriptions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.subscriptions + _get_user_notification_subscriptions: + operation: + $ref: '#/paths/~1users~1{id}~1notification_subscriptions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_user_notification_subscriptions: + operation: + $ref: '#/paths/~1users~1{id}~1notification_subscriptions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + unsubscribe_user_notification_subscriptions: + operation: + $ref: '#/paths/~1users~1{id}~1notification_subscriptions~1unsubscribe/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/notification_subscriptions/methods/get_user_notification_subscriptions' + insert: + - $ref: '#/components/x-stackQL-resources/notification_subscriptions/methods/create_user_notification_subscriptions' + update: [] + delete: [] + oncall_handoff_notification_rules: + id: pagerduty.users.oncall_handoff_notification_rules + name: oncall_handoff_notification_rules + title: Oncall Handoff Notification Rules + methods: + get_user_handoff_notification_rules: + operation: + $ref: '#/paths/~1users~1{id}~1oncall_handoff_notification_rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.oncall_handoff_notification_rules + _get_user_handoff_notification_rules: + operation: + $ref: '#/paths/~1users~1{id}~1oncall_handoff_notification_rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_user_handoff_notification_rule: + operation: + $ref: '#/paths/~1users~1{id}~1oncall_handoff_notification_rules/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_user_handoff_notifiaction_rule: + operation: + $ref: '#/paths/~1users~1{id}~1oncall_handoff_notification_rules~1{oncall_handoff_notification_rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.oncall_handoff_notification_rule + _get_user_handoff_notifiaction_rule: + operation: + $ref: '#/paths/~1users~1{id}~1oncall_handoff_notification_rules~1{oncall_handoff_notification_rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_user_handoff_notification_rule: + operation: + $ref: '#/paths/~1users~1{id}~1oncall_handoff_notification_rules~1{oncall_handoff_notification_rule_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_user_handoff_notification: + operation: + $ref: '#/paths/~1users~1{id}~1oncall_handoff_notification_rules~1{oncall_handoff_notification_rule_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/oncall_handoff_notification_rules/methods/get_user_handoff_notifiaction_rule' + - $ref: '#/components/x-stackQL-resources/oncall_handoff_notification_rules/methods/get_user_handoff_notification_rules' + insert: + - $ref: '#/components/x-stackQL-resources/oncall_handoff_notification_rules/methods/create_user_handoff_notification_rule' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/oncall_handoff_notification_rules/methods/delete_user_handoff_notification_rule' + sessions: + id: pagerduty.users.sessions + name: sessions + title: Sessions + methods: + get_user_sessions: + operation: + $ref: '#/paths/~1users~1{id}~1sessions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sessions + _get_user_sessions: + operation: + $ref: '#/paths/~1users~1{id}~1sessions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_user_sessions: + operation: + $ref: '#/paths/~1users~1{id}~1sessions/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + get_user_session: + operation: + $ref: '#/paths/~1users~1{id}~1sessions~1{type}~1{session_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.user_session + _get_user_session: + operation: + $ref: '#/paths/~1users~1{id}~1sessions~1{type}~1{session_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_user_session: + operation: + $ref: '#/paths/~1users~1{id}~1sessions~1{type}~1{session_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sessions/methods/get_user_session' + - $ref: '#/components/x-stackQL-resources/sessions/methods/get_user_sessions' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/sessions/methods/delete_user_session' + - $ref: '#/components/x-stackQL-resources/sessions/methods/delete_user_sessions' + status_update_notification_rules: + id: pagerduty.users.status_update_notification_rules + name: status_update_notification_rules + title: Status Update Notification Rules + methods: + get_user_status_update_notification_rules: + operation: + $ref: '#/paths/~1users~1{id}~1status_update_notification_rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.rules + _get_user_status_update_notification_rules: + operation: + $ref: '#/paths/~1users~1{id}~1status_update_notification_rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_user_status_update_notification_rule: + operation: + $ref: '#/paths/~1users~1{id}~1status_update_notification_rules/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_user_status_update_notification_rule: + operation: + $ref: '#/paths/~1users~1{id}~1status_update_notification_rules~1{status_update_notification_rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.notification_rule + _get_user_status_update_notification_rule: + operation: + $ref: '#/paths/~1users~1{id}~1status_update_notification_rules~1{status_update_notification_rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_user_status_update_notification_rule: + operation: + $ref: '#/paths/~1users~1{id}~1status_update_notification_rules~1{status_update_notification_rule_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_user_status_update_notification_rule: + operation: + $ref: '#/paths/~1users~1{id}~1status_update_notification_rules~1{status_update_notification_rule_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/status_update_notification_rules/methods/get_user_status_update_notification_rule' + - $ref: '#/components/x-stackQL-resources/status_update_notification_rules/methods/get_user_status_update_notification_rules' + insert: + - $ref: '#/components/x-stackQL-resources/status_update_notification_rules/methods/create_user_status_update_notification_rule' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/status_update_notification_rules/methods/delete_user_status_update_notification_rule' + me: + id: pagerduty.users.me + name: me + title: Me + methods: + get_current_user: + operation: + $ref: '#/paths/~1users~1me/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.user + _get_current_user: + operation: + $ref: '#/paths/~1users~1me/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/me/methods/get_current_user' + insert: [] + update: [] + delete: [] +paths: + /users: + get: + x-pd-requires-scope: users.read + tags: + - Users + operationId: listUsers + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users.read` + summary: List users + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/team_ids' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/include_user' + responses: + '200': + description: A paginated array of users. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + users: + type: array + items: + $ref: '#/components/schemas/User' + required: + - users + examples: + response: + summary: Response Example + value: + users: + - id: PXPGF42 + type: user + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + name: Earline Greenholt + email: 125.greenholt.earline@graham.name + time_zone: America/Lima + color: green + role: admin + avatar_url: 'https://secure.gravatar.com/avatar/a8b714a39626f2444ee05990b078995f.png?d=mm&r=PG' + description: I'm the boss + invitation_sent: false + contact_methods: + - id: PTDVERC + type: email_contact_method_reference + summary: Default + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PTDVERC' + notification_rules: + - id: P8GRWKK + type: assignment_notification_rule_reference + summary: Default + self: 'https://api.pagerduty.com/users/PXPGF42/notification_rules/P8GRWKK' + html_url: null + job_title: Director of Engineering + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + - id: PAM4FGS + type: user + summary: Kyler Kuhn + self: 'https://api.pagerduty.com/users/PAM4FGS' + html_url: 'https://subdomain.pagerduty.com/users/PAM4FGS' + name: Kyler Kuhn + email: 126_dvm_kyler_kuhn@beahan.name + time_zone: Asia/Hong_Kong + color: red + role: admin + avatar_url: 'https://secure.gravatar.com/avatar/47857d059adacf9a41dc4030c2e14b0a.png?d=mm&r=PG' + description: 'Actually, I am the boss' + invitation_sent: false + contact_methods: + - id: PVMGSML + type: email_contact_method_reference + summary: Work + self: 'https://api.pagerduty.com/users/PAM4FGS/contact_methods/PVMGSMLL' + notification_rules: + - id: P8GRWKK + type: assignment_notification_rule_reference + summary: Default + self: 'https://api.pagerduty.com/users/PXPGF42/notification_rules/P8GRWKK' + html_url: null + job_title: Senior Engineer + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + limit: 25 + offset: 0 + more: false + total: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + x-pd-requires-scope: users.write + tags: + - Users + operationId: createUser + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users.write` + summary: Create a user + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/from_header' + requestBody: + content: + application/json: + schema: + type: object + properties: + user: + $ref: '#/components/schemas/User' + required: + - user + examples: + request: + summary: Request Example + value: + user: + type: user + name: Earline Greenholt + email: 125.greenholt.earline@graham.name + time_zone: America/Lima + color: green + role: admin + job_title: Director of Engineering + avatar_url: 'https://secure.gravatar.com/avatar/1d1a39d4635208d5664082a6c654a73f.png?d=mm&r=PG' + description: I'm the boss + license: + id: PTDVERC + type: license_reference + description: The user to be created. + responses: + '201': + description: The user that was created. + content: + application/json: + schema: + type: object + properties: + user: + $ref: '#/components/schemas/User' + required: + - user + examples: + response: + summary: Response Example + value: + user: + id: PXPGF42 + type: user + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + name: Earline Greenholt + email: 125.greenholt.earline@graham.name + time_zone: America/Lima + color: green + role: admin + avatar_url: 'https://secure.gravatar.com/avatar/a8b714a39626f2444ee05990b078995f.png?d=mm&r=PG' + description: I'm the boss + invitation_sent: false + contact_methods: + - id: PTDVERC + type: email_contact_method_reference + summary: Default + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PTDVERC' + notification_rules: + - id: P8GRWKK + type: assignment_notification_rule_reference + summary: Default + self: 'https://api.pagerduty.com/users/PXPGF42/notification_rules/P8GRWKK' + html_url: null + job_title: Director of Engineering + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/users/{id}': + get: + x-pd-requires-scope: users.read + tags: + - Users + operationId: getUser + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users.read` + summary: Get a user + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/include_user' + responses: + '200': + description: The user requested. + content: + application/json: + schema: + type: object + properties: + user: + $ref: '#/components/schemas/User' + required: + - user + examples: + response: + summary: Response Example + value: + user: + id: PXPGF42 + type: user + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + name: Earline Greenholt + email: 125.greenholt.earline@graham.name + time_zone: America/Lima + color: green + role: admin + avatar_url: 'https://secure.gravatar.com/avatar/a8b714a39626f2444ee05990b078995f.png?d=mm&r=PG' + description: I'm the boss + invitation_sent: false + contact_methods: + - id: PTDVERC + type: email_contact_method_reference + summary: Default + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PTDVERC' + notification_rules: + - id: P8GRWKK + type: assignment_notification_rule_reference + summary: Default + self: 'https://api.pagerduty.com/users/PXPGF42/notification_rules/P8GRWKK' + html_url: null + job_title: Director of Engineering + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + delete: + x-pd-requires-scope: users.write + tags: + - Users + operationId: deleteUser + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users.write` + summary: Delete a user + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '204': + description: The user was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + x-pd-requires-scope: users.write + tags: + - Users + operationId: updateUser + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users.write` + summary: Update a user + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + user: + $ref: '#/components/schemas/User' + required: + - user + examples: + request: + summary: Request Example + value: + user: + type: user + name: Earline Greenholt + email: 125.greenholt.earline@graham.name + time_zone: America/Lima + color: green + role: admin + job_title: Director of Engineering + avatar_url: 'https://secure.gravatar.com/avatar/1d1a39d4635208d5664082a6c654a73f.png?d=mm&r=PG' + description: I'm the boss + license: + id: PTDVERC + type: license_reference + description: The user to be updated. + responses: + '200': + description: The user that was updated. + content: + application/json: + schema: + type: object + properties: + user: + $ref: '#/components/schemas/User' + required: + - user + examples: + response: + summary: Response Example + value: + user: + id: PXPGF42 + type: user + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + name: Earline Greenholt + email: 125.greenholt.earline@graham.name + time_zone: America/Lima + color: green + role: admin + avatar_url: 'https://secure.gravatar.com/avatar/a8b714a39626f2444ee05990b078995f.png?d=mm&r=PG' + description: I'm the boss + invitation_sent: false + contact_methods: + - id: PTDVERC + type: email_contact_method_reference + summary: Default + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PTDVERC' + notification_rules: + - id: P8GRWKK + type: assignment_notification_rule_reference + summary: Default + self: 'https://api.pagerduty.com/users/PXPGF42/notification_rules/P8GRWKK' + html_url: null + job_title: Director of Engineering + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/users/{id}/audit/records': + get: + x-pd-requires-scope: audit_records.read + tags: + - Users + operationId: listUsersAuditRecords + summary: List audit records for a user + description: | + 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` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/cursor_limit' + - $ref: '#/components/parameters/cursor_cursor' + - $ref: '#/components/parameters/audit_since' + - $ref: '#/components/parameters/audit_until' + responses: + '200': + description: Records matching the query criteria. + content: + application/json: + schema: + $ref: '#/components/schemas/AuditRecordResponseSchema' + examples: + response: + $ref: '#/components/examples/AuditRecordUserResponse' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '/users/{id}/contact_methods': + get: + x-pd-requires-scope: 'users:contact_methods.read' + tags: + - Users + operationId: getUserContactMethods + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users:contact_methods.read` + summary: List a user's contact methods + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: A list of contact methods. + content: + application/json: + schema: + type: object + properties: + contact_methods: + type: array + items: + oneOf: + - $ref: '#/components/schemas/PhoneContactMethod' + - $ref: '#/components/schemas/PushContactMethod' + - $ref: '#/components/schemas/EmailContactMethod' + examples: + response: + summary: Response Example + value: + contact_methods: + - id: PXPGF42 + type: email_contact_method + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_method/PXPGF42' + label: Work + address: grady.haylie.126@hickle.net + send_short_email: false + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + x-pd-requires-scope: 'users:contact_methods.write' + tags: + - Users + operationId: createUserContactMethod + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users:contact_methods.write` + summary: Create a user contact method + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + contact_method: + oneOf: + - $ref: '#/components/schemas/PhoneContactMethod' + - $ref: '#/components/schemas/PushContactMethod' + - $ref: '#/components/schemas/EmailContactMethod' + required: + - contact_method + examples: + request: + summary: Request Example + value: + contact_method: + id: PXPGF42 + type: email_contact_method + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_method/PXPGF42' + label: Work + address: grady.haylie.126@hickle.net + send_short_email: false + description: The contact method to be created. + responses: + '201': + description: The contact method that was created. + content: + application/json: + schema: + type: object + properties: + contact_method: + oneOf: + - $ref: '#/components/schemas/PhoneContactMethod' + - $ref: '#/components/schemas/PushContactMethod' + - $ref: '#/components/schemas/EmailContactMethod' + examples: + response: + summary: Response Example + value: + contact_method: + id: PXPGF42 + type: email_contact_method + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_method/PXPGF42' + label: Work + address: grady.haylie.126@hickle.net + send_short_email: false + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/users/{id}/contact_methods/{contact_method_id}': + get: + x-pd-requires-scope: 'users:contact_methods.read' + tags: + - Users + operationId: getUserContactMethod + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users:contact_methods.read` + summary: Get a user's contact method + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/user_contact_method_id' + responses: + '200': + description: The user's contact method requested. + content: + application/json: + schema: + type: object + properties: + contact_method: + oneOf: + - $ref: '#/components/schemas/PhoneContactMethod' + - $ref: '#/components/schemas/PushContactMethod' + - $ref: '#/components/schemas/EmailContactMethod' + examples: + response: + summary: Response Example + value: + contact_method: + id: PXPGF42 + type: email_contact_method + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_method/PXPGF42' + label: Work + address: grady.haylie.126@hickle.net + send_short_email: false + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + delete: + x-pd-requires-scope: 'users:contact_methods.write' + tags: + - Users + operationId: deleteUserContactMethod + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users:contact_methods.write` + summary: Delete a user's contact method + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/user_contact_method_id' + responses: + '204': + description: The contact method was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + x-pd-requires-scope: 'users:contact_methods.write' + tags: + - Users + operationId: updateUserContactMethod + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users:contact_methods.write` + summary: Update a user's contact method + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/user_contact_method_id' + requestBody: + content: + application/json: + schema: + type: object + properties: + contact_method: + oneOf: + - $ref: '#/components/schemas/PhoneContactMethod' + - $ref: '#/components/schemas/PushContactMethod' + - $ref: '#/components/schemas/EmailContactMethod' + required: + - contact_method + examples: + request: + summary: Request Example + value: + contact_method: + id: PXPGF42 + type: email_contact_method + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_method/PXPGF42' + label: Work + address: grady.haylie.126@hickle.net + send_short_email: false + description: The user's contact method to be updated. + responses: + '200': + description: The user's contact method that was updated. + content: + application/json: + schema: + type: object + properties: + contact_method: + oneOf: + - $ref: '#/components/schemas/PhoneContactMethod' + - $ref: '#/components/schemas/PushContactMethod' + - $ref: '#/components/schemas/EmailContactMethod' + examples: + response: + summary: Response Example + value: + contact_method: + id: PXPGF42 + type: email_contact_method + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_method/PXPGF42' + label: Work + address: grady.haylie.126@hickle.net + send_short_email: false + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/users/{id}/license': + get: + x-pd-requires-scope: licenses.read + tags: + - Users + operationId: getUserLicense + description: | + Get the License allocated to a User + + Scoped OAuth requires: `licenses.read` + summary: Get the License allocated to a User + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: The License allocated to the User + content: + application/json: + schema: + type: object + properties: + license: + $ref: '#/components/schemas/LicenseWithCounts/allOf/0' + required: + - license + examples: + response: + summary: Response Example + value: + license: + id: PIP248G + name: Business (Full User) + description: Event Intelligence + valid_roles: + - owner + - admin + - user + - limited_user + - observer + - restricted_access + role_group: FullUser + summary: Business (Full User) + type: license + self: null + html_url: null + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '/users/{id}/notification_rules': + get: + x-pd-requires-scope: 'users:contact_methods.read' + tags: + - Users + operationId: getUserNotificationRules + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users:contact_methods.read` + summary: List a user's notification rules + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/include_notification_rules' + - $ref: '#/components/parameters/urgency' + responses: + '200': + description: A list of notification rules. + content: + application/json: + schema: + type: object + properties: + notification_rules: + type: array + items: + $ref: '#/components/schemas/NotificationRule' + required: + - notification_rules + examples: + response: + summary: Response Example + value: + notification_rules: + - id: PXPGF42 + type: assignment_notification_rule + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/notification_rules/PPSCXAN' + start_delay_in_minutes: 0 + contact_method: + id: PXPGF42 + type: email_contact_method_reference + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PXPGF42' + html_url: null + created_at: '2016-02-01T16:06:27-05:00' + urgency: high + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + x-pd-requires-scope: 'users:contact_methods.write' + tags: + - Users + operationId: createUserNotificationRule + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users:contact_methods.write` + summary: Create a user notification rule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + notification_rule: + $ref: '#/components/schemas/NotificationRule' + required: + - notification_rule + examples: + request: + summary: Request Example + value: + notification_rule: + type: assignment_notification_rule + start_delay_in_minutes: 0 + contact_method: + id: PXPGF42 + type: email_contact_method_reference + urgency: high + description: The notification rule to be created. + responses: + '201': + description: The notification rule that was created. + content: + application/json: + schema: + type: object + properties: + notification_rule: + $ref: '#/components/schemas/NotificationRule' + required: + - notification_rule + examples: + response: + summary: Response Example + value: + notification_rule: + id: PXPGF42 + type: assignment_notification_rule + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/notification_rules/PPSCXAN' + start_delay_in_minutes: 0 + contact_method: + id: PXPGF42 + type: email_contact_method_reference + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PXPGF42' + html_url: null + created_at: '2016-02-01T16:06:27-05:00' + urgency: high + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/users/{id}/notification_rules/{notification_rule_id}': + get: + x-pd-requires-scope: 'users:contact_methods.read' + tags: + - Users + operationId: getUserNotificationRule + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users:contact_methods.read` + summary: Get a user's notification rule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/user_notification_rule_id' + - $ref: '#/components/parameters/include_notification_rules' + responses: + '200': + description: The user's notification rule requested. + content: + application/json: + schema: + type: object + properties: + notification_rule: + $ref: '#/components/schemas/NotificationRule' + required: + - notification_rule + examples: + response: + summary: Response Example + value: + notification_rule: + id: PXPGF42 + type: assignment_notification_rule + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/notification_rules/PPSCXAN' + start_delay_in_minutes: 0 + contact_method: + id: PXPGF42 + type: email_contact_method_reference + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PXPGF42' + created_at: '2016-02-01T16:06:27-05:00' + urgency: high + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + delete: + x-pd-requires-scope: 'users:contact_methods.write' + tags: + - Users + operationId: deleteUserNotificationRule + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users:contact_methods.write` + summary: Delete a user's notification rule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/user_notification_rule_id' + responses: + '204': + description: The notification rule was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + x-pd-requires-scope: 'users:contact_methods.write' + tags: + - Users + operationId: updateUserNotificationRule + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users:contact_methods.write` + summary: Update a user's notification rule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/user_notification_rule_id' + requestBody: + content: + application/json: + schema: + type: object + properties: + notification_rule: + $ref: '#/components/schemas/NotificationRule' + required: + - notification_rule + examples: + request: + summary: Request Example + value: + notification_rule: + type: assignment_notification_rule + start_delay_in_minutes: 0 + contact_method: + id: PXPGF42 + type: email_contact_method_reference + urgency: high + description: The user's notification rule to be updated. + responses: + '200': + description: The user's notification rule that was updated. + content: + application/json: + schema: + type: object + properties: + notification_rule: + $ref: '#/components/schemas/NotificationRule' + examples: + response: + summary: Response Example + value: + notification_rule: + id: PXPGF42 + type: assignment_notification_rule + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/notification_rules/PPSCXAN' + start_delay_in_minutes: 0 + contact_method: + id: PXPGF42 + type: email_contact_method_reference + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PXPGF42' + created_at: '2016-02-01T16:06:27-05:00' + urgency: high + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/users/{id}/notification_subscriptions': + get: + x-pd-requires-scope: subscribers.read + tags: + - Users + operationId: getUserNotificationSubscriptions + description: | + Retrieve a list of Notification Subscriptions the given User has. + + + > Users must be added through `POST /users/{id}/notification_subscriptions` to be returned from this endpoint. + + Scoped OAuth requires: `subscribers.read` + summary: List Notification Subscriptions + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + subscriptions: + type: array + items: + type: object + properties: + subscription: + $ref: '#/components/schemas/NotificationSubscription' + subscribable_name: + type: string + nullable: true + description: The name of the subscribable + required: + - subscriptions + examples: + response: + summary: Response Example + value: + subscriptions: + - subscription: + subscriber_id: PD1234 + subscriber_type: user + subscribable_id: PD1234 + subscribable_type: incident + subscribable_name: null + account_id: PD1234 + - subscription: + subscriber_id: PD1234 + subscriber_type: user + subscribable_id: PD1234 + subscribable_type: business_service + subscribable_name: business service name + account_id: PD1234 + limit: 2 + offset: 0 + total: 1000 + more: true + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + x-pd-requires-scope: subscribers.write + summary: Create Notification Subcriptions + operationId: createUserNotificationSubscriptions + tags: + - Users + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + subscriptions: + type: array + items: + $ref: '#/components/schemas/NotificationSubscriptionWithContext' + examples: + response: + summary: Response Example + value: + subscriptions: + - account_id: PD1234 + subscribable_id: PD1234 + subscribable_type: incident + subscriber_id: PD1234 + subscriber_type: user + result: success + - account_id: PD1234 + subscribable_id: PD1234 + subscribable_type: business_service + subscriber_id: PD1234 + subscriber_type: user + result: duplicate + - account_id: PD1234 + subscribable_id: PD1235 + subscribable_type: business_service + subscriber_id: PD1234 + subscriber_type: user + result: unauthorized + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '422': + $ref: '#/components/responses/UnprocessableEntity' + description: | + Create new Notification Subscriptions for the given User. + + Scoped OAuth requires: `subscribers.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + subscribables: + type: array + uniqueItems: true + minItems: 1 + items: + $ref: '#/components/schemas/NotificationSubscribable' + required: + - subscribables + examples: + request: + summary: Request Example + value: + subscribables: + - subscribable_type: incident + subscribable_id: PD1234 + - subscribable_type: business_service + subscribable_id: PD1234 + - subscribable_type: business_service + subscribable_id: PD1235 + description: The entities to subscribe to. + '/users/{id}/notification_subscriptions/unsubscribe': + post: + x-pd-requires-scope: subscribers.write + summary: Remove Notification Subscriptions + tags: + - Users + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + deleted_count: + type: number + unauthorized_count: + type: number + non_existent_count: + type: number + required: + - deleted_count + - unauthorized_count + - non_existent_count + examples: + response: + summary: Response Example + value: + deleted_count: 1 + unauthorized_count: 1 + non_existent_count: 0 + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '422': + $ref: '#/components/responses/UnprocessableEntity' + operationId: unsubscribeUserNotificationSubscriptions + description: | + Unsubscribe the given User from Notifications on the matching Subscribable entities. + + Scoped OAuth requires: `subscribers.write` + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + subscribables: + type: array + uniqueItems: true + minItems: 1 + items: + $ref: '#/components/schemas/NotificationSubscribable' + required: + - subscribables + examples: + request: + summary: Response Example + value: + subscribables: + - subscribable_type: incident + subscribable_id: PD1234 + - subscribable_type: business_service + subscribable_id: PD1234 + description: The entities to unsubscribe from. + '/users/{id}/oncall_handoff_notification_rules': + get: + tags: + - Users + x-pd-requires-scope: users.read + operationId: getUserHandoffNotificationRules + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users.read` + summary: List a User's Handoff Notification Rules + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: A list of Handoff Notification Rules. + content: + application/json: + schema: + type: object + properties: + oncall_handoff_notification_rules: + type: array + items: + $ref: '#/components/schemas/HandoffNotificationRule' + required: + - oncall_handoff_notification_rules + examples: + response: + summary: Response Example + value: + oncall_handoff_notification_rules: + - id: PXPGF42 + handoff_type: both + notify_advance_in_minutes: 0 + contact_method: + id: PXPGF42 + type: email_contact_method_reference + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PXPGF42' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + tags: + - Users + x-pd-requires-scope: users.write + operationId: createUserHandoffNotificationRule + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users.write` + summary: Create a User Handoff Notification Rule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + type: object + properties: + oncall_handoff_notification_rule: + $ref: '#/components/schemas/HandoffNotificationRule' + required: + - oncall_handoff_notification_rule + examples: + request: + summary: Request Example + value: + oncall_handoff_notification_rule: + id: PXPGF43 + handoff_type: both + notify_advance_in_minutes: 180 + contact_method: + id: PXPGF42 + type: email_contact_method_reference + description: The Handoff Notification Rule to be created. + responses: + '201': + description: The Handoff Notification Rule that was created. + content: + application/json: + schema: + type: object + properties: + oncall_handoff_notification_rule: + $ref: '#/components/schemas/HandoffNotificationRule' + required: + - oncall_handoff_notification_rule + examples: + response: + summary: Response Example + value: + oncall_handoff_notification_rule: + id: PXPGF42 + handoff_type: both + notify_advance_in_minutes: 180 + contact_method: + id: PXPGF42 + type: email_contact_method_reference + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PXPGF42' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/users/{id}/oncall_handoff_notification_rules/{oncall_handoff_notification_rule_id}': + get: + tags: + - Users + x-pd-requires-scope: users.read + operationId: getUserHandoffNotifiactionRule + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users.read` + summary: Get a user's handoff notification rule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/oncall_handoff_notification_rule_id' + responses: + '200': + description: The user's handoff notification rule requested. + content: + application/json: + schema: + type: object + properties: + oncall_handoff_notification_rule: + $ref: '#/components/schemas/HandoffNotificationRule' + required: + - oncall_handoff_notification_rule + examples: + response: + summary: Response Example + value: + oncall_handoff_notification_rule: + id: PXPGF42 + handoff_type: both + notify_advance_in_minutes: 60 + contact_method: + id: PXPGF42 + type: email_contact_method_reference + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PXPGF42' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + delete: + tags: + - Users + x-pd-requires-scope: users.write + operationId: deleteUserHandoffNotificationRule + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users.write` + summary: Delete a User's Handoff Notification rule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/oncall_handoff_notification_rule_id' + responses: + '204': + description: The handoff notification rule was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + tags: + - Users + x-pd-requires-scope: users.write + operationId: updateUserHandoffNotification + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users.write` + summary: Update a User's Handoff Notification Rule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/oncall_handoff_notification_rule_id' + requestBody: + content: + application/json: + schema: + type: object + properties: + oncall_handoff_notification_rule: + $ref: '#/components/schemas/HandoffNotificationRule' + required: + - oncall_handoff_notification_rule + examples: + request: + summary: Request Example + value: + oncall_handoff_notification_rule: + id: PXPGF42 + handoff_type: both + notify_advance_in_minutes: 60 + contact_method: + id: PXPGF42 + type: email_contact_method_reference + description: The User's Handoff Notification Rule to be updated. + responses: + '200': + description: The User's Handoff Notification Rule that was updated. + content: + application/json: + schema: + type: object + properties: + oncall_handoff_notification_rule: + $ref: '#/components/schemas/HandoffNotificationRule' + examples: + response: + summary: Response Example + value: + oncall_handoff_notification_rule: + id: PXPGF42 + handoff_type: oncall + notify_advance_in_minutes: 30 + contact_method: + id: PXPGF42 + type: email_contact_method_reference + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PXPGF42' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/users/{id}/sessions': + get: + x-pd-requires-scope: 'users:sessions.read' + tags: + - Users + operationId: getUserSessions + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users:sessions.read` + summary: List a user's active sessions + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: A list of the user's active sessions. + content: + application/json: + schema: + type: object + properties: + user_sessions: + type: array + items: + $ref: '#/components/schemas/UserSession' + required: + - user_sessions + examples: + response: + summary: Response Example + value: + user_sessions: + - id: PXPGF42 + user_id: PXPGF42 + created_at: '2018-10-06T21:30:42Z' + summary: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.131 Safari/537.36' + type: browser + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + delete: + x-pd-requires-scope: 'users:sessions.write' + tags: + - Users + operationId: deleteUserSessions + description: | + Delete all user sessions. + + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users:sessions.write` + summary: Delete all user sessions + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '204': + description: The user sessions were all deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/users/{id}/sessions/{type}/{session_id}': + get: + x-pd-requires-scope: 'users:sessions.read' + tags: + - Users + operationId: getUserSession + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users:sessions.read` + summary: Get a user's session + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/type' + - $ref: '#/components/parameters/session_id' + responses: + '200': + description: The user's session requested. + content: + application/json: + schema: + type: object + properties: + user_session: + $ref: '#/components/schemas/UserSession' + required: + - user_session + examples: + response: + summary: Response Example + value: + user_session: + id: PXPGF42 + user_id: PXPGF42 + created_at: '2018-10-06T21:30:42Z' + summary: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.131 Safari/537.36' + type: browser + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + delete: + x-pd-requires-scope: 'users:sessions.write' + tags: + - Users + operationId: deleteUserSession + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users:sessions.write` + summary: Delete a user's session + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/type' + - $ref: '#/components/parameters/session_id' + responses: + '204': + description: The user session was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '/users/{id}/status_update_notification_rules': + get: + x-pd-requires-scope: users.read + tags: + - Users + operationId: getUserStatusUpdateNotificationRules + description: | + 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. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users.read` + summary: List a user's status update notification rules + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/early_access_status-update-notification-rules' + - $ref: '#/components/parameters/include_notification_rules' + responses: + '200': + description: A list of status update notification rules. + content: + application/json: + schema: + type: object + properties: + status_update_notification_rules: + type: array + items: + $ref: '#/components/schemas/StatusUpdateNotificationRule' + required: + - status_update_notification_rules + examples: + response: + summary: Response Example + value: + status_update_notification_rules: + - id: PXPGF42 + type: status_update_notification_rule + summary: contact method PXPGF42 used as status_update_notification_rule + self: 'https://api.pagerduty.com/users/PXPGF42/status_update_notification_rules/PPSCXAN' + contact_method: + id: PXPGF42 + type: email_contact_method_reference + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PXPGF42' + html_url: null + created_at: '2016-02-01T16:06:27-05:00' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + post: + x-pd-requires-scope: users.write + tags: + - Users + operationId: createUserStatusUpdateNotificationRule + description: | + 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. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users.write` + summary: Create a user status update notification rule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/early_access_status-update-notification-rules' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + properties: + status_update_notification_rule: + $ref: '#/components/schemas/StatusUpdateNotificationRule' + required: + - status_update_notification_rule + examples: + request: + summary: Request Example + value: + status_update_notification_rule: + contact_method: + id: PXPGF42 + type: email_contact_method_reference + description: The status update notification rule to be created. + responses: + '201': + description: The status update notification rule that was created. + content: + application/json: + schema: + type: object + properties: + status_update_notification_rule: + $ref: '#/components/schemas/StatusUpdateNotificationRule' + required: + - status_update_notification_rule + examples: + response: + summary: Response Example + value: + status_update_notification_rule: + id: PXPGF42 + type: status_update_notification_rule + summary: contact method PXPGF42 used as status_update_notification_rule + self: 'https://api.pagerduty.com/users/PXPGF42/status_update_notification_rules/PPSCXAN' + contact_method: + id: PXPGF42 + type: email_contact_method_reference + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PXPGF42' + html_url: null + created_at: '2016-02-01T16:06:27-05:00' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/users/{id}/status_update_notification_rules/{status_update_notification_rule_id}': + get: + x-pd-requires-scope: users.read + tags: + - Users + operationId: getUserStatusUpdateNotificationRule + description: | + 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. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users.read` + summary: Get a user's status update notification rule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/early_access_status-update-notification-rules' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/user_status_update_notification_rule_id' + - $ref: '#/components/parameters/include_notification_rules' + responses: + '200': + description: The user's status update notification rule requested. + content: + application/json: + schema: + type: object + properties: + notification_rule: + $ref: '#/components/schemas/StatusUpdateNotificationRule' + required: + - notification_rule + examples: + response: + summary: Response Example + value: + notification_rule: + id: PXPGF42 + type: status_update_notification_rule + summary: contact method PXPGF42 used as status_update_notification_rule + self: 'https://api.pagerduty.com/users/PXPGF42/status_update_notification_rules/PPSCXAN' + contact_method: + id: PTDVERC + type: email_contact_method_reference + summary: Default + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PTDVERC' + html_url: null + created_at: '2016-02-01T16:06:27-05:00' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + delete: + x-pd-requires-scope: users.write + tags: + - Users + operationId: deleteUserStatusUpdateNotificationRule + description: | + 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. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users.write` + summary: Delete a user's status update notification rule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/early_access_status-update-notification-rules' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/user_status_update_notification_rule_id' + responses: + '204': + description: The status update notification rule was deleted successfully. + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + put: + x-pd-requires-scope: users.write + tags: + - Users + operationId: updateUserStatusUpdateNotificationRule + description: | + 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. + + + > ### Early Access + > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + + For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + + Scoped OAuth requires: `users.write` + summary: Update a user's status update notification rule + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/early_access_status-update-notification-rules' + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/user_status_update_notification_rule_id' + requestBody: + content: + application/json: + schema: + type: object + properties: + status_update_notification_rule: + $ref: '#/components/schemas/StatusUpdateNotificationRule' + required: + - status_update_notification_rule + examples: + request: + summary: Request Example + value: + status_update_notification_rule: + contact_method: + id: PXPGF42 + type: email_contact_method_reference + description: The user's status update notification rule to be updated. + responses: + '200': + description: The user's status update notification rule that was updated. + content: + application/json: + schema: + type: object + properties: + notification_rule: + $ref: '#/components/schemas/StatusUpdateNotificationRule' + examples: + response: + summary: Response Example + value: + status_update_notification_rule: + id: PXPGF42 + type: status_update_notification_rule + summary: contact method PXPGF42 used as status_update_notification_rule + self: 'https://api.pagerduty.com/users/PXPGF42/status_update_notification_rules/PPSCXAN' + contact_method: + id: PXPGF42 + type: email_contact_method_reference + summary: Work + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PXPGF42' + html_url: null + created_at: '2016-02-01T16:06:27-05:00' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/PaymentRequired' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + /users/me: + get: + tags: + - Users + operationId: getCurrentUser + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users) + summary: Get the current user + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/include_user' + responses: + '200': + description: The requesting user. + content: + application/json: + schema: + type: object + properties: + user: + $ref: '#/components/schemas/User' + required: + - user + examples: + response: + summary: Response Example + value: + user: + id: PXPGF42 + type: user + summary: Earline Greenholt + self: 'https://api.pagerduty.com/users/PXPGF42' + html_url: 'https://subdomain.pagerduty.com/users/PXPGF42' + name: Earline Greenholt + email: 125.greenholt.earline@graham.name + time_zone: America/Lima + color: green + role: admin + avatar_url: 'https://secure.gravatar.com/avatar/a8b714a39626f2444ee05990b078995f.png?d=mm&r=PG' + description: null + invitation_sent: false + job_title: Director of Engineering + contact_methods: + - id: PTDVERC + type: email_contact_method_reference + summary: Default + self: 'https://api.pagerduty.com/users/PXPGF42/contact_methods/PTDVERC' + html_url: null + notification_rules: + - id: P8GRWKK + type: assignment_notification_rule_reference + summary: Default + self: 'https://api.pagerduty.com/users/PXPGF42/notification_rules/PTDVERC' + html_url: null + teams: + - id: PQ9K7I8 + type: team_reference + summary: Engineering + self: 'https://api.pagerduty.com/teams/PQ9K7I8' + html_url: 'https://subdomain.pagerduty.com/teams/PQ9K7I8' + '400': + $ref: '#/components/responses/ArgumentError' + '429': + $ref: '#/components/responses/TooManyRequests' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/vendors.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/vendors.yaml new file mode 100644 index 0000000..dd76974 --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/vendors.yaml @@ -0,0 +1,2747 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + Vendor: + allOf: + - $ref: '#/components/schemas/Tag/allOf/0' + - type: object + properties: + name: + type: string + readOnly: true + description: The short name of the vendor + website_url: + type: string + format: url + readOnly: true + description: URL of the vendor's main website + logo_url: + type: string + format: url + readOnly: true + description: URL of a logo identifying the vendor + thumbnail_url: + type: string + format: url + readOnly: true + description: URL of a small thumbnail image identifying the vendor + description: + type: string + readOnly: true + description: 'A short description of this vendor, and common use-cases of integrations for this vendor.' + integration_guide_url: + type: string + format: url + readOnly: true + description: URL of an integration guide for this vendor + example: + type: vendor + name: Amazon CloudWatch + website_url: 'https://aws.amazon.com/cloudwatch' + logo_url: 'https://s3.amazonaws.com/pdpartner/cloudwatch_large.png' + thumbnail_url: 'https://s3.amazonaws.com/pdpartner/cloudwatch_thumb.png' + description: 'Amazon Web Services CloudWatch provides monitoring for AWS cloud resources and customer-run applications. AWS can collect data, gain insight, and alert users to fix problems within applications and organizations. AWS CloudWatch gives system-wide visibility into resource utilization and notifications can be set for when any metrics cross a specified threshold.' + integration_guide_url: 'http://www.pagerduty.com/docs/guides/aws-cloudwatch-integration-guide/' + Tag: + allOf: + - type: object + properties: + id: + type: string + readOnly: true + summary: + type: string + nullable: true + readOnly: true + description: 'A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.' + type: + type: string + readOnly: true + description: 'A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.' + self: + type: string + nullable: true + readOnly: true + format: url + description: the API show URL at which the object is accessible + html_url: + type: string + nullable: true + readOnly: true + format: url + description: a URL at which the entity is uniquely displayed in the Web app + - type: object + properties: + type: + type: string + description: The type of object being created. + default: tag + enum: + - tag + label: + type: string + description: The label of the tag. + maxLength: 191 + required: + - label + - type + example: + type: tag + label: Batman + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + ArgumentError: + description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Unauthorized: + description: | + Caller did not supply credentials or did not provide the correct credentials. + If you are using an API key, it may be invalid or your Authorization header may be malformed. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Forbidden: + description: | + Caller is not authorized to view the requested resource. + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + TooManyRequests: + description: 'Too many requests have been made, the rate limit has been reached.' + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + Conflict: + description: The request conflicts with the current state of the server. + content: + application/json: + schema: + type: object + properties: + error: + type: object + properties: + code: + type: integer + readOnly: true + message: + type: string + readOnly: true + description: Error message string + errors: + type: array + readOnly: true + items: + type: string + readOnly: true + description: Human-readable error details + example: + message: Not Found + code: 2100 + NotFound: + description: The requested resource was not found. + content: + application/json: + schema: + $ref: '#/components/responses/Conflict/content/application~1json/schema' + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + vendors: + id: pagerduty.vendors.vendors + name: vendors + title: Vendors + methods: + list_vendors: + operation: + $ref: '#/paths/~1vendors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.vendors + _list_vendors: + operation: + $ref: '#/paths/~1vendors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_vendor: + operation: + $ref: '#/paths/~1vendors~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.vendor + _get_vendor: + operation: + $ref: '#/paths/~1vendors~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vendors/methods/get_vendor' + - $ref: '#/components/x-stackQL-resources/vendors/methods/list_vendors' + insert: [] + update: [] + delete: [] +paths: + /vendors: + get: + x-pd-requires-scope: vendors.read + tags: + - Vendors + operationId: listVendors + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#vendors) + + Scoped OAuth requires: `vendors.read` + summary: List vendors + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + responses: + '200': + description: A paginated array of vendors. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Pagination' + - type: object + properties: + vendors: + type: array + items: + $ref: '#/components/schemas/Vendor' + required: + - vendors + examples: + response: + summary: Response Example + value: + vendors: + - id: PZQ6AUS + type: vendor + summary: Amazon CloudWatch + self: 'https://api.pagerduty.com/vendors/PZQ6AUS' + name: Amazon CloudWatch + website_url: 'https://aws.amazon.com/cloudwatch' + logo_url: 'https://s3.amazonaws.com/pdpartner/cloudwatch_large.png' + thumbnail_url: 'https://s3.amazonaws.com/pdpartner/cloudwatch_thumb.png' + description: 'Amazon Web Services CloudWatch provides monitoring for AWS cloud resources and customer-run applications. AWS can collect data, gain insight, and alert users to fix problems within applications and organizations. AWS CloudWatch gives system-wide visibility into resource utilization and notifications can be set for when any metrics cross a specified threshold.' + integration_guide_url: 'http://www.pagerduty.com/docs/guides/aws-cloudwatch-integration-guide/' + limit: 25 + offset: 0 + more: false + total: null + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/TooManyRequests' + '/vendors/{id}': + get: + x-pd-requires-scope: vendors.read + tags: + - Vendors + operationId: getVendor + description: | + 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#vendors) + + Scoped OAuth requires: `vendors.read` + summary: Get a vendor + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + responses: + '200': + description: The vendor requested + content: + application/json: + schema: + type: object + properties: + vendor: + type: array + items: + $ref: '#/components/schemas/Vendor' + required: + - vendor + examples: + response: + summary: Response Example + value: + vendor: + - id: PZQ6AUS + type: vendor + summary: Amazon CloudWatch + self: 'https://api.pagerduty.com/vendors/PZQ6AUS' + name: Amazon CloudWatch + website_url: 'https://aws.amazon.com/cloudwatch' + logo_url: 'https://s3.amazonaws.com/pdpartner/cloudwatch_large.png' + thumbnail_url: 'https://s3.amazonaws.com/pdpartner/cloudwatch_thumb.png' + description: 'Amazon Web Services CloudWatch provides monitoring for AWS cloud resources and customer-run applications. AWS can collect data, gain insight, and alert users to fix problems within applications and organizations. AWS CloudWatch gives system-wide visibility into resource utilization and notifications can be set for when any metrics cross a specified threshold.' + integration_guide_url: 'http://www.pagerduty.com/docs/guides/aws-cloudwatch-integration-guide/' + '400': + $ref: '#/components/responses/ArgumentError' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '429': + $ref: '#/components/responses/TooManyRequests' diff --git a/provider-dev/openapi/src/pagerduty/v00.00.00000/services/webhooks.yaml b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/webhooks.yaml new file mode 100644 index 0000000..815787b --- /dev/null +++ b/provider-dev/openapi/src/pagerduty/v00.00.00000/services/webhooks.yaml @@ -0,0 +1,2885 @@ +openapi: 3.0.2 +servers: + - url: 'https://api.pagerduty.com' + description: PagerDuty V2 API. +info: + contact: + name: PagerDuty Support + url: 'http://www.pagerduty.com/support' + email: support@pagerduty.com + version: 2.0.0 + title: PagerDuty API - webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. +security: + - api_key: [] +tags: + - name: Abilities + description: | + This describes your account's abilities by feature name. For example `"teams"`. + An ability may be available to your account based on things like your pricing plan or account state. + - name: Add-ons + description: | + Developers can write their own functionality to insert into PagerDuty's UI. + - name: Analytics + description: | + Provides enriched incident data. + - name: Apps + description: '' + - name: Audit + description: | + Provides audit record data. + - name: Automation Actions + description: | + Automation Actions invoke jobs that are staged in Runbook Automation or Process Automation. + - name: Paused Incident Reports + description: | + Provides paused Incident reporting data on services and accounts that have paused Alerts. + - name: Business Services + description: | + Business services model capabilities that span multiple technical services and that may be owned by several different teams. + - name: Custom Fields + description: | + Custom fields allow you to enrich PagerDuty incidents with critical and helpful metadata throughout the incident lifecycle. + - name: Change Events + description: | + Change Events enable 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. + - name: Escalation Policies + description: | + Escalation policies define which user should be alerted at which time. + - name: Event Orchestrations + description: | + Event Orchestrations allow you to route events to an endpoint and create collections of Event Orchestrations, which define sets of actions to take based on event content. + - name: Extension Schemas + description: | + A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. + - name: Extensions + description: | + Extensions are representations of Extension Schema objects that are attached to Services. + - name: Incidents + description: | + An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service's escalation policy. + - name: Incident Workflows + description: | + An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. + - name: Licenses + description: | + Licenses are allocated to Users to allow for per-User access to PagerDuty functionality within an Account. + - name: Log Entries + description: | + A log of all the events that happen to an Incident, and these are exposed as Log Entries. + - name: Maintenance Windows + description: | + A Maintenance Window is used to temporarily disable one or more Services for a set period of time. + - name: Notifications + description: | + A Notification is created when an Incident is triggered or escalated. + - name: On-Calls + description: | + 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 + - name: Priorities + description: | + A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans. + - name: Response Plays + description: | + Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. + - name: Rulesets + description: | + 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. + - name: Schedules + description: | + A Schedule determines the time periods that users are On-Call. + - name: Service Dependencies + description: | + Services are categorized into technical and business services. Dependencies can be created via any combination of these services. + - name: Services + description: | + A Service may represent an application, component, or team you wish to open incidents against. + - name: Webhooks + description: | + A webhook is a way to receive events that occur on the PagerDuty platform via an HTTP POST request. + V3 webhooks are set up by creating a webhook subscription. + - name: Status Dashboards + description: | + Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services rather than the whole set of top-level Business Services (those with no dependent Services). + - name: Tags + description: | + A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. + - name: Teams + description: | + A team is a collection of Users and Escalation Policies that represent a group of people within an organization. + - name: Templates + description: | + Templates is a new feature which will allow customers to create message templates to be leveraged by (but not limited to) status updates. The API will be secured to customers with the status updates entitlements. + - name: Users + description: | + Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. + - name: Vendors + description: | + A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors +components: + schemas: + WebhookSubscription: + type: object + properties: + id: + type: string + readOnly: true + type: + type: string + description: The type indicating the schema of the object. + default: webhook_subscription + enum: + - webhook_subscription + active: + type: boolean + default: true + description: Determines whether this subscription will produce webhook events. + delivery_method: + type: object + properties: + id: + type: string + readOnly: true + secret: + type: string + description: The secret used to sign webhook payloads. Only provided on the initial create response. + nullable: true + readOnly: true + temporarily_disabled: + type: boolean + description: Whether or not this webhook subscription is temporarily disabled. Becomes `true` if the delivery method URL is repeatedly rejected by the server. + type: + type: string + description: Indicates the type of the delivery method. + default: http_delivery_method + enum: + - http_delivery_method + url: + type: string + description: The destination URL for webhook delivery. + format: url + custom_headers: + type: array + description: 'Optional headers to be set on this webhook subscription when sent. The header values are redacted in GET requests, but are not redacted on the webhook when delivered to the webhook''s endpoint.' + required: + - type + - url + description: + type: string + description: A short description of the webhook subscription. + events: + type: array + description: The set of outbound event types the webhook will receive. + minItems: 1 + uniqueItems: true + items: + type: string + filter: + type: object + properties: + id: + type: string + description: The id of the object being used as the filter. This field is required for all filter types except account_reference. + type: + type: string + description: The type of object being used as the filter. + enum: + - account_reference + - service_reference + - team_reference + required: + - type + required: + - type + - delivery_method + - events + - filter + Pagination: + type: object + properties: + offset: + type: integer + description: Echoes offset pagination property. + readOnly: true + limit: + type: integer + description: Echoes limit pagination property. + readOnly: true + more: + type: boolean + description: Indicates if there are additional records to return + readOnly: true + total: + type: integer + description: The total number of records matching the given query. + nullable: true + readOnly: true + AutomationActionsActionClassificationEnum: + type: string + enum: + - diagnostic + - remediation + nullable: true + WebhookSubscriptionUpdate: + type: object + properties: + webhook_subscription: + type: object + properties: + description: + type: string + description: A short description of the webhook subscription. + events: + type: array + description: The set of outbound event types the subscription will receive. + minItems: 1 + uniqueItems: true + items: + type: string + filter: + type: object + properties: + id: + type: string + description: The id of the object being used as the filter. This field is required for all filter types except account_reference. + type: + type: string + description: The type of object being used as the filter. + enum: + - account_reference + - service_reference + - team_reference + active: + type: boolean + description: 'If true, a webhook will be sent. True is the default state. If false, a webhook will not be sent.' + parameters: + header_Accept: + name: Accept + description: The `Accept` header is used as a versioning header. + in: header + required: false + schema: + type: string + default: application/vnd.pagerduty+json;version=2 + header_Content-Type: + name: Content-Type + in: header + required: false + schema: + type: string + default: application/json + enum: + - application/json + audit_since: + name: since + in: query + description: 'The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)' + schema: + type: string + format: date-time + audit_until: + name: until + in: query + description: 'The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.' + schema: + type: string + format: date-time + audit_root_resource_types: + name: 'root_resource_types[]' + in: query + description: Resource type filter for the root_resource. + schema: + type: string + enum: + - users + - teams + - schedules + - escalation_policies + - services + example: users + audit_actor_type: + name: actor_type + in: query + description: Actor type filter. + schema: + type: string + example: user_reference + audit_actor_id: + name: actor_id + in: query + description: Actor Id filter. Must be qualified by providing the `actor_type` param. + schema: + type: string + example: P123456 + audit_method_type: + name: method_type + in: query + description: Method type filter. + schema: + type: string + description: | + Describes the method used to perform the action: + + `browser` -- authenticated user session. Session value is not returned in the `truncated_token` field. + + `oauth` -- access token obtained via the OAuth flow. Truncated token value is returned in the `truncated_token` field. + + `api_token` -- Pagerduty API token. Truncated token value is returned in the `truncated_token` field. + + `identity_provider` -- action performed by an Identity provider on behalf of a user. No value is returned in the `truncated_token` field. + + `other` -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the `truncated_token` field. + enum: + - browser + - oauth + - api_token + - identity_provider + - other + audit_method_truncated_token: + name: method_truncated_token + in: query + description: Method truncated_token filter. Must be qualified by providing the `method_type` param. + schema: + type: string + example: 3xyz + audit_actions: + name: 'actions[]' + in: query + description: Action filter + schema: + type: string + description: | + The action executed on the aggregate + enum: + - create + - update + - delete + offset_limit: + name: limit + in: query + required: false + description: The number of results per page. + schema: + type: integer + offset_offset: + name: offset + in: query + required: false + description: Offset to start pagination search results. + schema: + type: integer + offset_total: + name: total + in: query + required: false + description: | + By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. + + See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. + schema: + default: false + type: boolean + automation_actions_name: + name: name + description: Filters results to include the ones matching the name (case insensitive substring matching) + in: query + required: false + schema: + type: string + nullable: false + automation_actions_runners_include: + name: 'include[]' + in: query + required: false + description: Includes additional data elements into the response + explode: true + schema: + type: array + items: + type: string + enum: + - associated_actions + example: associated_actions + uniqueItems: true + automation_actions_runner_id: + name: runner_id + description: | + Filters results to include the ones linked to the specified runner. + Specifying the value `any` filters results to include the ones linked to runners only, + thus omitting the results not linked to runners. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_classification: + name: classification + description: Filters results to include the ones matching the specified classification (aka category) + in: query + required: false + schema: + $ref: '#/components/schemas/AutomationActionsActionClassificationEnum' + automation_actions_action_type: + name: action_type + description: Filters results to include the ones matching the specified action type + in: query + required: false + schema: + type: string + enum: + - script + - process_automation + example: process_automation + automation_actions_team_id: + name: team_id + description: Filters results to include the ones associated with the specified team. + in: query + required: false + schema: + type: string + nullable: false + automation_actions_service_id: + name: service_id + description: Filters results to include the ones associated with the specified service + in: query + required: false + schema: + type: string + nullable: false + automation_actions_invocation_state: + name: invocation_state + description: Invocation state + in: query + schema: + type: string + description: 'prepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner' + enum: + - prepared + - created + - sent + - queued + - running + - aborted + - completed + - error + example: sent + automation_actions_incident_id: + name: incident_id + description: Incident ID + in: query + required: true + schema: + type: string + example: Q2LAR4ADCXC8IB + past_incidents_limit: + name: limit + in: query + required: false + description: The number of results to be returned in the response. + schema: + type: integer + default: 5 + minimum: 1 + maximum: 999 + past_incidents_total: + name: total + in: query + required: false + description: | + By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. + schema: + type: boolean + default: false + cursor_limit: + name: limit + in: query + required: false + description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. + schema: + type: integer + cursor_cursor: + name: cursor + in: query + required: false + description: | + Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set. + schema: + type: string + early_access_analytics: + schema: + type: string + default: analytics-v2 + enum: + - analytics-v2 + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + name: X-EARLY-ACCESS + required: true + early_access_status-update-notification-rules: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: status-update-notification-rules + enum: + - status-update-notification-rules + early_access_bis: + schema: + type: string + default: business-impact-early-access + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!' + required: true + early_access_status_dashboards: + schema: + type: string + default: status-dashboards + in: header + name: X-EARLY-ACCESS + description: 'This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!' + required: true + webhooks_filter_type: + name: filter_type + in: query + required: false + description: The type of resource to filter upon. + schema: + enum: + - service + - team + type: string + webhooks_filter_id: + name: filter_id + in: query + required: false + description: The id of the resource to filter upon. + schema: + type: string + id: + name: id + description: The ID of the resource. + in: path + required: true + schema: + type: string + ids: + name: 'ids[]' + description: The IDs of the resources. + in: query + explode: true + schema: + type: string + entity_type: + name: entity_type + in: path + description: Type of entity related with the tag + required: true + schema: + type: string + enum: + - users + - teams + - escalation_policies + business_service_id: + name: business_service_id + in: path + description: The business service ID. + required: true + schema: + type: string + team_id: + name: team_id + in: path + description: The team ID + required: true + schema: + type: string + team_user_id: + name: user_id + in: path + description: The user ID on the team. + required: true + schema: + type: string + team_escalation_policy_id: + name: escalation_policy_id + in: path + description: The escalation policy ID on the team. + required: true + schema: + type: string + escalation_policy_escalation_rule_id: + name: escalation_rule_id + in: path + description: The escalation rule ID on the escalation policy. + required: true + schema: + type: string + impacts_additional_fields: + name: 'additional_fields[]' + in: query + description: Provides access to additional fields such as highest priority per business service and total impacted count + explode: true + schema: + type: string + enum: + - services.highest_impacting_priority + - total_impacted_count + include_addon: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + uniqueItems: true + include_escalation_policy: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - services + - teams + - targets + uniqueItems: true + include_log_entry: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - incidents + - services + - channels + - teams + uniqueItems: true + include_user: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - contact_methods + - notification_rules + - teams + - subdomains + uniqueItems: true + include_maintenance_window: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - teams + - services + - users + uniqueItems: true + include_teams: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - privileges + uniqueItems: true + include_teams_members: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_triggers: + name: 'include[]' + in: query + description: Array of additional Models to include in response. + explode: true + schema: + type: string + enum: + - triggers + uniqueItems: true + sort_by_escalation_policy: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + sort_by_service: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + default: name + schedule_overflow: + name: overflow + in: query + description: | + Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. + For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: + + + - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. + - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + schema: + type: boolean + default: false + schedule_override_id: + name: override_id + in: path + description: The override ID on the schedule. + required: true + schema: + type: string + team_ids: + name: 'team_ids[]' + in: query + description: An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + time_zone: + name: time_zone + in: query + description: Time zone in which dates in the result will be rendered. + schema: + type: string + format: tzinfo + default: UTC + service_id: + name: service_id + in: path + description: The service ID + required: true + schema: + type: string + services: + name: 'service_ids[]' + in: query + description: An array of service IDs. Only results related to these services will be returned. + explode: true + schema: + type: array + items: + type: string + integration_id: + name: integration_id + in: path + description: The integration ID on the service. + required: true + schema: + type: string + integration_ids: + name: 'integration_ids[]' + in: query + description: An array of integration IDs. Only results related to these integrations will be returned. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + log_entry_is_overview: + name: is_overview + in: query + description: 'If `true`, will return a subset of log entries that show only the most important changes to the incident.' + required: false + schema: + type: boolean + default: false + since: + name: since + in: query + description: The start of the date range over which you want to search. + schema: + type: string + format: date-time + until: + name: until + in: query + description: The end of the date range over which you want to search. + schema: + type: string + format: date-time + url_slug: + name: url_slug + in: path + description: The `url_slug` for a status dashboard + required: true + schema: + type: string + date_range: + name: date_range + in: query + description: 'When set to all, the since and until parameters and defaults are ignored.' + schema: + type: string + enum: + - all + incident_key: + name: incident_key + in: query + description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. + schema: + type: string + incident_services: + name: 'service_ids[]' + in: query + description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_assigned_to_user: + name: 'user_ids[]' + in: query + description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + incident_urgencies: + name: 'urgencies[]' + in: query + description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. + explode: true + schema: + type: string + enum: + - high + - low + uniqueItems: true + from_header: + name: From + in: header + description: The email address of a valid user associated with the account making the request. + required: true + schema: + type: string + format: email + optional_from_header: + name: From + in: header + description: 'The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.' + required: false + schema: + type: string + format: email + user_contact_method_id: + name: contact_method_id + in: path + description: The contact method ID on the user. + required: true + schema: + type: string + user_notification_rule_id: + name: notification_rule_id + in: path + description: The notification rule ID on the user. + required: true + schema: + type: string + user_status_update_notification_rule_id: + name: status_update_notification_rule_id + in: path + description: The status update notification rule ID on the user. + required: true + schema: + type: string + oncall_handoff_notification_rule_id: + name: oncall_handoff_notification_rule_id + in: path + description: The oncall handoff notification rule ID on the user. + required: true + schema: + type: string + session_id: + name: session_id + in: path + description: The session ID for the user. + required: true + schema: + type: string + type: + name: type + in: path + description: The session type for the user session ID. + required: true + schema: + type: string + alert_key: + name: alert_key + in: query + description: Alert de-duplication key. + schema: + type: string + response_play_id: + name: response_play_id + in: path + description: The response play ID of the response play associated with the request. + required: true + schema: + type: string + query: + name: query + in: query + description: 'Filters the result, showing only the records whose name matches the query.' + required: false + schema: + type: string + tag_query: + name: query + in: query + description: 'Filters the result, showing only the tags whose label matches the query.' + required: false + schema: + type: string + addon_services: + name: 'service_ids[]' + in: query + description: 'Filters the results, showing only Add-ons for the given services' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + addon_filter: + name: filter + in: query + description: 'Filters the results, showing only Add-ons of the given type' + schema: + type: string + enum: + - full_page_addon + - incident_show_addon + change_since: + name: since + in: query + description: 'The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + change_until: + name: until + in: query + description: 'The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.' + schema: + type: string + format: date-time + pattern: 'YYYY-MM-DDThh:mm:ssZ' + user_ids_escalation_policies: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only escalation policies on which any of the users is a target.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + extension_object_id: + name: extension_object_id + description: The id of the extension object you want to filter by. + in: query + schema: + type: string + extension_schema_id: + name: extension_schema_id + in: query + description: Filter the extensions by extension vendor id. + schema: + type: string + include_extensions: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_objects + - extension_schemas + uniqueItems: true + include_extensions_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - extension_schemas + - extension_objects + - temporarily_disabled + uniqueItems: true + include_incident_workflow_children: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - steps + - team + uniqueItems: true + statuses_incidents: + name: 'statuses[]' + in: query + description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + uniqueItems: true + sort_by_incidents: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.' + style: form + explode: false + schema: + type: array + items: + type: string + maxItems: 2 + uniqueItems: true + include_incidents: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + - services + - first_trigger_log_entries + - escalation_policies + - teams + - assignees + - acknowledgers + - priorities + - conference_bridge + uniqueItems: true + include_incident: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - field_values + uniqueItems: true + since_incidents: + schema: + type: string + in: query + name: since + description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + until_incidents: + schema: + type: string + in: query + name: until + description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. + statuses_incident_alerts: + name: 'statuses[]' + in: query + description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) + explode: true + schema: + type: string + enum: + - triggered + - resolved + uniqueItems: true + sort_by_incident_alerts: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - created_at + - resolved_at + - 'created_at:asc' + - 'created_at:desc' + - 'resolved_at:asc' + - 'resolved_at:desc' + maxItems: 2 + uniqueItems: true + include_incident_alerts: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - first_trigger_log_entries + - incidents + uniqueItems: true + alert_id: + name: alert_id + in: path + description: The id of the alert to retrieve. + required: true + schema: + type: string + statuses_incident_count: + name: 'statuses[]' + in: query + description: 'Count only incidents with the requested statuses. `all` returns all statuses. If `any` is specified, there will be an additional `any` boolean field in the response that is true if there are any incidents matching the criteria in the request. If no statuses are provided, then only the total count of incidents is returned regardless of status. More status codes may be introduced in the future.' + explode: true + schema: + type: string + enum: + - triggered + - acknowledged + - resolved + - any + - all + uniqueItems: true + filter_maintenance_windows: + name: filter + in: query + description: Only return maintenance windows in a given state. + schema: + type: string + enum: + - past + - future + - ongoing + - open + - all + since_notifications: + name: since + in: query + description: The start of the date range over which you want to search. The time element is optional. + required: true + schema: + type: string + format: date-time + until_notifications: + name: until + in: query + description: The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. + required: true + schema: + type: string + format: date-time + filter_notifications: + name: filter + in: query + description: Return notification of this type only. + schema: + type: string + enum: + - sms_notification + - email_notification + - phone_notification + - push_notification + include_notifications: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - users + uniqueItems: true + include_oncalls: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - users + - schedules + uniqueItems: true + user_ids_oncalls: + name: 'user_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified user IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + escalation_policy_ids_oncalls: + name: 'escalation_policy_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified escalation policy IDs.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + schedule_ids_oncalls: + name: 'schedule_ids[]' + in: query + description: 'Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.' + explode: true + schema: + type: array + items: + type: string + uniqueItems: true + since_oncalls: + name: since + in: query + description: 'The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.' + schema: + type: string + format: date-time + until_oncalls: + name: until + in: query + description: 'The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.' + schema: + type: string + format: date-time + earliest_oncalls: + name: earliest + in: query + description: 'This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.' + schema: + type: boolean + filter_for_manual_run: + name: filter_for_manual_run + in: query + description: 'When this parameter is present, only those Response Plays that can be run manually will be returned.' + schema: + type: boolean + rule_id: + name: rule_id + in: path + description: The id of the Event Rule to retrieve. + required: true + schema: + type: string + since_schedules: + name: since + in: query + description: The start of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + until_schedules: + name: until + in: query + description: The end of the date range over which you want to search. + required: true + schema: + type: string + format: date-time + editable_schedules: + name: editable + in: query + description: 'When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.' + schema: + type: boolean + overflow_schedules: + name: overflow + in: query + description: 'Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.' + schema: + type: boolean + include_services: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - integrations + - auto_pause_notifications_parameters + uniqueItems: true + include_services_id: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - escalation_policies + - teams + - auto_pause_notifications_parameters + - integrations + uniqueItems: true + include_services_integrations: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - services + - vendors + uniqueItems: true + reassignment_team: + name: reassignment_team + in: query + description: | + Team to reassign unresolved incident to. + If an unresolved incident exists on both the reassignment team and + the team being deleted, a duplicate will not be made. If not supplied, + unresolved incidents will be made account-level. + required: false + schema: + type: string + include_notification_rules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - contact_methods + uniqueItems: true + additional_details: + name: 'additional_details[]' + in: query + description: Array of additional attributes to any of the returned incidents for related incidents. + explode: true + schema: + type: string + enum: + - incident + uniqueItems: true + include_schedules: + name: 'include[]' + in: query + description: Array of additional details to include. + explode: true + schema: + type: string + enum: + - schedule_layers + uniqueItems: true + sort_by_event_orchestration: + name: sort_by + in: query + description: Used to specify the field you wish to sort the results on. + schema: + type: string + enum: + - 'name:asc' + - 'name:desc' + - 'routes:asc' + - 'routes:desc' + - 'created_at:asc' + - 'created_at:desc' + default: 'name:asc' + event_orchestration_id: + name: id + description: The ID of an Event Orchestration. + in: path + required: true + schema: + type: string + event_orchestration_integration_id: + name: integration_id + description: The ID of an Integration. + in: path + required: true + schema: + type: string + urgency: + name: urgency + in: query + description: 'The incident urgency for which the notification rules are applied. If not specified, defaults to `high`.' + explode: true + schema: + type: string + enum: + - high + - low + - all + uniqueItems: true + template_query: + name: query + description: Template name or description to search + in: query + schema: + type: string + template_type: + name: template_type + description: Filters templates by type. + in: query + schema: + type: string + default: status_update + sort_by_template: + name: sort_by + in: query + description: 'Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.' + style: form + explode: false + schema: + type: string + enum: + - name + - 'name:asc' + - 'name:desc' + - created_at + - 'created_at:asc' + - 'created_at:desc' + default: 'created_at:asc' + schedule_since: + name: since + in: query + description: The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. + schema: + type: string + format: date-time + schedule_until: + name: until + in: query + description: The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. + schema: + type: string + format: date-time + paused_incident_reports_service_id: + name: service_id + in: query + description: Specifies a filter to limit the scope of reporting to a particular service + schema: + type: string + example: P123456 + paused_incident_reports_suspended_by: + name: suspended_by + in: query + description: Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. + schema: + enum: + - auto_pause + - rules + triggers_filter_workflow_id: + name: workflow_id + description: 'If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_incident_id: + name: incident_id + description: 'If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.' + in: query + schema: + type: string + example: Q2LAR4ADCXC8IB + triggers_filter_service_id: + name: service_id + description: 'If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.' + in: query + schema: + type: string + example: P4RG7YW + triggers_filter_trigger_type: + name: trigger_type + description: 'If provided, only show triggers of the given type. For example “manual” to search for manual triggers' + in: query + schema: + type: string + enum: + - manual + - conditional + triggers_path_trigger_id: + name: trigger_id + description: Identifier for the Trigger + required: true + in: path + schema: + type: string + triggers_path_service_id: + name: service_id + description: Identifier for the Service + required: true + in: path + schema: + type: string + triggers_sort_by: + name: sort_by + description: 'If provided, returns triggers sorted by the specified property.' + in: query + schema: + type: string + enum: + - workflow_id + - workflow_id asc + - workflow_id desc + - workflow_name + - workflow_name asc + - workflow_name desc + actions_filter_keyword: + name: keyword + description: 'If provided, only show actions tagged with the specified keyword' + in: query + schema: + type: string + example: slack + include_customfields_field: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + include_customfields_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_configurations` will also include full field details. + in: query + explode: true + schema: + type: string + enum: + - field_configurations + uniqueItems: true + include_customfields_field_configuration: + name: 'include[]' + description: Array of additional details to include. + in: query + explode: true + schema: + type: string + enum: + - fields + uniqueItems: true + include_customfields_incident_schema: + name: 'include[]' + description: Array of additional details to include. Including `field_options` will also include field options. + in: query + explode: true + schema: + type: string + enum: + - field_options + uniqueItems: true + field_id: + name: field_id + description: The ID of the field. + in: path + required: true + schema: + type: string + field_option_id: + name: field_option_id + description: The ID of the field option. + in: path + required: true + schema: + type: string + schema_id: + name: schema_id + description: The ID of the schema. + in: path + required: true + schema: + type: string + field_configuration_id: + name: field_configuration_id + description: The ID of the field configuration. + in: path + required: true + schema: + type: string + customfields_query_schema_assignments_filter: + name: filter + description: One of service_id or schema_id is required. + in: query + required: true + explode: true + schema: + type: object + properties: + service_id: + type: string + schema_id: + type: string + minProperties: 1 + maxProperties: 1 + early_access_customfields: + name: X-EARLY-ACCESS + in: header + description: | + This header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change! + required: true + schema: + type: string + default: flex-service-early-access + enum: + - flex-service-early-access + responses: + WebhookBadRequest: + description: | + Caller provided invalid arguments. Please review the response for error + details. Retrying with the same arguments will *not* work. + WebhookUnauthorized: + description: | + Caller did not supply credentials or did not provide the correct + credentials. + + If you are using an API key, it may be invalid or your Authorization header may be malformed. + WebhookForbidden: + description: | + Caller is not authorized to view the requested resource. + + While your authentication is valid, the authenticated user or token does not have permission to perform this action. + WebhookNotFound: + description: The requested resource was not found. + securitySchemes: + api_key: + type: apiKey + name: Authorization + in: header + description: The API Key with format `Token token=` + examples: + AuditRecordResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_TEAM_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + action: create + details: + resource: + id: PXASDFE + type: team_reference + summary: my DevOps team + fields: + - name: teamName + value: DevOps team + - id: PDRECORDID2_USER_REMOVED_FROM_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PRY9M8B + type: team_reference + summary: DevOps + references: + - name: members + removed: + - id: PRY9M8B + type: user_reference + summary: John Doe + - id: PDRECORDID5_USERS_TEAM_ROLE_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PRY9M8B + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: team_role + before_value: observer + value: manager + - id: PDRECORDID3_USERS_NAME_AND_EMAIL_UPDATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: identity_provider + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PDUSER + type: user_reference + summary: John Snow + fields: + - name: name + before_value: Bob Doe + value: Jon Snow + - name: email + before_value: bob.doe@domain.com + value: john.snow@domain.com + - id: PDRECORDID4_UPDATED_USERS_NOTIFICATION_RULE + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 2adm + root_resource: + id: PDUSER + type: user_reference + summary: John Snow + action: update + details: + resource: + id: PXOGWUS + type: assignment_notification_rule_reference + summary: '0 minutes: channel P1IAAPZ' + fields: + - name: start_delay_in_minutes + before_value: '0' + value: '2' + references: + - name: contact_method + removed: + - id: POE6L88 + type: push_notification_contact_method_reference + summary: Pixel 3 + added: + - id: P4GTUMK + type: sms_contact_method_reference + summary: Mobile + next_cursor: null + limit: 10 + AuditRecordEscalationPolicyResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_ESCALATION_POLICY + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:52.026Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + - id: PD_CREATE_ESCALATION_POLICY + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Escalation + - name: description + value: Escalation Policy for devops + - name: num_loops + value: '1' + resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + execution_context: + request_id: 0cc413fb-8e7d-4414-b4bc-b7578bf3ba77 + execution_time: '2021-01-05T16:33:51.951Z' + method: + type: browser + root_resource: + id: PD_ESCALATION_ID + summary: DevOps Escalation + type: escalation_policy_reference + self: 'https://api.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + html_url: 'https://mydomain.pagerduty.com/escalation_policies/PD_ESCALATION_ID' + limit: 10 + next_cursor: null + AuditRecordScheduleResponse: + summary: Response Example + value: + records: + - id: PD_ASSIGN_TEAM_TO_SCHEDULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_TEAM123 + summary: Devops + type: team_reference + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + name: teams + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.324Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + - id: PD_CREATE_SCHEDULE + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: DevOps Schedule + - name: description + value: Our DevOps Team Schedule + - name: time_zone + value: America/New_York + resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + execution_context: + request_id: 13a1c0c3-545c-4ebb-4115-662fff9d8ad + execution_time: '2021-01-05T16:25:41.315Z' + method: + type: browser + root_resource: + id: PD_SCHEDULE_ID + summary: DevOps Schedule + type: schedule_reference + self: 'https://api.pagerduty.com/schedules/PD_SCHEDULE_ID' + html_url: 'https://mydomain.pagerduty.com/schedules/PD_SCHEDULE_ID' + limit: 10 + next_cursor: null + AuditRecordServiceResponse: + summary: Response Example + value: + records: + - id: PDRECORDID1_SERVICE_CREATED + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + method: + type: api_token + truncated_token: 3usr + root_resource: + id: PN2YA40 + type: service_reference + summary: Documentation Hub + action: create + details: + resource: + id: PD_SERVICE_ID + type: service_reference + summary: Documentation Hub + fields: + - name: name + value: Documentation Hub + - name: description + value: Centralized documentation + - name: incident_severity + value: always_high + - name: alert_creation + value: create_alerts_and_incidents + - name: auto_resolve_timeout + value: '' + - name: acknowledgement_timeout + value: '' + - name: alert_grouping + value: null + - name: alert_grouping_timeout + value: '' + references: + - name: escalation_policy + added: + - id: PD_SERVICE_ID + summary: Default + type: escalation_policy_reference + next_cursor: null + limit: 10 + AuditRecordTeamResponse: + summary: Response Example + value: + records: + - id: PDRECORD_USER_ROLE_ON_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: my DevOps team + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: update + details: + resource: + id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + fields: + - name: members.role + value: manager + - id: PDRECORD_USER_ADDED_TO_TEAM + execution_time: '2020-06-04T15:30:16.272Z' + execution_context: + request_id: 111lDEOIH-534-4ljhLHJjh111 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + action: update + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + references: + - name: members + added: + - id: PD_ADMIN_USER123 + type: user_reference + summary: AA Admin User + self: 'https://api.pagerduty.com/users/PD_ADMIN_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_ADMIN_USER123' + - id: PDRECORD_TEAM_CREATED + execution_time: '2020-06-04T15:25:04.113Z' + execution_context: + request_id: 222lDEOIH-534-4ljhLHJjh222 + remote_address: 201.19.20.19 + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + method: + type: browser + root_resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + action: create + details: + resource: + id: PD_TEAM123 + type: team_reference + summary: DevOps + self: 'https://api.pagerduty.com/teams/PD_TEAM123' + html_url: 'https://mydomain.pagerduty.com/teams/PD_TEAM123' + fields: + - name: name + value: DevOps + - name: description + value: MyDevOps Team + - name: default_role + value: manager + next_cursor: null + limit: 10 + AuditRecordUserResponse: + summary: Response Example + value: + records: + - id: PD_ADD_HIGH_URGENCY_NOTIFICATION + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_HIGH_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: high + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_HIGH + summary: 'High Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.343Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_RULE + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: start_delay_in_minutes + value: '0' + - name: urgency + value: low + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_method + resource: + id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_LOW_URGENCY_EMAIL_CONTACT + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_NOTIFICATION_RULE_LOW + summary: 'Low Urgency (Email: Default)' + type: assignment_notification_rule_reference + name: notification_rules + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.335Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_EMAIL_CONTACT_FOR_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: label + value: Default + - name: type + value: email_contact_method + - name: address + value: testuser@testabc123.com + resource: + id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_ADD_EMAIL_CONTACT_TO_USER + action: update + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + references: + - added: + - id: PD_CONTACT_METHOD + summary: Default + type: email_contact_method_reference + name: contact_methods + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:32.327Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + - id: PD_CREATE_USER + action: create + actors: + - id: PDUSER + summary: John Snow + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER123' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER123' + details: + fields: + - name: name + value: Test User + - name: role + value: user + - name: email + value: testuser@testabc123.com + - name: time_zone + value: America/New_York + - name: description + value: null + - name: job_title + value: null + - name: color + value: brown + resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + execution_context: + request_id: a68929b2-d0f4-4def-b1d2-6bb744c44e3d + execution_time: '2021-01-05T15:17:31.708Z' + method: + type: browser + root_resource: + id: PD_USER_999 + summary: Test User + type: user_reference + self: 'https://api.pagerduty.com/users/PD_USER_999' + html_url: 'https://mydomain.pagerduty.com/users/PD_USER_999' + limit: 10 + next_cursor: null + OrchestrationPathGlobalTypeResponse: + summary: Example Response + value: + orchestration_path: + type: global + parent: + id: b02e973d-9620-4e0a-9edc-00fedf7d4694 + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694' + type: event_orchestration_reference + self: 'https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/global' + sets: + - id: start + rules: + - label: Always apply some consistent event transformations to all events + id: c91f72f3 + conditions: [] + actions: + variables: + - name: hostname + path: event.component + value: 'hostname: (.*)' + type: regex + extractions: + - template: '{{variables.hostname}}' + target: event.custom_details.hostname + - source: event.source + regex: www (.*) service + target: event.source + route_to: step-two + - id: step-two + rules: + - label: All critical alerts should be treated as P1 incidents + id: 7c54529d + conditions: + - expression: event.severity matches 'critical' + actions: + priority: P0IN2KQ + suppress: false + - label: Drop all events from the very-noisy monitoring tool + id: 1f6d9a33 + conditions: + - expression: event.source matches part 'very-noisy' + actions: + drop_event: true + - label: Never bother the on-call for info-level events outside of work hours + id: cd770384 + conditions: + - expression: 'event.severity matches ''info'' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)' + actions: + suppress: true + catch_all: + actions: + suppress: true + created_at: '2021-11-18T16:42:01Z' + created_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + updated_at: '2021-11-18T16:42:01Z' + updated_by: + id: P8B9WR8 + self: 'https://api.pagerduty.com/users/P8B9WR8' + type: user_reference + version: rn1Mja13T1HBdmPChqFilSQXUW2fWXM_ + CreateSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: header-name + value: header-value + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + type: webhook_subscription + GetSubscriptionExample: + summary: Example + value: + webhook_subscription: + delivery_method: + id: PF9KMXH + secret: null + temporarily_disabled: false + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + ListSubscriptionExample: + summary: Example + value: + webhook_subscriptions: + - delivery_method: + id: PF9KMXH + secret: null + type: http_delivery_method + url: 'https://example.com/receive_a_pagerduty_webhook' + custom_headers: + - name: your-header-name + value: '-- redacted --' + description: Sends PagerDuty v3 webhook events somewhere interesting. + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + filter: + id: P393ZNQ + type: service_reference + id: PY1OL64 + type: webhook_subscription + active: true + limit: 25 + offset: 0 + total: null + more: false + PutSubscriptionExample: + summary: Update Subscribed Events + value: + webhook_subscription: + events: + - incident.acknowledged + - incident.annotated + - incident.delegated + - incident.escalated + - incident.priority_updated + - incident.reassigned + - incident.reopened + - incident.resolved + - incident.responder.added + - incident.responder.replied + - incident.triggered + - incident.unacknowledged + x-stackQL-resources: + webhook_subscriptions: + id: pagerduty.webhooks.webhook_subscriptions + name: webhook_subscriptions + title: Webhook Subscriptions + methods: + list_webhook_subscriptions: + operation: + $ref: '#/paths/~1webhook_subscriptions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.webhook_subscriptions + _list_webhook_subscriptions: + operation: + $ref: '#/paths/~1webhook_subscriptions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_webhook_subscription: + operation: + $ref: '#/paths/~1webhook_subscriptions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_webhook_subscription: + operation: + $ref: '#/paths/~1webhook_subscriptions~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.webhook_subscription + _get_webhook_subscription: + operation: + $ref: '#/paths/~1webhook_subscriptions~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_webhook_subscription: + operation: + $ref: '#/paths/~1webhook_subscriptions~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_webhook_subscription: + operation: + $ref: '#/paths/~1webhook_subscriptions~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + enable_webhook_subscription: + operation: + $ref: '#/paths/~1webhook_subscriptions~1{id}~1enable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + test_webhook_subscription: + operation: + $ref: '#/paths/~1webhook_subscriptions~1{id}~1ping/post' + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/webhook_subscriptions/methods/get_webhook_subscription' + - $ref: '#/components/x-stackQL-resources/webhook_subscriptions/methods/list_webhook_subscriptions' + insert: + - $ref: '#/components/x-stackQL-resources/webhook_subscriptions/methods/create_webhook_subscription' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/webhook_subscriptions/methods/delete_webhook_subscription' +paths: + /webhook_subscriptions: + get: + tags: + - Webhooks + operationId: listWebhookSubscriptions + summary: List webhook subscriptions + description: | + 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/). + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/offset_limit' + - $ref: '#/components/parameters/offset_offset' + - $ref: '#/components/parameters/offset_total' + - $ref: '#/components/parameters/webhooks_filter_type' + - $ref: '#/components/parameters/webhooks_filter_id' + responses: + '200': + description: A set of webhook subscriptions matching the request. + content: + application/json: + schema: + allOf: + - type: object + properties: + webhook_subscriptions: + type: array + items: + $ref: '#/components/schemas/WebhookSubscription' + required: + - webhook_subscriptions + - $ref: '#/components/schemas/Pagination' + examples: + response: + $ref: '#/components/examples/ListSubscriptionExample' + '400': + $ref: '#/components/responses/WebhookBadRequest' + '401': + $ref: '#/components/responses/WebhookUnauthorized' + '403': + $ref: '#/components/responses/WebhookForbidden' + post: + tags: + - Webhooks + operationId: createWebhookSubscription + summary: Create a webhook subscription + description: | + 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/). + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + requestBody: + content: + application/json: + schema: + type: object + properties: + webhook_subscription: + $ref: '#/components/schemas/WebhookSubscription' + required: + - webhook_subscription + examples: + request: + $ref: '#/components/examples/CreateSubscriptionExample' + responses: + '200': + description: The webhook subscription that was created. + content: + application/json: + schema: + type: object + properties: + webhook_subscription: + $ref: '#/components/schemas/WebhookSubscription' + required: + - webhook_subscription + examples: + response: + $ref: '#/components/examples/GetSubscriptionExample' + '400': + $ref: '#/components/responses/WebhookBadRequest' + '401': + $ref: '#/components/responses/WebhookUnauthorized' + '403': + $ref: '#/components/responses/WebhookForbidden' + '/webhook_subscriptions/{id}': + get: + tags: + - Webhooks + operationId: getWebhookSubscription + summary: Get a webhook subscription + description: | + Gets details about an existing webhook subscription. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + responses: + '200': + description: The webhook subscription that was requested. + content: + application/json: + schema: + type: object + properties: + webhook_subscription: + $ref: '#/components/schemas/WebhookSubscription' + required: + - webhook_subscription + examples: + response: + $ref: '#/components/examples/GetSubscriptionExample' + '400': + $ref: '#/components/responses/WebhookBadRequest' + '401': + $ref: '#/components/responses/WebhookUnauthorized' + '403': + $ref: '#/components/responses/WebhookForbidden' + '404': + $ref: '#/components/responses/WebhookNotFound' + put: + tags: + - Webhooks + operationId: updateWebhookSubscription + summary: Update a webhook subscription + description: | + 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. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/header_Content-Type' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WebhookSubscriptionUpdate' + examples: + request: + $ref: '#/components/examples/PutSubscriptionExample' + responses: + '200': + description: The updated webhook subscription. + content: + application/json: + schema: + type: object + properties: + webhook_subscription: + $ref: '#/components/schemas/WebhookSubscription' + required: + - webhook_subscription + examples: + response: + $ref: '#/components/examples/GetSubscriptionExample' + '400': + $ref: '#/components/responses/WebhookBadRequest' + '401': + $ref: '#/components/responses/WebhookUnauthorized' + '403': + $ref: '#/components/responses/WebhookForbidden' + '404': + $ref: '#/components/responses/WebhookNotFound' + delete: + tags: + - Webhooks + operationId: deleteWebhookSubscription + summary: Delete a webhook subscription + description: | + Deletes a webhook subscription. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + responses: + '204': + description: The webhook subscription was deleted successfully. + '400': + $ref: '#/components/responses/WebhookBadRequest' + '401': + $ref: '#/components/responses/WebhookUnauthorized' + '403': + $ref: '#/components/responses/WebhookForbidden' + '404': + $ref: '#/components/responses/WebhookNotFound' + '/webhook_subscriptions/{id}/enable': + post: + tags: + - Webhooks + operationId: enableWebhookSubscription + summary: Enable a webhook subscription + description: | + 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. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + responses: + '200': + description: The webhook subscription that was successfully enabled. + content: + application/json: + schema: + type: object + properties: + webhook_subscription: + $ref: '#/components/schemas/WebhookSubscription' + required: + - webhook_subscription + examples: + response: + $ref: '#/components/examples/GetSubscriptionExample' + '401': + $ref: '#/components/responses/WebhookUnauthorized' + '403': + $ref: '#/components/responses/WebhookForbidden' + '404': + $ref: '#/components/responses/WebhookNotFound' + '/webhook_subscriptions/{id}/ping': + post: + tags: + - Webhooks + operationId: testWebhookSubscription + summary: Test a webhook subscription + description: | + 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. + parameters: + - $ref: '#/components/parameters/header_Accept' + - $ref: '#/components/parameters/id' + responses: + '202': + description: Accepted + '401': + $ref: '#/components/responses/WebhookUnauthorized' + '403': + $ref: '#/components/responses/WebhookForbidden' + '404': + $ref: '#/components/responses/WebhookNotFound' diff --git a/provider-dev/scripts/.gitkeep b/provider-dev/scripts/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/provider-dev/scripts/fix-broken-links.sh b/provider-dev/scripts/fix-broken-links.sh new file mode 100644 index 0000000..df9d536 --- /dev/null +++ b/provider-dev/scripts/fix-broken-links.sh @@ -0,0 +1 @@ +find provider-dev/openapi/src/pagerduty/v00.00.00000/services -type f -exec sed -i 's|../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts\([^)]*\)|https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts\1|g' {} \; \ No newline at end of file diff --git a/website/docs/.gitkeep b/website/docs/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/website/docs/index.md b/website/docs/index.md new file mode 100644 index 0000000..a643204 --- /dev/null +++ b/website/docs/index.md @@ -0,0 +1,110 @@ +--- +title: pagerduty +hide_title: false +hide_table_of_contents: false +keywords: + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, manage, and integrate PagerDuty resources using SQL +custom_edit_url: null +image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png +id: 'provider-intro' +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + +Incident management platform for real-time operations and response workflows. + +:::info[Provider Summary] + +total services: __33__ +total resources: __133__ + +::: + +See also: +[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry) +* * * + +## Installation + +To pull the latest version of the `pagerduty` provider, run the following command: + +```bash +REGISTRY PULL pagerduty; +``` +> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry). + +## Authentication + +The following system environment variables are used for authentication by default: + +- - PagerDuty API token (see Creating a PagerDuty API Token) + +These variables are sourced at runtime (from the local machine or as CI variables/secrets). + +
+ +Using different environment variables + +To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example: + +```bash + +AUTH='{ "pagerduty": { "type": "bearer", "credentialsenvvar": "YOUR_PAGERDUTY_API_TOKEN_VAR" }}' +stackql shell --auth="${AUTH}" + +``` +or using PowerShell: + +```powershell + +$Auth = "{ 'pagerduty': { 'type': 'bearer', 'credentialsenvvar': 'YOUR_PAGERDUTY_API_TOKEN_VAR' }}" +stackql.exe shell --auth=$Auth + +``` +
+ +## Services +
+
+abilities
+add_ons
+analytics
+audit
+automation_actions
+business_services
+change_events
+custom_fields
+escalation_policies
+event_orchestrations
+extension_schemas
+extensions
+incident_workflows
+incidents
+licenses
+log_entries
+maintenance_windows
+
+
+notifications
+on_calls
+paused_incident_reports
+priorities
+response_plays
+rulesets
+schedules
+service_dependencies
+services
+status_dashboards
+tags
+teams
+templates
+users
+vendors
+webhooks
+
+
diff --git a/website/docs/services/abilities/abilities/index.md b/website/docs/services/abilities/abilities/index.md new file mode 100644 index 0000000..f2824c1 --- /dev/null +++ b/website/docs/services/abilities/abilities/index.md @@ -0,0 +1,189 @@ +--- +title: abilities +hide_title: false +hide_table_of_contents: false +keywords: + - abilities + - abilities + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an abilities resource. + +## Overview + + + + +
Nameabilities
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +An array of ability names. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA single ability, as a name.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Accept, Content-TypeList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#abilities)

Scoped OAuth requires: `abilities.read`
Accept, Content-TypeList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#abilities)

Scoped OAuth requires: `abilities.read`
idAccept, Content-TypeTest 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#abilities)

Scoped OAuth requires: `abilities.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#abilities)

Scoped OAuth requires: `abilities.read`
+ +```sql +SELECT +ability_name +FROM pagerduty.abilities.abilities +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#abilities)

Scoped OAuth requires: `abilities.read`
+ +```sql +EXEC pagerduty.abilities.abilities._list_abilities +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#abilities)

Scoped OAuth requires: `abilities.read`
+ +```sql +EXEC pagerduty.abilities.abilities.get_ability +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/abilities/index.md b/website/docs/services/abilities/index.md new file mode 100644 index 0000000..df03a85 --- /dev/null +++ b/website/docs/services/abilities/index.md @@ -0,0 +1,33 @@ +--- +title: abilities +hide_title: false +hide_table_of_contents: false +keywords: + - abilities + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +abilities service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+abilities +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/add_ons/addons/index.md b/website/docs/services/add_ons/addons/index.md new file mode 100644 index 0000000..b441245 --- /dev/null +++ b/website/docs/services/add_ons/addons/index.md @@ -0,0 +1,413 @@ +--- +title: addons +hide_title: false +hide_table_of_contents: false +keywords: + - addons + - add_ons + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an addons resource. + +## Overview + + + + +
Nameaddons
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The requested Add-on. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the Add-on.
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
string (url)The source URL to display in a frame in the PagerDuty UI. HTTPS is required.
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
stringThe type of Add-on.
+ + + +A paginated array of installed Add-ons. + + + + + + + + + + + +
NameDatatypeDescription
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons)

Scoped OAuth requires: `addons.read`
limit, offset, total, Accept, Content-Type, include[], service_ids[], filterList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons)

Scoped OAuth requires: `addons.read`
data__addonAccept, Content-TypeInstall 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons)

Scoped OAuth requires: `addons.write`
idAccept, Content-TypeRemove 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons)

Scoped OAuth requires: `addons.write`
limit, offset, total, Accept, Content-Type, include[], service_ids[], filterList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons)

Scoped OAuth requires: `addons.read`
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons)

Scoped OAuth requires: `addons.read`
id, addonAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons)

Scoped OAuth requires: `addons.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringFilters the results, showing only Add-ons of the given type
stringArray of additional Models to include in response.
integerThe number of results per page.
integerOffset to start pagination search results.
arrayFilters the results, showing only Add-ons for the given services
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons)

Scoped OAuth requires: `addons.read`
+ +```sql +SELECT +id, +name, +html_url, +self, +src, +summary, +type +FROM pagerduty.add_ons.addons +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons)

Scoped OAuth requires: `addons.read`
+ +```sql +SELECT +* +FROM pagerduty.add_ons.addons +WHERE limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND include[] = '{{ include[] }}' +AND service_ids[] = '{{ service_ids[] }}' +AND filter = '{{ filter }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons)

Scoped OAuth requires: `addons.write`
+ +```sql +INSERT INTO pagerduty.add_ons.addons ( +data__addon, +Accept, +Content-Type +) +SELECT +'{{ addon }}' /* required */, +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +addon +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: addons + props: + - name: addon + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons)

Scoped OAuth requires: `addons.write`
+ +```sql +DELETE FROM pagerduty.add_ons.addons +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons)

Scoped OAuth requires: `addons.read`
+ +```sql +EXEC pagerduty.add_ons.addons._list_addon +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@include[]='{{ include[] }}', +@service_ids[]='{{ service_ids[] }}', +@filter='{{ filter }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons)

Scoped OAuth requires: `addons.read`
+ +```sql +EXEC pagerduty.add_ons.addons._get_addon +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#add-ons)

Scoped OAuth requires: `addons.write`
+ +```sql +EXEC pagerduty.add_ons.addons.update_addon +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"addon": "{{ addon }}" +}' +; +``` + + diff --git a/website/docs/services/add_ons/index.md b/website/docs/services/add_ons/index.md new file mode 100644 index 0000000..ac1c4e2 --- /dev/null +++ b/website/docs/services/add_ons/index.md @@ -0,0 +1,33 @@ +--- +title: add_ons +hide_title: false +hide_table_of_contents: false +keywords: + - add_ons + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +add_ons service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+addons +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/analytics/index.md b/website/docs/services/analytics/index.md new file mode 100644 index 0000000..1919700 --- /dev/null +++ b/website/docs/services/analytics/index.md @@ -0,0 +1,36 @@ +--- +title: analytics +hide_title: false +hide_table_of_contents: false +keywords: + - analytics + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +analytics service documentation. + +:::info[Service Summary] + +total resources: __5__ + +::: + +## Resources +
+
+metrics_incidents_all
+metrics_incidents_services
+metrics_incidents_teams +
+
+raw_incidents
+raw_incidents_responses +
+
\ No newline at end of file diff --git a/website/docs/services/analytics/metrics_incidents_all/index.md b/website/docs/services/analytics/metrics_incidents_all/index.md new file mode 100644 index 0000000..7e12285 --- /dev/null +++ b/website/docs/services/analytics/metrics_incidents_all/index.md @@ -0,0 +1,139 @@ +--- +title: metrics_incidents_all +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_incidents_all + - analytics + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_incidents_all resource. + +## Overview + + + + +
Namemetrics_incidents_all
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe time unit to aggregate metrics by. If no value is provided, the metrics will be aggregated for the entire period. (example: day)
array
objectAccepts a set of filters to apply to the Incidents before aggregating. Any incidents that do not match the included filters will be omitted from the results
stringThe time zone to use for the results and grouping. (example: Etc/UTC)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
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: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- 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:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +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: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- 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:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
+ +```sql +SELECT +aggregate_unit, +data, +filters, +time_zone +FROM pagerduty.analytics.metrics_incidents_all +; +``` + + diff --git a/website/docs/services/analytics/metrics_incidents_services/index.md b/website/docs/services/analytics/metrics_incidents_services/index.md new file mode 100644 index 0000000..b6f5672 --- /dev/null +++ b/website/docs/services/analytics/metrics_incidents_services/index.md @@ -0,0 +1,141 @@ +--- +title: metrics_incidents_services +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_incidents_services + - analytics + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_incidents_services resource. + +## Overview + + + + +
Namemetrics_incidents_services
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Currently the response only returns data for services that match the filters and have data. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe time unit to aggregate metrics by. If no value is provided, the metrics will be aggregated for the entire period. (example: day)
array
objectAccepts a set of filters to apply to the Incidents before aggregating. Any incidents that do not match the included filters will be omitted from the results
stringThe time zone to use for the results and grouping. (example: Etc/UTC)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
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. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).
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: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- 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:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +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. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).
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: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- 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:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
+ +```sql +SELECT +aggregate_unit, +data, +filters, +time_zone +FROM pagerduty.analytics.metrics_incidents_services +; +``` + + diff --git a/website/docs/services/analytics/metrics_incidents_teams/index.md b/website/docs/services/analytics/metrics_incidents_teams/index.md new file mode 100644 index 0000000..c5c7c91 --- /dev/null +++ b/website/docs/services/analytics/metrics_incidents_teams/index.md @@ -0,0 +1,141 @@ +--- +title: metrics_incidents_teams +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_incidents_teams + - analytics + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_incidents_teams resource. + +## Overview + + + + +
Namemetrics_incidents_teams
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Currently the response only returns data for teams that match the filters and have data. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe time unit to aggregate metrics by. If no value is provided, the metrics will be aggregated for the entire period. (example: day)
array
objectAccepts a set of filters to apply to the Incidents before aggregating. Any incidents that do not match the included filters will be omitted from the results
stringThe time zone to use for the results and grouping. (example: Etc/UTC)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
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. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).
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: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- 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:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +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. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).
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: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- 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:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
+ +```sql +SELECT +aggregate_unit, +data, +filters, +time_zone +FROM pagerduty.analytics.metrics_incidents_teams +; +``` + + diff --git a/website/docs/services/analytics/raw_incidents/index.md b/website/docs/services/analytics/raw_incidents/index.md new file mode 100644 index 0000000..e3c61ec --- /dev/null +++ b/website/docs/services/analytics/raw_incidents/index.md @@ -0,0 +1,237 @@ +--- +title: raw_incidents +hide_title: false +hide_table_of_contents: false +keywords: + - raw_incidents + - analytics + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a raw_incidents resource. + +## Overview + + + + +
Nameraw_incidents
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + +
NameDatatypeDescription
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
objectA collection of filters that were applied to the results.
stringCursor to identify the first object in the response.
stringCursor to identify the last object in the response.
integerNumber of results to include in the batch.
booleanIndicates if there are more resources available than were returned.
stringThe order in which the results were sorted; asc for ascending, desc for descending.
stringThe column that was used for ordering the results.
stringThe time zone that the results are in.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idProvides enriched incident data and metrics for a single incident.

Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- theme: info -->
> **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
Provides enriched incident data and metrics for multiple incidents.

Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- 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:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
idProvides enriched incident data and metrics for a single incident.

Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- theme: info -->
> **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
+ +## `SELECT` examples + + + + +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. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- theme: info -->
> **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
+ +```sql +SELECT +* +FROM pagerduty.analytics.raw_incidents +WHERE id = '{{ id }}' -- required +; +``` + + + +Provides enriched incident data and metrics for multiple incidents.

Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- 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:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
+ +```sql +SELECT +data, +filters, +first, +last, +limit, +more, +order, +order_by, +time_zone +FROM pagerduty.analytics.raw_incidents +; +``` + + + + +## Lifecycle Methods + + + + +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. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- theme: info -->
> **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
+ +```sql +EXEC pagerduty.analytics.raw_incidents._get_analytics_incidents_by_id +@id='{{ id }}' --required +; +``` + + diff --git a/website/docs/services/analytics/raw_incidents_responses/index.md b/website/docs/services/analytics/raw_incidents_responses/index.md new file mode 100644 index 0000000..87fd43c --- /dev/null +++ b/website/docs/services/analytics/raw_incidents_responses/index.md @@ -0,0 +1,198 @@ +--- +title: raw_incidents_responses +hide_title: false +hide_table_of_contents: false +keywords: + - raw_incidents_responses + - analytics + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a raw_incidents_responses resource. + +## Overview + + + + +
Nameraw_incidents_responses
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the user associated with the Incident Response.
stringName of the user associated with the Incident Response.
stringTimestamp of when the user was requested.
stringTimestamp of when the user responded to the request.
stringType of responder, where `assigned` means the user was added to the Incident via Assignment at Incident creation, `reassigned` means the user was added to the Incident via Reassignment, `escalated` means the user was added via Escalation, and `added_responder` means the user was added via Responder Reqeuest.
stringStatus of the user's interaction with the Incident notification.
integerMeasures the time it took for the user to respond to the Incident request. In other words, `responded_at - requested_at`.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idProvides enriched responder data for a single incident.

Example metrics include Time to Respond, Responder Type, and Response Status. See metric definitions below.
<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- theme: info -->
> **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incident responses appear in the Analytics API.
Scoped OAuth requires: `analytics.read`
idProvides enriched responder data for a single incident.

Example metrics include Time to Respond, Responder Type, and Response Status. See metric definitions below.
<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- theme: info -->
> **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incident responses appear in the Analytics API.
Scoped OAuth requires: `analytics.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
+ +## `SELECT` examples + + + + +Provides enriched responder data for a single incident.

Example metrics include Time to Respond, Responder Type, and Response Status. See metric definitions below.
<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- theme: info -->
> **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incident responses appear in the Analytics API.
Scoped OAuth requires: `analytics.read`
+ +```sql +SELECT +responder_id, +responder_name, +requested_at, +responded_at, +responder_type, +response_status, +time_to_respond_seconds +FROM pagerduty.analytics.raw_incidents_responses +WHERE id = '{{ id }}' -- required +; +``` + + + + +## Lifecycle Methods + + + + +Provides enriched responder data for a single incident.

Example metrics include Time to Respond, Responder Type, and Response Status. See metric definitions below.
<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- theme: info -->
> **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incident responses appear in the Analytics API.
Scoped OAuth requires: `analytics.read`
+ +```sql +EXEC pagerduty.analytics.raw_incidents_responses._get_analytics_incident_responses_by_id +@id='{{ id }}' --required +@@json= +'{ +"limit": {{ limit }}, +"order": "{{ order }}", +"order_by": "{{ order_by }}", +"time_zone": "{{ time_zone }}" +}' +; +``` + + diff --git a/website/docs/services/audit/index.md b/website/docs/services/audit/index.md new file mode 100644 index 0000000..dfa37bb --- /dev/null +++ b/website/docs/services/audit/index.md @@ -0,0 +1,33 @@ +--- +title: audit +hide_title: false +hide_table_of_contents: false +keywords: + - audit + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +audit service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+records +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/audit/records/index.md b/website/docs/services/audit/records/index.md new file mode 100644 index 0000000..024aeed --- /dev/null +++ b/website/docs/services/audit/records/index.md @@ -0,0 +1,282 @@ +--- +title: records +hide_title: false +hide_table_of_contents: false +keywords: + - records + - audit + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a records resource. + +## Overview + + + + +
Namerecords
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Records matching the query criteria. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (example: create)
array
objectAdditional details to provide further information about the action or the resource that has been audited.
objectAction execution context
string (date-time)The date/time the action executed, in ISO8601 format and millisecond precision.
objectThe method information
object
stringRecord URL.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Accept, Content-Type, limit, cursor, since, until, root_resource_types[], actor_type, actor_id, method_type, method_truncated_token, actions[]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`
Accept, Content-Type, limit, cursor, since, until, root_resource_types[], actor_type, actor_id, method_type, method_truncated_token, actions[]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`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe `Accept` header is used as a versioning header.
string
stringAction filter
stringActor Id filter. Must be qualified by providing the `actor_type` param.
stringActor type filter.
stringOptional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set.
integerThe minimum of the `limit` parameter used in the request or the maximum request size of the API.
stringMethod truncated_token filter. Must be qualified by providing the `method_type` param.
stringMethod type filter.
stringResource type filter for the root_resource.
string (date-time)The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)
string (date-time)The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.
+ +## `SELECT` examples + + + + +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`
+ +```sql +SELECT +id, +action, +actors, +details, +execution_context, +execution_time, +method, +root_resource, +self +FROM pagerduty.audit.records +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND cursor = '{{ cursor }}' +AND since = '{{ since }}' +AND until = '{{ until }}' +AND root_resource_types[] = '{{ root_resource_types[] }}' +AND actor_type = '{{ actor_type }}' +AND actor_id = '{{ actor_id }}' +AND method_type = '{{ method_type }}' +AND method_truncated_token = '{{ method_truncated_token }}' +AND actions[] = '{{ actions[] }}' +; +``` + + + + +## Lifecycle Methods + + + + +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`
+ +```sql +EXEC pagerduty.audit.records._list_audit_records +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@cursor='{{ cursor }}', +@since='{{ since }}', +@until='{{ until }}', +@root_resource_types[]='{{ root_resource_types[] }}', +@actor_type='{{ actor_type }}', +@actor_id='{{ actor_id }}', +@method_type='{{ method_type }}', +@method_truncated_token='{{ method_truncated_token }}', +@actions[]='{{ actions[] }}' +; +``` + + diff --git a/website/docs/services/automation_actions/actions/index.md b/website/docs/services/automation_actions/actions/index.md new file mode 100644 index 0000000..c4cdefe --- /dev/null +++ b/website/docs/services/automation_actions/actions/index.md @@ -0,0 +1,420 @@ +--- +title: actions +hide_title: false +hide_table_of_contents: false +keywords: + - actions + - automation_actions + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an actions resource. + +## Overview + + + + +
Nameactions
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Action information + + + + + + + + + + + +
NameDatatypeDescription
+ + + +An array of actions + + + + + + + + + + + +
NameDatatypeDescription
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet an Automation Action
Accept, Content-Type, limit, cursor, name, runner_id, classification, team_id, service_id, action_typeLists 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.
id, data__invocationAccept, Content-TypeInvokes an Action
data__actionAccept, Content-TypeCreate a Script, Process Automation, or Runbook Automation action
idAccept, Content-TypeDelete an Automation Action
Accept, Content-Type, limit, cursor, name, runner_id, classification, team_id, service_id, action_typeLists 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.
idAccept, Content-TypeGet an Automation Action
id, actionAccept, Content-TypeUpdates an Automation Action
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringFilters results to include the ones matching the specified action type
stringFilters results to include the ones matching the specified classification (aka category)
stringOptional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set.
integerThe minimum of the `limit` parameter used in the request or the maximum request size of the API.
stringFilters results to include the ones matching the name (case insensitive substring matching)
stringFilters results to include the ones linked to the specified runner. Specifying the value `any` filters results to include the ones linked to runners only, thus omitting the results not linked to runners.
stringFilters results to include the ones associated with the specified service
stringFilters results to include the ones associated with the specified team.
+ +## `SELECT` examples + + + + +Get an Automation Action
+ +```sql +SELECT +* +FROM pagerduty.automation_actions.actions +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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.
+ +```sql +SELECT +* +FROM pagerduty.automation_actions.actions +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND cursor = '{{ cursor }}' +AND name = '{{ name }}' +AND runner_id = '{{ runner_id }}' +AND classification = '{{ classification }}' +AND team_id = '{{ team_id }}' +AND service_id = '{{ service_id }}' +AND action_type = '{{ action_type }}' +; +``` + + + + +## `INSERT` examples + + + + +Invokes an Action
+ +```sql +INSERT INTO pagerduty.automation_actions.actions ( +data__invocation, +id, +Accept, +Content-Type +) +SELECT +'{{ invocation }}' /* required */, +'{{ id }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +invocation +; +``` + + + +Create a Script, Process Automation, or Runbook Automation action
+ +```sql +INSERT INTO pagerduty.automation_actions.actions ( +data__action, +Accept, +Content-Type +) +SELECT +'{{ action }}' /* required */, +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +action +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: actions + props: + - name: id + value: string + description: Required parameter for the actions resource. + - name: invocation + value: object + - name: action + value: string + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +Delete an Automation Action
+ +```sql +DELETE FROM pagerduty.automation_actions.actions +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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.
+ +```sql +EXEC pagerduty.automation_actions.actions._get_all_automation_actions +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@cursor='{{ cursor }}', +@name='{{ name }}', +@runner_id='{{ runner_id }}', +@classification='{{ classification }}', +@team_id='{{ team_id }}', +@service_id='{{ service_id }}', +@action_type='{{ action_type }}' +; +``` + + + +Get an Automation Action
+ +```sql +EXEC pagerduty.automation_actions.actions._get_automation_action +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +Updates an Automation Action
+ +```sql +EXEC pagerduty.automation_actions.actions.update_automation_action +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"action": "{{ action }}" +}' +; +``` + + diff --git a/website/docs/services/automation_actions/actions_services/index.md b/website/docs/services/automation_actions/actions_services/index.md new file mode 100644 index 0000000..560ecda --- /dev/null +++ b/website/docs/services/automation_actions/actions_services/index.md @@ -0,0 +1,379 @@ +--- +title: actions_services +hide_title: false +hide_table_of_contents: false +keywords: + - actions_services + - automation_actions + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an actions_services resource. + +## Overview + + + + +
Nameactions_services
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Service reference + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
string
+ + + +An array of service references + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, service_idAccept, Content-TypeGets the details of a Automation Action / service relation
idAccept, Content-TypeGets all service references associated with an Automation Action
id, data__serviceAccept, Content-TypeAssociate an Automation Action with a service
id, service_idAccept, Content-TypeDisassociate an Automation Action from a service
idAccept, Content-TypeGets all service references associated with an Automation Action
id, service_idAccept, Content-TypeGets the details of a Automation Action / service relation
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe service ID
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +Gets the details of a Automation Action / service relation + +```sql +SELECT +id, +html_url, +self, +summary, +type +FROM pagerduty.automation_actions.actions_services +WHERE id = '{{ id }}' -- required +AND service_id = '{{ service_id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +Gets all service references associated with an Automation Action + +```sql +SELECT +id, +html_url, +self, +summary, +type +FROM pagerduty.automation_actions.actions_services +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## `INSERT` examples + + + + +Associate an Automation Action with a service
+ +```sql +INSERT INTO pagerduty.automation_actions.actions_services ( +data__service, +id, +Accept, +Content-Type +) +SELECT +'{{ service }}' /* required */, +'{{ id }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +service +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: actions_services + props: + - name: id + value: string + description: Required parameter for the actions_services resource. + - name: service + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +Disassociate an Automation Action from a service
+ +```sql +DELETE FROM pagerduty.automation_actions.actions_services +WHERE id = '{{ id }}' --required +AND service_id = '{{ service_id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +Gets all service references associated with an Automation Action + +```sql +EXEC pagerduty.automation_actions.actions_services._get_automation_actions_action_service_associations +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +Gets the details of a Automation Action / service relation + +```sql +EXEC pagerduty.automation_actions.actions_services._get_automation_actions_action_service_association +@id='{{ id }}' --required, +@service_id='{{ service_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/automation_actions/actions_teams/index.md b/website/docs/services/automation_actions/actions_teams/index.md new file mode 100644 index 0000000..41b95cd --- /dev/null +++ b/website/docs/services/automation_actions/actions_teams/index.md @@ -0,0 +1,375 @@ +--- +title: actions_teams +hide_title: false +hide_table_of_contents: false +keywords: + - actions_teams + - automation_actions + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an actions_teams resource. + +## Overview + + + + +
Nameactions_teams
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
string
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, team_idAccept, Content-TypeGets the details of an Automation Action / team relation
idAccept, Content-TypeGets all team references associated with an Automation Action
id, data__teamAccept, Content-TypeAssociate an Automation Action with a team
id, team_idAccept, Content-TypeDisassociate an Automation Action from a team
idAccept, Content-TypeGets all team references associated with an Automation Action
id, team_idAccept, Content-TypeGets the details of an Automation Action / team relation
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe team ID
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +Gets the details of an Automation Action / team relation + +```sql +SELECT +id, +html_url, +self, +summary, +type +FROM pagerduty.automation_actions.actions_teams +WHERE id = '{{ id }}' -- required +AND team_id = '{{ team_id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +Gets all team references associated with an Automation Action + +```sql +SELECT +id, +html_url, +self, +summary, +type +FROM pagerduty.automation_actions.actions_teams +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## `INSERT` examples + + + + +Associate an Automation Action with a team
+ +```sql +INSERT INTO pagerduty.automation_actions.actions_teams ( +data__team, +id, +Accept, +Content-Type +) +SELECT +'{{ team }}' /* required */, +'{{ id }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +team +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: actions_teams + props: + - name: id + value: string + description: Required parameter for the actions_teams resource. + - name: team + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +Disassociate an Automation Action from a team
+ +```sql +DELETE FROM pagerduty.automation_actions.actions_teams +WHERE id = '{{ id }}' --required +AND team_id = '{{ team_id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +Gets all team references associated with an Automation Action + +```sql +EXEC pagerduty.automation_actions.actions_teams._get_automation_actions_action_team_associations +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +Gets the details of an Automation Action / team relation + +```sql +EXEC pagerduty.automation_actions.actions_teams._get_automation_actions_action_team_association +@id='{{ id }}' --required, +@team_id='{{ team_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/automation_actions/index.md b/website/docs/services/automation_actions/index.md new file mode 100644 index 0000000..c0b6b9d --- /dev/null +++ b/website/docs/services/automation_actions/index.md @@ -0,0 +1,37 @@ +--- +title: automation_actions +hide_title: false +hide_table_of_contents: false +keywords: + - automation_actions + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +automation_actions service documentation. + +:::info[Service Summary] + +total resources: __6__ + +::: + +## Resources +
+
+actions
+actions_services
+actions_teams +
+
+invocations
+runners
+runners_teams +
+
\ No newline at end of file diff --git a/website/docs/services/automation_actions/invocations/index.md b/website/docs/services/automation_actions/invocations/index.md new file mode 100644 index 0000000..bf424fa --- /dev/null +++ b/website/docs/services/automation_actions/invocations/index.md @@ -0,0 +1,379 @@ +--- +title: invocations +hide_title: false +hide_table_of_contents: false +keywords: + - invocations + - automation_actions + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an invocations resource. + +## Overview + + + + +
Nameinvocations
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Invocation information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
integerThe duration of the invocation's execution time.
string (url)a URL at which the entity is uniquely displayed in the Web app
object
string (url)the API show URL at which the object is accessible
stringprepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner (example: sent)
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
arrayA list of state transitions with timestamps. Only the 'created' transition is guaranteed to exist at any time.
stringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.
+ + + +Invocations matching the criteria + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
integerThe duration of the invocation's execution time.
string (url)a URL at which the entity is uniquely displayed in the Web app
object
string (url)the API show URL at which the object is accessible
stringprepared -- the invocation exists and can be referenced, but is NOT available to a Runner
created -- the invocation exists and is waiting for a Runner
sent -- invocation sent to a Runner
queued -- invocation queued by a Runner
running -- invocation is being ran by a Runner
aborted -- invocation was aborted on a Runner
completed -- invocation completed on a Runner
error -- invocation encountered an error on a Runner (example: sent)
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
arrayA list of state transitions with timestamps. Only the 'created' transition is guaranteed to exist at any time.
stringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet an Automation Action Invocation
incident_idAccept, Content-Type, invocation_stateList Invocations
incident_idAccept, Content-Type, invocation_stateList Invocations
idAccept, Content-TypeGet an Automation Action Invocation
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringIncident ID
stringThe `Accept` header is used as a versioning header.
string
stringInvocation state
+ +## `SELECT` examples + + + + +Get an Automation Action Invocation
+ +```sql +SELECT +id, +action_id, +runner_id, +action_snapshot, +duration, +html_url, +metadata, +self, +state, +summary, +timing, +type +FROM pagerduty.automation_actions.invocations +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +List Invocations
+ +```sql +SELECT +id, +action_id, +runner_id, +action_snapshot, +duration, +html_url, +metadata, +self, +state, +summary, +timing, +type +FROM pagerduty.automation_actions.invocations +WHERE incident_id = '{{ incident_id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND invocation_state = '{{ invocation_state }}' +; +``` + + + + +## Lifecycle Methods + + + + +List Invocations
+ +```sql +EXEC pagerduty.automation_actions.invocations._list_automation_action_invocations +@incident_id='{{ incident_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@invocation_state='{{ invocation_state }}' +; +``` + + + +Get an Automation Action Invocation
+ +```sql +EXEC pagerduty.automation_actions.invocations._get_automation_actions_invocation +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/automation_actions/runners/index.md b/website/docs/services/automation_actions/runners/index.md new file mode 100644 index 0000000..3824b88 --- /dev/null +++ b/website/docs/services/automation_actions/runners/index.md @@ -0,0 +1,548 @@ +--- +title: runners +hide_title: false +hide_table_of_contents: false +keywords: + - runners + - automation_actions + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a runners resource. + +## Overview + + + + +
Namerunners
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Runner information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (example: us-west-2 prod runner)
objectReferences to at most 3 actions associated with the Runner. Use appropriate endpoints to retrieve the full list of associated actions.
string (date-time)
string (example: us-west-2 runner provisioned in the production environment by the SRE team)
string (url)a URL at which the entity is uniquely displayed in the Web app
string (date-time)
objectAdditional metadata
object
stringThe base URI of the Runbook server to connect to. May only contain alphanumeric characters, periods, underscores and dashes. (example: subdomain)
stringsidecar -- The runner is backed by an external sidecar that polls for invocations. runbook -- The runner communicates directly with a runbook instance. (example: runbook)
string (url)the API show URL at which the object is accessible
stringConfigured -- Runner has connected to the backend at least once NotConfigured -- Runner has never connected to backend (example: Configured)
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
arrayThe list of teams associated with the Runner
stringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.
+ + + +Runners matching the criteria. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (example: us-west-2 prod runner)
objectReferences to at most 3 actions associated with the Runner. Use appropriate endpoints to retrieve the full list of associated actions.
string (date-time)
string (example: us-west-2 runner provisioned in the production environment by the SRE team)
string (url)a URL at which the entity is uniquely displayed in the Web app
string (date-time)
objectAdditional metadata
object
stringThe base URI of the Runbook server to connect to. May only contain alphanumeric characters, periods, underscores and dashes. (example: subdomain)
stringsidecar -- The runner is backed by an external sidecar that polls for invocations. runbook -- The runner communicates directly with a runbook instance. (example: runbook)
string (url)the API show URL at which the object is accessible
stringConfigured -- Runner has connected to the backend at least once NotConfigured -- Runner has never connected to backend (example: Configured)
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
arrayThe list of teams associated with the Runner
stringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet an Automation Action runner
Accept, Content-Type, limit, cursor, name, include[]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.
data__runnerAccept, Content-TypeCreate a Process Automation or a Runbook Automation runner.
idAccept, Content-TypeDelete an Automation Action runner
Accept, Content-Type, limit, cursor, name, include[]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.
idAccept, Content-TypeGet an Automation Action runner
id, runnerAccept, Content-TypeUpdate an Automation Action runner
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringOptional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set.
arrayIncludes additional data elements into the response
integerThe minimum of the `limit` parameter used in the request or the maximum request size of the API.
stringFilters results to include the ones matching the name (case insensitive substring matching)
+ +## `SELECT` examples + + + + +Get an Automation Action runner
+ +```sql +SELECT +id, +name, +associated_actions, +creation_time, +description, +html_url, +last_seen, +metadata, +privileges, +runbook_base_uri, +runner_type, +self, +status, +summary, +teams, +type +FROM pagerduty.automation_actions.runners +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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.
+ +```sql +SELECT +id, +name, +associated_actions, +creation_time, +description, +html_url, +last_seen, +metadata, +privileges, +runbook_base_uri, +runner_type, +self, +status, +summary, +teams, +type +FROM pagerduty.automation_actions.runners +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND cursor = '{{ cursor }}' +AND name = '{{ name }}' +AND include[] = '{{ include[] }}' +; +``` + + + + +## `INSERT` examples + + + + +Create a Process Automation or a Runbook Automation runner.
+ +```sql +INSERT INTO pagerduty.automation_actions.runners ( +data__runner, +Accept, +Content-Type +) +SELECT +'{{ runner }}' /* required */, +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +runner +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: runners + props: + - name: runner + value: string + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +Delete an Automation Action runner
+ +```sql +DELETE FROM pagerduty.automation_actions.runners +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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.
+ +```sql +EXEC pagerduty.automation_actions.runners._get_automation_actions_runners +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@cursor='{{ cursor }}', +@name='{{ name }}', +@include[]='{{ include[] }}' +; +``` + + + +Get an Automation Action runner
+ +```sql +EXEC pagerduty.automation_actions.runners._get_automation_actions_runner +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +Update an Automation Action runner
+ +```sql +EXEC pagerduty.automation_actions.runners.update_automation_actions_runner +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"runner": "{{ runner }}" +}' +; +``` + + diff --git a/website/docs/services/automation_actions/runners_teams/index.md b/website/docs/services/automation_actions/runners_teams/index.md new file mode 100644 index 0000000..30b4b3a --- /dev/null +++ b/website/docs/services/automation_actions/runners_teams/index.md @@ -0,0 +1,375 @@ +--- +title: runners_teams +hide_title: false +hide_table_of_contents: false +keywords: + - runners_teams + - automation_actions + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a runners_teams resource. + +## Overview + + + + +
Namerunners_teams
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
string
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, team_idAccept, Content-TypeGets the details of a runner / team relation
idAccept, Content-TypeGets all team references associated with a runner
id, data__teamAccept, Content-TypeAssociate a runner with a team
id, team_idAccept, Content-TypeDisassociates a runner from a team
idAccept, Content-TypeGets all team references associated with a runner
id, team_idAccept, Content-TypeGets the details of a runner / team relation
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe team ID
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +Gets the details of a runner / team relation + +```sql +SELECT +id, +html_url, +self, +summary, +type +FROM pagerduty.automation_actions.runners_teams +WHERE id = '{{ id }}' -- required +AND team_id = '{{ team_id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +Gets all team references associated with a runner + +```sql +SELECT +id, +html_url, +self, +summary, +type +FROM pagerduty.automation_actions.runners_teams +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## `INSERT` examples + + + + +Associate a runner with a team
+ +```sql +INSERT INTO pagerduty.automation_actions.runners_teams ( +data__team, +id, +Accept, +Content-Type +) +SELECT +'{{ team }}' /* required */, +'{{ id }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +team +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: runners_teams + props: + - name: id + value: string + description: Required parameter for the runners_teams resource. + - name: team + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +Disassociates a runner from a team
+ +```sql +DELETE FROM pagerduty.automation_actions.runners_teams +WHERE id = '{{ id }}' --required +AND team_id = '{{ team_id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +Gets all team references associated with a runner + +```sql +EXEC pagerduty.automation_actions.runners_teams._get_automation_actions_runner_team_associations +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +Gets the details of a runner / team relation + +```sql +EXEC pagerduty.automation_actions.runners_teams._get_automation_actions_runner_team_association +@id='{{ id }}' --required, +@team_id='{{ team_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/business_services/account_subscription/index.md b/website/docs/services/business_services/account_subscription/index.md new file mode 100644 index 0000000..951df69 --- /dev/null +++ b/website/docs/services/business_services/account_subscription/index.md @@ -0,0 +1,190 @@ +--- +title: account_subscription +hide_title: false +hide_table_of_contents: false +keywords: + - account_subscription + - business_services + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an account_subscription resource. + +## Overview + + + + +
Nameaccount_subscription
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAcceptSubscribe your Account to a Business Service.

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

Scoped OAuth requires: `subscribers.write`
id, subscribersAcceptUnsubscribes the matching Subscribers from a Business Service.

Scoped OAuth requires: `subscribers.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
+ +## `INSERT` examples + + + + +Subscribe your Account to a Business Service.

Scoped OAuth requires: `subscribers.write`
+ +```sql +INSERT INTO pagerduty.business_services.account_subscription ( +id, +Accept +) +SELECT +'{{ id }}', +'{{ Accept }}' +RETURNING +account_is_subscribed +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: account_subscription + props: + - name: id + value: string + description: Required parameter for the account_subscription resource. + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. +``` + + + + +## `DELETE` examples + + + + +Unsubscribe your Account from a Business Service.

Scoped OAuth requires: `subscribers.write`
+ +```sql +DELETE FROM pagerduty.business_services.account_subscription +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +; +``` + + + + +## Lifecycle Methods + + + + +Unsubscribes the matching Subscribers from a Business Service.

Scoped OAuth requires: `subscribers.write`
+ +```sql +EXEC pagerduty.business_services.account_subscription.remove_business_service_notification_subscriber +@id='{{ id }}' --required, +@Accept='{{ Accept }}' +@@json= +'{ +"subscribers": "{{ subscribers }}" +}' +; +``` + + diff --git a/website/docs/services/business_services/business_services/index.md b/website/docs/services/business_services/business_services/index.md new file mode 100644 index 0000000..6f12b4f --- /dev/null +++ b/website/docs/services/business_services/business_services/index.md @@ -0,0 +1,406 @@ +--- +title: business_services +hide_title: false +hide_table_of_contents: false +keywords: + - business_services + - business_services + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a business_services resource. + +## Overview + + + + +
Namebusiness_services
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The service business requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the business service.
stringThe user-provided description of the business service.
string (url)a URL at which the entity is uniquely displayed in the Web app
stringThe point of contact assigned to this service.
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
objectReference to the team that owns the business service. (title: Team)
stringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.
+ + + +A paginated array of services. + + + + + + + + + + + +
NameDatatypeDescription
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.read`
Accept, Content-Type, limit, offset, totalList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.read`
Accept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.write`
idAccept, Content-TypeDelete 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.write`
Accept, Content-Type, limit, offset, totalList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.read`
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.read`
idAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
integerThe number of results per page.
integerOffset to start pagination search results.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.read`
+ +```sql +SELECT +id, +name, +description, +html_url, +point_of_contact, +self, +summary, +team, +type +FROM pagerduty.business_services.business_services +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.read`
+ +```sql +SELECT +* +FROM pagerduty.business_services.business_services +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.write`
+ +```sql +INSERT INTO pagerduty.business_services.business_services ( +data__business_service, +Accept, +Content-Type +) +SELECT +'{{ business_service }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +business_service +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: business_services + props: + - name: business_service + value: object + description: | + The Business Service to be created + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.write`
+ +```sql +DELETE FROM pagerduty.business_services.business_services +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.read`
+ +```sql +EXEC pagerduty.business_services.business_services._list_business_services +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }} +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.read`
+ +```sql +EXEC pagerduty.business_services.business_services._get_business_service +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.write`
+ +```sql +EXEC pagerduty.business_services.business_services.update_business_service +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"business_service": "{{ business_service }}" +}' +; +``` + + diff --git a/website/docs/services/business_services/impactors/index.md b/website/docs/services/business_services/impactors/index.md new file mode 100644 index 0000000..4103780 --- /dev/null +++ b/website/docs/services/business_services/impactors/index.md @@ -0,0 +1,175 @@ +--- +title: impactors +hide_title: false +hide_table_of_contents: false +keywords: + - impactors + - business_services + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an impactors resource. + +## Overview + + + + +
Nameimpactors
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe kind of object that is impacting
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
X-EARLY-ACCESSAccept, ids[]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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
X-EARLY-ACCESSAccept, ids[]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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!
stringThe `Accept` header is used as a versioning header.
stringThe IDs of the resources.
+ +## `SELECT` examples + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +SELECT +id, +type +FROM pagerduty.business_services.impactors +WHERE X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND Accept = '{{ Accept }}' +AND ids[] = '{{ ids[] }}' +; +``` + + + + +## Lifecycle Methods + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +EXEC pagerduty.business_services.impactors._get_business_service_top_level_impactors +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@Accept='{{ Accept }}', +@ids[]='{{ ids[] }}' +; +``` + + diff --git a/website/docs/services/business_services/impacts/index.md b/website/docs/services/business_services/impacts/index.md new file mode 100644 index 0000000..0a128be --- /dev/null +++ b/website/docs/services/business_services/impacts/index.md @@ -0,0 +1,200 @@ +--- +title: impacts +hide_title: false +hide_table_of_contents: false +keywords: + - impacts + - business_services + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an impacts resource. + +## Overview + + + + +
Nameimpacts
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
stringThe current impact status of the object
stringThe kind of object that has been impacted
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
X-EARLY-ACCESSAccept, additional_fields[], ids[]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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
X-EARLY-ACCESSAccept, additional_fields[], ids[]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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!
stringThe `Accept` header is used as a versioning header.
stringProvides access to additional fields such as highest priority per business service and total impacted count
stringThe IDs of the resources.
+ +## `SELECT` examples + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +SELECT +id, +name, +additional_fields, +status, +type +FROM pagerduty.business_services.impacts +WHERE X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND Accept = '{{ Accept }}' +AND additional_fields[] = '{{ additional_fields[] }}' +AND ids[] = '{{ ids[] }}' +; +``` + + + + +## Lifecycle Methods + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +EXEC pagerduty.business_services.impacts._get_business_service_impacts +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@Accept='{{ Accept }}', +@additional_fields[]='{{ additional_fields[] }}', +@ids[]='{{ ids[] }}' +; +``` + + diff --git a/website/docs/services/business_services/index.md b/website/docs/services/business_services/index.md new file mode 100644 index 0000000..ae9c445 --- /dev/null +++ b/website/docs/services/business_services/index.md @@ -0,0 +1,38 @@ +--- +title: business_services +hide_title: false +hide_table_of_contents: false +keywords: + - business_services + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +business_services service documentation. + +:::info[Service Summary] + +total resources: __7__ + +::: + +## Resources +
+
+account_subscription
+business_services
+impactors
+impacts +
+
+priority_thresholds
+subscribers
+supporting_services_impacts +
+
\ No newline at end of file diff --git a/website/docs/services/business_services/priority_thresholds/index.md b/website/docs/services/business_services/priority_thresholds/index.md new file mode 100644 index 0000000..fa33306 --- /dev/null +++ b/website/docs/services/business_services/priority_thresholds/index.md @@ -0,0 +1,220 @@ +--- +title: priority_thresholds +hide_title: false +hide_table_of_contents: false +keywords: + - priority_thresholds + - business_services + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a priority_thresholds resource. + +## Overview + + + + +
Namepriority_thresholds
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
integer
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
X-EARLY-ACCESSAcceptRetrieves 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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
X-EARLY-ACCESSAcceptClears 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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
X-EARLY-ACCESSAcceptRetrieves 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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
X-EARLY-ACCESS, global_thresholdAcceptSet the Account-level priority threshold for Business Service.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!
stringThe `Accept` header is used as a versioning header.
+ +## `SELECT` examples + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +SELECT +id, +order +FROM pagerduty.business_services.priority_thresholds +WHERE X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND Accept = '{{ Accept }}' +; +``` + + + + +## `DELETE` examples + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +DELETE FROM pagerduty.business_services.priority_thresholds +WHERE X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' --required +AND Accept = '{{ Accept }}' +; +``` + + + + +## Lifecycle Methods + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +EXEC pagerduty.business_services.priority_thresholds._get_business_service_priority_thresholds +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@Accept='{{ Accept }}' +; +``` + + + +Set the Account-level priority threshold for Business Service.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +EXEC pagerduty.business_services.priority_thresholds.put_business_service_priority_thresholds +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@Accept='{{ Accept }}' +@@json= +'{ +"global_threshold": "{{ global_threshold }}" +}' +; +``` + + diff --git a/website/docs/services/business_services/subscribers/index.md b/website/docs/services/business_services/subscribers/index.md new file mode 100644 index 0000000..7a6689c --- /dev/null +++ b/website/docs/services/business_services/subscribers/index.md @@ -0,0 +1,222 @@ +--- +title: subscribers +hide_title: false +hide_table_of_contents: false +keywords: + - subscribers + - business_services + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a subscribers resource. + +## Overview + + + + +
Namesubscribers
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the entity being subscribed
stringThe type of the entity being subscribed
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAcceptRetrieve 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`
id, data__subscribersAcceptSubscribe the given entities to the given Business Service.

Scoped OAuth requires: `subscribers.write`
idAcceptRetrieve 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`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
+ +## `SELECT` examples + + + + +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`
+ +```sql +SELECT +subscriber_id, +subscriber_type +FROM pagerduty.business_services.subscribers +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +; +``` + + + + +## `INSERT` examples + + + + +Subscribe the given entities to the given Business Service.

Scoped OAuth requires: `subscribers.write`
+ +```sql +INSERT INTO pagerduty.business_services.subscribers ( +data__subscribers, +id, +Accept +) +SELECT +'{{ subscribers }}' /* required */, +'{{ id }}', +'{{ Accept }}' +RETURNING +subscriptions +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: subscribers + props: + - name: id + value: string + description: Required parameter for the subscribers resource. + - name: subscribers + value: array + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. +``` + + + + +## Lifecycle Methods + + + + +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`
+ +```sql +EXEC pagerduty.business_services.subscribers._get_business_service_subscribers +@id='{{ id }}' --required, +@Accept='{{ Accept }}' +; +``` + + diff --git a/website/docs/services/business_services/supporting_services_impacts/index.md b/website/docs/services/business_services/supporting_services_impacts/index.md new file mode 100644 index 0000000..30cd277 --- /dev/null +++ b/website/docs/services/business_services/supporting_services_impacts/index.md @@ -0,0 +1,207 @@ +--- +title: supporting_services_impacts +hide_title: false +hide_table_of_contents: false +keywords: + - supporting_services_impacts + - business_services + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a supporting_services_impacts resource. + +## Overview + + + + +
Namesupporting_services_impacts
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
stringThe current impact status of the object
stringThe kind of object that has been impacted
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, X-EARLY-ACCESSAccept, additional_fields[], ids[]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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
id, X-EARLY-ACCESSAccept, additional_fields[], ids[]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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
stringProvides access to additional fields such as highest priority per business service and total impacted count
stringThe IDs of the resources.
+ +## `SELECT` examples + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +SELECT +id, +name, +additional_fields, +status, +type +FROM pagerduty.business_services.supporting_services_impacts +WHERE id = '{{ id }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND Accept = '{{ Accept }}' +AND additional_fields[] = '{{ additional_fields[] }}' +AND ids[] = '{{ ids[] }}' +; +``` + + + + +## Lifecycle Methods + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +EXEC pagerduty.business_services.supporting_services_impacts._get_business_service_supporting_service_impacts +@id='{{ id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@Accept='{{ Accept }}', +@additional_fields[]='{{ additional_fields[] }}', +@ids[]='{{ ids[] }}' +; +``` + + diff --git a/website/docs/services/change_events/change_events/index.md b/website/docs/services/change_events/change_events/index.md new file mode 100644 index 0000000..6092b37 --- /dev/null +++ b/website/docs/services/change_events/change_events/index.md @@ -0,0 +1,497 @@ +--- +title: change_events +hide_title: false +hide_table_of_contents: false +keywords: + - change_events + - change_events + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a change_events resource. + +## Overview + + + + +
Namechange_events
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The Change Event requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectAdditional details about the change event. (title: Custom Details)
string (url)a URL at which the entity is uniquely displayed in the Web app
array
object
arrayList of links to include.
stringThis is the 32 character Integration Key for an Integration on a Service. The same Integration Key can be used for both alert and change events. (title: Routing Key)
string (url)the API show URL at which the object is accessible
arrayAn array containing Service objects that this change event is associated with.
stringThe unique name of the location where the Change Event occurred.
stringA brief text summary of the event. Displayed in PagerDuty to provide information about the change. The maximum permitted length of this property is 1024 characters.
string (date-time)The time at which the emitting tool detected or generated the event.
stringThe type of object being created. (default: change_event)
+ + + +The array of Change Events returned by the query. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectAdditional details about the change event. (title: Custom Details)
string (url)a URL at which the entity is uniquely displayed in the Web app
array
object
arrayList of links to include.
stringThis is the 32 character Integration Key for an Integration on a Service. The same Integration Key can be used for both alert and change events. (title: Routing Key)
string (url)the API show URL at which the object is accessible
arrayAn array containing Service objects that this change event is associated with.
stringThe unique name of the location where the Change Event occurred.
stringA brief text summary of the event. Displayed in PagerDuty to provide information about the change. The maximum permitted length of this property is 1024 characters.
string (date-time)The time at which the emitting tool detected or generated the event.
stringThe type of object being created. (default: change_event)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet details about an existing Change Event.

Scoped OAuth requires: `change_events.read`
limit, offset, total, Accept, Content-Type, team_ids[], integration_ids[], since, untilList all of the existing Change Events.

Scoped OAuth requires: `change_events.read`
Accept, Content-TypeSending 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).
limit, offset, total, Accept, Content-Type, team_ids[], integration_ids[], since, untilList all of the existing Change Events.

Scoped OAuth requires: `change_events.read`
idAccept, Content-TypeGet details about an existing Change Event.

Scoped OAuth requires: `change_events.read`
id, change_eventAccept, Content-TypeUpdate an existing Change Event

Scoped OAuth requires: `change_events.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
arrayAn array of integration IDs. Only results related to these integrations will be returned.
integerThe number of results per page.
integerOffset to start pagination search results.
string (date-time)The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.
arrayAn array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
string (date-time)The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.
+ +## `SELECT` examples + + + + +Get details about an existing Change Event.

Scoped OAuth requires: `change_events.read`
+ +```sql +SELECT +id, +custom_details, +html_url, +images, +integration, +links, +routing_key, +self, +services, +source, +summary, +timestamp, +type +FROM pagerduty.change_events.change_events +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +List all of the existing Change Events.

Scoped OAuth requires: `change_events.read`
+ +```sql +SELECT +id, +custom_details, +html_url, +images, +integration, +links, +routing_key, +self, +services, +source, +summary, +timestamp, +type +FROM pagerduty.change_events.change_events +WHERE limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND team_ids[] = '{{ team_ids[] }}' +AND integration_ids[] = '{{ integration_ids[] }}' +AND since = '{{ since }}' +AND until = '{{ until }}' +; +``` + + + + +## `INSERT` examples + + + + +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).
+ +```sql +INSERT INTO pagerduty.change_events.change_events ( +Accept, +Content-Type +) +SELECT +'{{ Accept }}', +'{{ Content-Type }}' +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: change_events + props: + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## Lifecycle Methods + + + + +List all of the existing Change Events.

Scoped OAuth requires: `change_events.read`
+ +```sql +EXEC pagerduty.change_events.change_events._list_change_events +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@team_ids[]='{{ team_ids[] }}', +@integration_ids[]='{{ integration_ids[] }}', +@since='{{ since }}', +@until='{{ until }}' +; +``` + + + +Get details about an existing Change Event.

Scoped OAuth requires: `change_events.read`
+ +```sql +EXEC pagerduty.change_events.change_events._get_change_event +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +Update an existing Change Event

Scoped OAuth requires: `change_events.write`
+ +```sql +EXEC pagerduty.change_events.change_events.update_change_event +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"change_event": "{{ change_event }}" +}' +; +``` + + diff --git a/website/docs/services/change_events/incidents_related_change_events/index.md b/website/docs/services/change_events/incidents_related_change_events/index.md new file mode 100644 index 0000000..7274f96 --- /dev/null +++ b/website/docs/services/change_events/incidents_related_change_events/index.md @@ -0,0 +1,256 @@ +--- +title: incidents_related_change_events +hide_title: false +hide_table_of_contents: false +keywords: + - incidents_related_change_events + - change_events + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an incidents_related_change_events resource. + +## Overview + + + + +
Nameincidents_related_change_events
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The array of Change Events returned by the query. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
objectAdditional details about the change event. (title: Custom Details)
string (url)a URL at which the entity is uniquely displayed in the Web app
array
object
arrayList of links to include.
stringThis is the 32 character Integration Key for an Integration on a Service. The same Integration Key can be used for both alert and change events. (title: Routing Key)
string (url)the API show URL at which the object is accessible
arrayAn array containing Service objects that this change event is associated with.
stringThe unique name of the location where the Change Event occurred.
stringA brief text summary of the event. Displayed in PagerDuty to provide information about the change. The maximum permitted length of this property is 1024 characters.
string (date-time)The time at which the emitting tool detected or generated the event.
stringThe type of object being created. (default: change_event)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idlimit, Accept, Content-TypeList 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`
idlimit, Accept, Content-TypeList 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`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
integerThe number of results per page.
+ +## `SELECT` examples + + + + +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`
+ +```sql +SELECT +id, +correlation_reason, +custom_details, +html_url, +images, +integration, +links, +routing_key, +self, +services, +source, +summary, +timestamp, +type +FROM pagerduty.change_events.incidents_related_change_events +WHERE id = '{{ id }}' -- required +AND limit = '{{ limit }}' +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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`
+ +```sql +EXEC pagerduty.change_events.incidents_related_change_events._list_incident_related_change_events +@id='{{ id }}' --required, +@limit='{{ limit }}', +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/change_events/index.md b/website/docs/services/change_events/index.md new file mode 100644 index 0000000..60411a9 --- /dev/null +++ b/website/docs/services/change_events/index.md @@ -0,0 +1,34 @@ +--- +title: change_events +hide_title: false +hide_table_of_contents: false +keywords: + - change_events + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +change_events service documentation. + +:::info[Service Summary] + +total resources: __3__ + +::: + +## Resources +
+
+change_events
+incidents_related_change_events +
+
+services +
+
\ No newline at end of file diff --git a/website/docs/services/change_events/services/index.md b/website/docs/services/change_events/services/index.md new file mode 100644 index 0000000..0a00441 --- /dev/null +++ b/website/docs/services/change_events/services/index.md @@ -0,0 +1,292 @@ +--- +title: services +hide_title: false +hide_table_of_contents: false +keywords: + - services + - change_events + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a services resource. + +## Overview + + + + +
Nameservices
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The array of Change Events returned by the query. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectAdditional details about the change event. (title: Custom Details)
string (url)a URL at which the entity is uniquely displayed in the Web app
array
object
arrayList of links to include.
stringThis is the 32 character Integration Key for an Integration on a Service. The same Integration Key can be used for both alert and change events. (title: Routing Key)
string (url)the API show URL at which the object is accessible
arrayAn array containing Service objects that this change event is associated with.
stringThe unique name of the location where the Change Event occurred.
stringA brief text summary of the event. Displayed in PagerDuty to provide information about the change. The maximum permitted length of this property is 1024 characters.
string (date-time)The time at which the emitting tool detected or generated the event.
stringThe type of object being created. (default: change_event)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idsince, until, limit, offset, total, Accept, Content-Type, team_ids[], integration_ids[]List all of the existing Change Events for a service.

Scoped OAuth requires: `services.read`
idsince, until, limit, offset, total, Accept, Content-Type, team_ids[], integration_ids[]List all of the existing Change Events for a service.

Scoped OAuth requires: `services.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
arrayAn array of integration IDs. Only results related to these integrations will be returned.
integerThe number of results per page.
integerOffset to start pagination search results.
string (date-time)The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.
arrayAn array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
string (date-time)The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.
+ +## `SELECT` examples + + + + +List all of the existing Change Events for a service.

Scoped OAuth requires: `services.read`
+ +```sql +SELECT +id, +custom_details, +html_url, +images, +integration, +links, +routing_key, +self, +services, +source, +summary, +timestamp, +type +FROM pagerduty.change_events.services +WHERE id = '{{ id }}' -- required +AND since = '{{ since }}' +AND until = '{{ until }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND team_ids[] = '{{ team_ids[] }}' +AND integration_ids[] = '{{ integration_ids[] }}' +; +``` + + + + +## Lifecycle Methods + + + + +List all of the existing Change Events for a service.

Scoped OAuth requires: `services.read`
+ +```sql +EXEC pagerduty.change_events.services._list_service_change_events +@id='{{ id }}' --required, +@since='{{ since }}', +@until='{{ until }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@team_ids[]='{{ team_ids[] }}', +@integration_ids[]='{{ integration_ids[] }}' +; +``` + + diff --git a/website/docs/services/custom_fields/customfields_fields/index.md b/website/docs/services/custom_fields/customfields_fields/index.md new file mode 100644 index 0000000..e95d0cc --- /dev/null +++ b/website/docs/services/custom_fields/customfields_fields/index.md @@ -0,0 +1,487 @@ +--- +title: customfields_fields +hide_title: false +hide_table_of_contents: false +keywords: + - customfields_fields + - custom_fields + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a customfields_fields resource. + +## Overview + + + + +
Namecustomfields_fields
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The field requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe human-readable name of the field. This must be unique across an account.
string (date-time)The date/time the object was created at.
stringThe kind of data the custom field is allowed to contain.
stringA description of the data this field contains.
arrayThe fixed list of value options that may be stored in this field.
booleanIf `true`, restricts the values allowed to be stored in the custom field to a limited set of options (configured via the Field Option sub-resource). Must be `false` if `datatype` is "boolean", "url", or "datetime"
booleanIf `true`, allows the custom field to store a set of multiple values. Must be `false` if `datatype` is not "string" or "url"
string (url)The API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
string
string (date-time)The date/time the object was last updated.
+ + + +A paginated list of fields. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe human-readable name of the field. This must be unique across an account.
string (date-time)The date/time the object was created at.
stringThe kind of data the custom field is allowed to contain.
stringA description of the data this field contains.
arrayThe fixed list of value options that may be stored in this field.
booleanIf `true`, restricts the values allowed to be stored in the custom field to a limited set of options (configured via the Field Option sub-resource). Must be `false` if `datatype` is "boolean", "url", or "datetime"
booleanIf `true`, allows the custom field to store a set of multiple values. Must be `false` if `datatype` is not "string" or "url"
string (url)The API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
string
string (date-time)The date/time the object was last updated.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
field_id, X-EARLY-ACCESSinclude[]Show detailed information about a field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
X-EARLY-ACCESSlimit, offset, total, include[]List fields.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
X-EARLY-ACCESS, data__fieldCreate a new Field, along with the Field Options if provided. An account may have up to 1000 Fields.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
field_id, X-EARLY-ACCESSDelete a Field. Fields may not be deleted if they are used by a Field Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
X-EARLY-ACCESSlimit, offset, total, include[]List fields.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
field_id, X-EARLY-ACCESSinclude[]Show detailed information about a field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
field_id, X-EARLY-ACCESS, fieldUpdate a field.

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change!
stringThe ID of the field.
stringArray of additional details to include.
integerThe number of results per page.
integerOffset to start pagination search results.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +Show detailed information about a field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +SELECT +id, +display_name, +created_at, +datatype, +description, +field_options, +fixed_options, +multi_value, +self, +summary, +type, +updated_at +FROM pagerduty.custom_fields.customfields_fields +WHERE field_id = '{{ field_id }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND include[] = '{{ include[] }}' +; +``` + + + +List fields.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +SELECT +id, +display_name, +created_at, +datatype, +description, +field_options, +fixed_options, +multi_value, +self, +summary, +type, +updated_at +FROM pagerduty.custom_fields.customfields_fields +WHERE X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND include[] = '{{ include[] }}' +; +``` + + + + +## `INSERT` examples + + + + +Create a new Field, along with the Field Options if provided. An account may have up to 1000 Fields.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +INSERT INTO pagerduty.custom_fields.customfields_fields ( +data__field, +X-EARLY-ACCESS +) +SELECT +'{{ field }}' /* required */, +'{{ X-EARLY-ACCESS }}' +RETURNING +field +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: customfields_fields + props: + - name: X-EARLY-ACCESS + value: string + description: Required parameter for the customfields_fields resource. + - name: field + value: object +``` + + + + +## `DELETE` examples + + + + +Delete a Field. Fields may not be deleted if they are used by a Field Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +DELETE FROM pagerduty.custom_fields.customfields_fields +WHERE field_id = '{{ field_id }}' --required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +List fields.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.custom_fields.customfields_fields._list_custom_fields_fields +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@include[]='{{ include[] }}' +; +``` + + + +Show detailed information about a field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.custom_fields.customfields_fields._get_custom_fields_field +@field_id='{{ field_id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@include[]='{{ include[] }}' +; +``` + + + +Update a field.

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.custom_fields.customfields_fields.update_custom_fields_field +@field_id='{{ field_id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required +@@json= +'{ +"field": "{{ field }}" +}' +; +``` + + diff --git a/website/docs/services/custom_fields/customfields_fields_field_options/index.md b/website/docs/services/custom_fields/customfields_fields_field_options/index.md new file mode 100644 index 0000000..f838387 --- /dev/null +++ b/website/docs/services/custom_fields/customfields_fields_field_options/index.md @@ -0,0 +1,389 @@ +--- +title: customfields_fields_field_options +hide_title: false +hide_table_of_contents: false +keywords: + - customfields_fields_field_options + - custom_fields + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a customfields_fields_field_options resource. + +## Overview + + + + +
Namecustomfields_fields_field_options
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The field option requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
string (date-time)The date/time the object was created at.
string
string (date-time)The date/time the object was last updated.
+ + + +A list of field options. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
string (date-time)The date/time the object was created at.
string
string (date-time)The date/time the object was last updated.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
field_id, field_option_id, X-EARLY-ACCESSGet a Field Option.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
field_id, X-EARLY-ACCESSList all enabled Field Options for a Field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
field_id, X-EARLY-ACCESS, data__field_optionCreate a new Field Option. Field Options may only be created for Fields where `fixed_options` is `true`. A Field may have no more than 10 enabled options.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
field_id, field_option_id, X-EARLY-ACCESSDelete a Field Option.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
field_id, X-EARLY-ACCESSList all enabled Field Options for a Field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
field_id, field_option_id, X-EARLY-ACCESSGet a Field Option.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
field_id, field_option_id, X-EARLY-ACCESS, field_optionUpdate Field Option for a Field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change!
stringThe ID of the field.
stringThe ID of the field option.
+ +## `SELECT` examples + + + + +Get a Field Option.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +SELECT +id, +created_at, +data, +type, +updated_at +FROM pagerduty.custom_fields.customfields_fields_field_options +WHERE field_id = '{{ field_id }}' -- required +AND field_option_id = '{{ field_option_id }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +; +``` + + + +List all enabled Field Options for a Field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +SELECT +id, +created_at, +data, +type, +updated_at +FROM pagerduty.custom_fields.customfields_fields_field_options +WHERE field_id = '{{ field_id }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Create a new Field Option. Field Options may only be created for Fields where `fixed_options` is `true`. A Field may have no more than 10 enabled options.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +INSERT INTO pagerduty.custom_fields.customfields_fields_field_options ( +data__field_option, +field_id, +X-EARLY-ACCESS +) +SELECT +'{{ field_option }}' /* required */, +'{{ field_id }}', +'{{ X-EARLY-ACCESS }}' +RETURNING +field_option +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: customfields_fields_field_options + props: + - name: field_id + value: string + description: Required parameter for the customfields_fields_field_options resource. + - name: X-EARLY-ACCESS + value: string + description: Required parameter for the customfields_fields_field_options resource. + - name: field_option + value: object +``` + + + + +## `DELETE` examples + + + + +Delete a Field Option.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +DELETE FROM pagerduty.custom_fields.customfields_fields_field_options +WHERE field_id = '{{ field_id }}' --required +AND field_option_id = '{{ field_option_id }}' --required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +List all enabled Field Options for a Field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.custom_fields.customfields_fields_field_options._list_custom_fields_field_options +@field_id='{{ field_id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required +; +``` + + + +Get a Field Option.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.custom_fields.customfields_fields_field_options._get_custom_fields_field_option +@field_id='{{ field_id }}' --required, +@field_option_id='{{ field_option_id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required +; +``` + + + +Update Field Option for a Field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.custom_fields.customfields_fields_field_options.update_custom_fields_field_option +@field_id='{{ field_id }}' --required, +@field_option_id='{{ field_option_id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required +@@json= +'{ +"field_option": "{{ field_option }}" +}' +; +``` + + diff --git a/website/docs/services/custom_fields/field_configurations/index.md b/website/docs/services/custom_fields/field_configurations/index.md new file mode 100644 index 0000000..8f28e1a --- /dev/null +++ b/website/docs/services/custom_fields/field_configurations/index.md @@ -0,0 +1,422 @@ +--- +title: field_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - field_configurations + - custom_fields + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a field_configurations resource. + +## Overview + + + + +
Namefield_configurations
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The field configuration requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
string (date-time)The date/time the object was created at.
objectThe value to use for this field if none is provided. It must be specified if `required` is `true`.
The Field to be included in this schema. Each Field may only be used in one Field Configuration per schema.
booleanIf `true`, this Field must always have a value set for objects using this schema.
string
string (date-time)The date/time the object was last updated.
+ + + +A list of field configurations in the schema. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
string (date-time)The date/time the object was created at.
objectThe value to use for this field if none is provided. It must be specified if `required` is `true`.
The Field to be included in this schema. Each Field may only be used in one Field Configuration per schema.
booleanIf `true`, this Field must always have a value set for objects using this schema.
string
string (date-time)The date/time the object was last updated.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
schema_id, field_configuration_id, X-EARLY-ACCESSinclude[]Show detailed information about a Field Configuration.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
schema_id, X-EARLY-ACCESSinclude[]List all Field Configurations for the given Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
schema_id, X-EARLY-ACCESS, data__field_configurationAdd a new Field Configuration to an existing Schema. A Schema may use at most 20 Fields, and so may have at most 20 Field Configurations.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
schema_id, field_configuration_id, X-EARLY-ACCESSRemove a Field Configuration and its associated Field from a Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
schema_id, X-EARLY-ACCESSinclude[]List all Field Configurations for the given Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
schema_id, field_configuration_id, X-EARLY-ACCESSinclude[]Show detailed information about a Field Configuration.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
schema_id, field_configuration_id, X-EARLY-ACCESS, field_configurationUpdate settings for Field Configuration in Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change!
stringThe ID of the field configuration.
stringThe ID of the schema.
stringArray of additional details to include.
+ +## `SELECT` examples + + + + +Show detailed information about a Field Configuration.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +SELECT +id, +created_at, +default_value, +field, +required, +type, +updated_at +FROM pagerduty.custom_fields.field_configurations +WHERE schema_id = '{{ schema_id }}' -- required +AND field_configuration_id = '{{ field_configuration_id }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND include[] = '{{ include[] }}' +; +``` + + + +List all Field Configurations for the given Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +SELECT +id, +created_at, +default_value, +field, +required, +type, +updated_at +FROM pagerduty.custom_fields.field_configurations +WHERE schema_id = '{{ schema_id }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND include[] = '{{ include[] }}' +; +``` + + + + +## `INSERT` examples + + + + +Add a new Field Configuration to an existing Schema. A Schema may use at most 20 Fields, and so may have at most 20 Field Configurations.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +INSERT INTO pagerduty.custom_fields.field_configurations ( +data__field_configuration, +schema_id, +X-EARLY-ACCESS +) +SELECT +'{{ field_configuration }}' /* required */, +'{{ schema_id }}', +'{{ X-EARLY-ACCESS }}' +RETURNING +field_configuration +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: field_configurations + props: + - name: schema_id + value: string + description: Required parameter for the field_configurations resource. + - name: X-EARLY-ACCESS + value: string + description: Required parameter for the field_configurations resource. + - name: field_configuration + value: object +``` + + + + +## `DELETE` examples + + + + +Remove a Field Configuration and its associated Field from a Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +DELETE FROM pagerduty.custom_fields.field_configurations +WHERE schema_id = '{{ schema_id }}' --required +AND field_configuration_id = '{{ field_configuration_id }}' --required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +List all Field Configurations for the given Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.custom_fields.field_configurations._list_custom_fields_field_configurations +@schema_id='{{ schema_id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@include[]='{{ include[] }}' +; +``` + + + +Show detailed information about a Field Configuration.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.custom_fields.field_configurations._get_custom_fields_field_configuration +@schema_id='{{ schema_id }}' --required, +@field_configuration_id='{{ field_configuration_id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@include[]='{{ include[] }}' +; +``` + + + +Update settings for Field Configuration in Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.custom_fields.field_configurations.update_custom_fields_field_configuration +@schema_id='{{ schema_id }}' --required, +@field_configuration_id='{{ field_configuration_id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required +@@json= +'{ +"field_configuration": "{{ field_configuration }}" +}' +; +``` + + diff --git a/website/docs/services/custom_fields/fields_schemas/index.md b/website/docs/services/custom_fields/fields_schemas/index.md new file mode 100644 index 0000000..ab37061 --- /dev/null +++ b/website/docs/services/custom_fields/fields_schemas/index.md @@ -0,0 +1,227 @@ +--- +title: fields_schemas +hide_title: false +hide_table_of_contents: false +keywords: + - fields_schemas + - custom_fields + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a fields_schemas resource. + +## Overview + + + + +
Namefields_schemas
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +A paginated list of schemas using the field. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
string (date-time)The date/time the object was created at.
stringA description of this schema.
string (url)The API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
stringThe name of the schema.
string
string (date-time)The date/time the object was last updated.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
field_id, X-EARLY-ACCESSlimit, offset, totalList all Schemas using the Field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
field_id, X-EARLY-ACCESSlimit, offset, totalList all Schemas using the Field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change!
stringThe ID of the field.
integerThe number of results per page.
integerOffset to start pagination search results.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +List all Schemas using the Field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +SELECT +id, +created_at, +description, +self, +summary, +title, +type, +updated_at +FROM pagerduty.custom_fields.fields_schemas +WHERE field_id = '{{ field_id }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +; +``` + + + + +## Lifecycle Methods + + + + +List all Schemas using the Field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.custom_fields.fields_schemas._list_custom_fields_schemas_using_field +@field_id='{{ field_id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }} +; +``` + + diff --git a/website/docs/services/custom_fields/index.md b/website/docs/services/custom_fields/index.md new file mode 100644 index 0000000..6fa4e0e --- /dev/null +++ b/website/docs/services/custom_fields/index.md @@ -0,0 +1,37 @@ +--- +title: custom_fields +hide_title: false +hide_table_of_contents: false +keywords: + - custom_fields + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +custom_fields service documentation. + +:::info[Service Summary] + +total resources: __6__ + +::: + +## Resources +
+
+customfields_fields
+customfields_fields_field_options
+field_configurations +
+
+fields_schemas
+schema_assignments
+schemas +
+
\ No newline at end of file diff --git a/website/docs/services/custom_fields/schema_assignments/index.md b/website/docs/services/custom_fields/schema_assignments/index.md new file mode 100644 index 0000000..30f0409 --- /dev/null +++ b/website/docs/services/custom_fields/schema_assignments/index.md @@ -0,0 +1,298 @@ +--- +title: schema_assignments +hide_title: false +hide_table_of_contents: false +keywords: + - schema_assignments + - custom_fields + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a schema_assignments resource. + +## Overview + + + + +
Nameschema_assignments
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The list of Assignments + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
string (date-time)The date/time the object was created at.
object
object
stringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.
string (date-time)The date/time the object was last updated.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
filter, X-EARLY-ACCESSlimit, offset, totalList Schema Assignments by `service_id` or `schema_id`

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
X-EARLY-ACCESS, data__schema_assignmentAssign a new Schema to a service

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
id, X-EARLY-ACCESSRemove the Schema assigned to a service

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
filter, X-EARLY-ACCESSlimit, offset, totalList Schema Assignments by `service_id` or `schema_id`

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change!
objectOne of service_id or schema_id is required.
stringThe ID of the resource.
integerThe number of results per page.
integerOffset to start pagination search results.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +List Schema Assignments by `service_id` or `schema_id`

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +SELECT +id, +created_at, +schema, +service, +type, +updated_at +FROM pagerduty.custom_fields.schema_assignments +WHERE filter = '{{ filter }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +; +``` + + + + +## `INSERT` examples + + + + +Assign a new Schema to a service

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +INSERT INTO pagerduty.custom_fields.schema_assignments ( +data__schema_assignment, +X-EARLY-ACCESS +) +SELECT +'{{ schema_assignment }}' /* required */, +'{{ X-EARLY-ACCESS }}' +RETURNING +schema_assignment +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: schema_assignments + props: + - name: X-EARLY-ACCESS + value: string + description: Required parameter for the schema_assignments resource. + - name: schema_assignment + value: object +``` + + + + +## `DELETE` examples + + + + +Remove the Schema assigned to a service

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +DELETE FROM pagerduty.custom_fields.schema_assignments +WHERE id = '{{ id }}' --required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +List Schema Assignments by `service_id` or `schema_id`

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.custom_fields.schema_assignments._list_schema_assignments +@filter='{{ filter }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }} +; +``` + + diff --git a/website/docs/services/custom_fields/schemas/index.md b/website/docs/services/custom_fields/schemas/index.md new file mode 100644 index 0000000..545dda8 --- /dev/null +++ b/website/docs/services/custom_fields/schemas/index.md @@ -0,0 +1,443 @@ +--- +title: schemas +hide_title: false +hide_table_of_contents: false +keywords: + - schemas + - custom_fields + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a schemas resource. + +## Overview + + + + +
Nameschemas
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The schema requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
string (date-time)The date/time the object was created at.
stringA description of this schema.
array
string (url)The API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
stringThe name of the schema.
string
string (date-time)The date/time the object was last updated.
+ + + +A paginated list of schemas. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
string (date-time)The date/time the object was created at.
stringA description of this schema.
string (url)The API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
stringThe name of the schema.
string
string (date-time)The date/time the object was last updated.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
schema_id, X-EARLY-ACCESSinclude[]Get detailed information about a Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
X-EARLY-ACCESSlimit, offset, totalList all Schemas.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
X-EARLY-ACCESS, data__schemaCreate a new Schema, along with the Field Configurations if provided. An account may have up to 100 Schemas.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
schema_id, X-EARLY-ACCESSDelete a Schema. Schemas may not be deleted if they are in use by any Service.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
X-EARLY-ACCESSlimit, offset, totalList all Schemas.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
schema_id, X-EARLY-ACCESSinclude[]Get detailed information about a Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
schema_id, X-EARLY-ACCESS, schemaUpdate a Schema, along with the Field Configurations if provided.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change!
stringThe ID of the schema.
stringArray of additional details to include. Including `field_configurations` will also include full field details.
integerThe number of results per page.
integerOffset to start pagination search results.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +Get detailed information about a Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +SELECT +id, +created_at, +description, +field_configurations, +self, +summary, +title, +type, +updated_at +FROM pagerduty.custom_fields.schemas +WHERE schema_id = '{{ schema_id }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND include[] = '{{ include[] }}' +; +``` + + + +List all Schemas.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +SELECT +id, +created_at, +description, +self, +summary, +title, +type, +updated_at +FROM pagerduty.custom_fields.schemas +WHERE X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +; +``` + + + + +## `INSERT` examples + + + + +Create a new Schema, along with the Field Configurations if provided. An account may have up to 100 Schemas.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +INSERT INTO pagerduty.custom_fields.schemas ( +data__schema, +X-EARLY-ACCESS +) +SELECT +'{{ schema }}' /* required */, +'{{ X-EARLY-ACCESS }}' +RETURNING +schema +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: schemas + props: + - name: X-EARLY-ACCESS + value: string + description: Required parameter for the schemas resource. + - name: schema + value: object +``` + + + + +## `DELETE` examples + + + + +Delete a Schema. Schemas may not be deleted if they are in use by any Service.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +DELETE FROM pagerduty.custom_fields.schemas +WHERE schema_id = '{{ schema_id }}' --required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +List all Schemas.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.custom_fields.schemas._list_custom_fields_schemas +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }} +; +``` + + + +Get detailed information about a Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.custom_fields.schemas._get_custom_fields_schema +@schema_id='{{ schema_id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@include[]='{{ include[] }}' +; +``` + + + +Update a Schema, along with the Field Configurations if provided.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.custom_fields.schemas.update_custom_fields_schema +@schema_id='{{ schema_id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required +@@json= +'{ +"schema": "{{ schema }}" +}' +; +``` + + diff --git a/website/docs/services/escalation_policies/audit_records/index.md b/website/docs/services/escalation_policies/audit_records/index.md new file mode 100644 index 0000000..db0b587 --- /dev/null +++ b/website/docs/services/escalation_policies/audit_records/index.md @@ -0,0 +1,247 @@ +--- +title: audit_records +hide_title: false +hide_table_of_contents: false +keywords: + - audit_records + - escalation_policies + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an audit_records resource. + +## Overview + + + + +
Nameaudit_records
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Records matching the query criteria. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (example: create)
array
objectAdditional details to provide further information about the action or the resource that has been audited.
objectAction execution context
string (date-time)The date/time the action executed, in ISO8601 format and millisecond precision.
objectThe method information
object
stringRecord URL.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, limit, cursor, since, untilThe 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`
idAccept, Content-Type, limit, cursor, since, untilThe 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`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringOptional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set.
integerThe minimum of the `limit` parameter used in the request or the maximum request size of the API.
string (date-time)The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)
string (date-time)The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.
+ +## `SELECT` 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`
+ +```sql +SELECT +id, +action, +actors, +details, +execution_context, +execution_time, +method, +root_resource, +self +FROM pagerduty.escalation_policies.audit_records +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND cursor = '{{ cursor }}' +AND since = '{{ since }}' +AND until = '{{ until }}' +; +``` + + + + +## Lifecycle Methods + + + + +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`
+ +```sql +EXEC pagerduty.escalation_policies.audit_records._list_escalation_policy_audit_records +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@cursor='{{ cursor }}', +@since='{{ since }}', +@until='{{ until }}' +; +``` + + diff --git a/website/docs/services/escalation_policies/escalation_policies/index.md b/website/docs/services/escalation_policies/escalation_policies/index.md new file mode 100644 index 0000000..4f457ca --- /dev/null +++ b/website/docs/services/escalation_policies/escalation_policies/index.md @@ -0,0 +1,540 @@ +--- +title: escalation_policies +hide_title: false +hide_table_of_contents: false +keywords: + - escalation_policies + - escalation_policies + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an escalation_policies resource. + +## Overview + + + + +
Nameescalation_policies
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The escalation policy object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the escalation policy.
stringEscalation policy description.
array
string (url)a URL at which the entity is uniquely displayed in the Web app
integerThe number of times the escalation policy will repeat after reaching the end of its escalation.
stringDetermines how on call handoff notifications will be sent for users on the escalation policy. Defaults to "if_has_services".
string (url)the API show URL at which the object is accessible
array
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
arrayTeam associated with the policy. Account must have the `teams` ability to use this parameter. Only one team may be associated with the policy.
stringThe type of object being created. (default: escalation_policy)
+ + + +A paginated array of escalation policy objects. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the escalation policy.
stringEscalation policy description.
array
string (url)a URL at which the entity is uniquely displayed in the Web app
integerThe number of times the escalation policy will repeat after reaching the end of its escalation.
stringDetermines how on call handoff notifications will be sent for users on the escalation policy. Defaults to "if_has_services".
string (url)the API show URL at which the object is accessible
array
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
arrayTeam associated with the policy. Account must have the `teams` ability to use this parameter. Only one team may be associated with the policy.
stringThe type of object being created. (default: escalation_policy)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.read`
limit, offset, total, Accept, Content-Type, query, user_ids[], team_ids[], include[], sort_byList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.read`
data__escalation_policyAccept, Content-Type, FromCreates 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.write`
idAccept, Content-TypeDeletes 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.write`
limit, offset, total, Accept, Content-Type, query, user_ids[], team_ids[], include[], sort_byList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.read`
idAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.read`
id, escalation_policyAccept, Content-TypeUpdates 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
string (email)The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.
stringArray of additional Models to include in response.
integerThe number of results per page.
integerOffset to start pagination search results.
stringFilters the result, showing only the records whose name matches the query.
stringUsed to specify the field you wish to sort the results on.
arrayAn array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
arrayFilters the results, showing only escalation policies on which any of the users is a target.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.read`
+ +```sql +SELECT +id, +name, +description, +escalation_rules, +html_url, +num_loops, +on_call_handoff_notifications, +self, +services, +summary, +teams, +type +FROM pagerduty.escalation_policies.escalation_policies +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND include[] = '{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.read`
+ +```sql +SELECT +id, +name, +description, +escalation_rules, +html_url, +num_loops, +on_call_handoff_notifications, +self, +services, +summary, +teams, +type +FROM pagerduty.escalation_policies.escalation_policies +WHERE limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND query = '{{ query }}' +AND user_ids[] = '{{ user_ids[] }}' +AND team_ids[] = '{{ team_ids[] }}' +AND include[] = '{{ include[] }}' +AND sort_by = '{{ sort_by }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.write`
+ +```sql +INSERT INTO pagerduty.escalation_policies.escalation_policies ( +data__escalation_policy, +Accept, +Content-Type, +From +) +SELECT +'{{ escalation_policy }}' /* required */, +'{{ Accept }}', +'{{ Content-Type }}', +'{{ From }}' +RETURNING +escalation_policy +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: escalation_policies + props: + - name: escalation_policy + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string + - name: From + value: string (email) + description: The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking. +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.write`
+ +```sql +DELETE FROM pagerduty.escalation_policies.escalation_policies +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.read`
+ +```sql +EXEC pagerduty.escalation_policies.escalation_policies._list_escalation_policies +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@query='{{ query }}', +@user_ids[]='{{ user_ids[] }}', +@team_ids[]='{{ team_ids[] }}', +@include[]='{{ include[] }}', +@sort_by='{{ sort_by }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.read`
+ +```sql +EXEC pagerduty.escalation_policies.escalation_policies._get_escalation_policy +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@include[]='{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.write`
+ +```sql +EXEC pagerduty.escalation_policies.escalation_policies.update_escalation_policy +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"escalation_policy": "{{ escalation_policy }}" +}' +; +``` + + diff --git a/website/docs/services/escalation_policies/index.md b/website/docs/services/escalation_policies/index.md new file mode 100644 index 0000000..c7109b5 --- /dev/null +++ b/website/docs/services/escalation_policies/index.md @@ -0,0 +1,33 @@ +--- +title: escalation_policies +hide_title: false +hide_table_of_contents: false +keywords: + - escalation_policies + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +escalation_policies service documentation. + +:::info[Service Summary] + +total resources: __2__ + +::: + +## Resources +
+
+audit_records +
+
+escalation_policies +
+
\ No newline at end of file diff --git a/website/docs/services/event_orchestrations/event_orchestrations/index.md b/website/docs/services/event_orchestrations/event_orchestrations/index.md new file mode 100644 index 0000000..0935354 --- /dev/null +++ b/website/docs/services/event_orchestrations/event_orchestrations/index.md @@ -0,0 +1,457 @@ +--- +title: event_orchestrations +hide_title: false +hide_table_of_contents: false +keywords: + - event_orchestrations + - event_orchestrations + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an event_orchestrations resource. + +## Overview + + + + +
Nameevent_orchestrations
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The Orchestration object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the Orchestration.
stringName of the Orchestration.
string (date-time)The date the Orchestration was created at.
objectReference to the user that has created the Orchestration.
stringA description of this Orchestration's purpose.
array
integerNumber of different Service Orchestration being routed to
string (url)The API show URL at which the object is accessible
objectReference to the team that owns the Orchestration. If none is specified, only admins have access.
string (date-time)The date the Orchestration was last updated.
objectReference to the user that has updated the Orchestration last.
stringVersion of the Orchestration.
+ + + +A paginated array of Event Orchestration objects. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the Orchestration.
stringName of the Orchestration.
string (date-time)The date the Orchestration was created at.
objectReference to the user that has created the Orchestration.
stringA description of this Orchestration's purpose.
integerNumber of different Service Orchestration being routed to
string (url)The API show URL at which the object is accessible
objectReference to the team that owns the Orchestration. If none is specified, only admins have access.
string (date-time)The date the Orchestration was last updated.
objectReference to the user that has updated the Orchestration last.
stringVersion of the Orchestration.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
Accept, Content-Type, limit, offset, sort_byList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
idAccept, Content-TypeDelete 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
Accept, Content-Type, limit, offset, sort_byList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
orchestrationAccept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
id, orchestrationAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of an Event Orchestration.
stringThe `Accept` header is used as a versioning header.
string
integerThe number of results per page.
integerOffset to start pagination search results.
stringUsed to specify the field you wish to sort the results on.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
+ +```sql +SELECT +id, +name, +created_at, +created_by, +description, +integrations, +routes, +self, +team, +updated_at, +updated_by, +version +FROM pagerduty.event_orchestrations.event_orchestrations +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
+ +```sql +SELECT +id, +name, +created_at, +created_by, +description, +routes, +self, +team, +updated_at, +updated_by, +version +FROM pagerduty.event_orchestrations.event_orchestrations +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND sort_by = '{{ sort_by }}' +; +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
+ +```sql +DELETE FROM pagerduty.event_orchestrations.event_orchestrations +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
+ +```sql +EXEC pagerduty.event_orchestrations.event_orchestrations._list_event_orchestrations +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@sort_by='{{ sort_by }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
+ +```sql +EXEC pagerduty.event_orchestrations.event_orchestrations.post_orchestration +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"orchestration": "{{ 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
+ +```sql +EXEC pagerduty.event_orchestrations.event_orchestrations._get_orchestration +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
+ +```sql +EXEC pagerduty.event_orchestrations.event_orchestrations.update_orchestration +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"orchestration": "{{ orchestration }}" +}' +; +``` + + diff --git a/website/docs/services/event_orchestrations/global/index.md b/website/docs/services/event_orchestrations/global/index.md new file mode 100644 index 0000000..9e5cd70 --- /dev/null +++ b/website/docs/services/event_orchestrations/global/index.md @@ -0,0 +1,213 @@ +--- +title: global +hide_title: false +hide_table_of_contents: false +keywords: + - global + - event_orchestrations + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a global resource. + +## Overview + + + + +
Nameglobal
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The Global Orchestration Rules object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
When none of the rules match an event, the event will be routed according to the catch_all settings.
You must define at least a "start" set, but you can also define any number of additional sets that are routed to by other rules to form a directional graph.
Indicates that these are a set of "global" rules. (default: global)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
id, orchestration_pathAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of an Event Orchestration.
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
+ +```sql +SELECT +catch_all, +parent, +sets, +type +FROM pagerduty.event_orchestrations.global +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
+ +```sql +EXEC pagerduty.event_orchestrations.global._get_orch_path_global +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
+ +```sql +EXEC pagerduty.event_orchestrations.global.update_orch_path_global +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"orchestration_path": "{{ orchestration_path }}" +}' +; +``` + + diff --git a/website/docs/services/event_orchestrations/index.md b/website/docs/services/event_orchestrations/index.md new file mode 100644 index 0000000..354faab --- /dev/null +++ b/website/docs/services/event_orchestrations/index.md @@ -0,0 +1,38 @@ +--- +title: event_orchestrations +hide_title: false +hide_table_of_contents: false +keywords: + - event_orchestrations + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +event_orchestrations service documentation. + +:::info[Service Summary] + +total resources: __7__ + +::: + +## Resources +
+
+event_orchestrations
+global
+integrations
+router +
+
+services
+services_active
+unrouted +
+
\ No newline at end of file diff --git a/website/docs/services/event_orchestrations/integrations/index.md b/website/docs/services/event_orchestrations/integrations/index.md new file mode 100644 index 0000000..9557397 --- /dev/null +++ b/website/docs/services/event_orchestrations/integrations/index.md @@ -0,0 +1,372 @@ +--- +title: integrations +hide_title: false +hide_table_of_contents: false +keywords: + - integrations + - event_orchestrations + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an integrations resource. + +## Overview + + + + +
Nameintegrations
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +An Integration for this Event Orchestration. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the Integration.
stringName of the Integration.
object
+ + + +The Integrations for this Event Orchestration. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the Integration.
stringName of the Integration.
object
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, integration_idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
idAccept, Content-TypeList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
id, integration_idAccept, Content-TypeDelete 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
idAccept, Content-TypeList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
id, integrationAccept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
id, integration_idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
id, integration_id, integrationAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
id, source_id, source_type, integration_idAccept, Content-TypeMove 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of an Event Orchestration.
stringThe ID of an Integration.
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
+ +```sql +SELECT +id, +label, +parameters +FROM pagerduty.event_orchestrations.integrations +WHERE id = '{{ id }}' -- required +AND integration_id = '{{ integration_id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
+ +```sql +SELECT +id, +label, +parameters +FROM pagerduty.event_orchestrations.integrations +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
+ +```sql +DELETE FROM pagerduty.event_orchestrations.integrations +WHERE id = '{{ id }}' --required +AND integration_id = '{{ integration_id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
+ +```sql +EXEC pagerduty.event_orchestrations.integrations._list_orchestration_integrations +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
+ +```sql +EXEC pagerduty.event_orchestrations.integrations.post_orchestration_integration +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"integration": "{{ integration }}" +}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
+ +```sql +EXEC pagerduty.event_orchestrations.integrations._get_orchestration_integration +@id='{{ id }}' --required, +@integration_id='{{ integration_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
+ +```sql +EXEC pagerduty.event_orchestrations.integrations.update_orchestration_integration +@id='{{ id }}' --required, +@integration_id='{{ integration_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"integration": "{{ integration }}" +}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
+ +```sql +EXEC pagerduty.event_orchestrations.integrations.migrate_orchestration_integration +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"source_id": "{{ source_id }}", +"source_type": "{{ source_type }}", +"integration_id": "{{ integration_id }}" +}' +; +``` + + diff --git a/website/docs/services/event_orchestrations/router/index.md b/website/docs/services/event_orchestrations/router/index.md new file mode 100644 index 0000000..66373b9 --- /dev/null +++ b/website/docs/services/event_orchestrations/router/index.md @@ -0,0 +1,213 @@ +--- +title: router +hide_title: false +hide_table_of_contents: false +keywords: + - router + - event_orchestrations + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a router resource. + +## Overview + + + + +
Namerouter
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The Orchestration Router object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
When none of the rules match an event, the event will be routed according to the catch_all settings.
The Router contains a single set of rules (the "start" set). The Router evaluates Events against these Rules, one at a time, and routes each Event to a specific Service based on the first rule that matches.
Indicates that these are a "router" type set of rules. (default: router)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
id, orchestration_pathAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of an Event Orchestration.
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
+ +```sql +SELECT +catch_all, +parent, +sets, +type +FROM pagerduty.event_orchestrations.router +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
+ +```sql +EXEC pagerduty.event_orchestrations.router._get_orch_path_router +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
+ +```sql +EXEC pagerduty.event_orchestrations.router.update_orch_path_router +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"orchestration_path": "{{ orchestration_path }}" +}' +; +``` + + diff --git a/website/docs/services/event_orchestrations/services/index.md b/website/docs/services/event_orchestrations/services/index.md new file mode 100644 index 0000000..0fdd8a2 --- /dev/null +++ b/website/docs/services/event_orchestrations/services/index.md @@ -0,0 +1,213 @@ +--- +title: services +hide_title: false +hide_table_of_contents: false +keywords: + - services + - event_orchestrations + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a services resource. + +## Overview + + + + +
Nameservices
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The Service Orchestration object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
A Service Orchestration must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph.
Indicates that these are sets of rules belonging to a service. (default: service)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
service_idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.read`
service_idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.read`
service_id, orchestration_pathAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe service ID
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.read`
+ +```sql +SELECT +catch_all, +parent, +sets, +type +FROM pagerduty.event_orchestrations.services +WHERE service_id = '{{ service_id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.read`
+ +```sql +EXEC pagerduty.event_orchestrations.services._get_orch_path_service +@service_id='{{ service_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.write`
+ +```sql +EXEC pagerduty.event_orchestrations.services.update_orch_path_service +@service_id='{{ service_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"orchestration_path": "{{ orchestration_path }}" +}' +; +``` + + diff --git a/website/docs/services/event_orchestrations/services_active/index.md b/website/docs/services/event_orchestrations/services_active/index.md new file mode 100644 index 0000000..3a3a0f7 --- /dev/null +++ b/website/docs/services/event_orchestrations/services_active/index.md @@ -0,0 +1,190 @@ +--- +title: services_active +hide_title: false +hide_table_of_contents: false +keywords: + - services_active + - event_orchestrations + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a services_active resource. + +## Overview + + + + +
Nameservices_active
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +An object with the active status. + + + + + + + + + + + +
NameDatatypeDescription
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
service_idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.read`
service_idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.read`
service_idAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe service ID
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.read`
+ +```sql +SELECT +* +FROM pagerduty.event_orchestrations.services_active +WHERE service_id = '{{ service_id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.read`
+ +```sql +EXEC pagerduty.event_orchestrations.services_active._get_orch_active_status +@service_id='{{ service_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.write`
+ +```sql +EXEC pagerduty.event_orchestrations.services_active.update_orch_active_status +@service_id='{{ service_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"active": {{ active }} +}' +; +``` + + diff --git a/website/docs/services/event_orchestrations/unrouted/index.md b/website/docs/services/event_orchestrations/unrouted/index.md new file mode 100644 index 0000000..bfbd917 --- /dev/null +++ b/website/docs/services/event_orchestrations/unrouted/index.md @@ -0,0 +1,213 @@ +--- +title: unrouted +hide_title: false +hide_table_of_contents: false +keywords: + - unrouted + - event_orchestrations + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an unrouted resource. + +## Overview + + + + +
Nameunrouted
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The Unrouted Orchestration object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
An Unrouted Orchestration must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph.
Indicates that these are a "unrouted" type set of rules. (default: unrouted)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
id, orchestration_pathAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of an Event Orchestration.
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
+ +```sql +SELECT +catch_all, +parent, +sets, +type +FROM pagerduty.event_orchestrations.unrouted +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
+ +```sql +EXEC pagerduty.event_orchestrations.unrouted._get_orch_path_unrouted +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
+ +```sql +EXEC pagerduty.event_orchestrations.unrouted.update_orch_path_unrouted +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"orchestration_path": "{{ orchestration_path }}" +}' +; +``` + + diff --git a/website/docs/services/extension_schemas/extension_schemas/index.md b/website/docs/services/extension_schemas/extension_schemas/index.md new file mode 100644 index 0000000..4156e6b --- /dev/null +++ b/website/docs/services/extension_schemas/extension_schemas/index.md @@ -0,0 +1,338 @@ +--- +title: extension_schemas +hide_title: false +hide_table_of_contents: false +keywords: + - extension_schemas + - extension_schemas + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an extension_schemas resource. + +## Overview + + + + +
Nameextension_schemas
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The extension vendor requested + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe long description for the Extension
string (url)A link to the extension's support guide
string (url)A small logo, 18-by-18 pixels.
stringMachine friendly display label
stringHuman friendly display label
string (url)A large logo, 75 pixels high and no more than 300 pixels wide.
arrayThe types of PagerDuty incident events that will activate this Extension
stringThe url that the webhook payload will be sent to for this Extension.
+ + + +A paginated array of extension schemas. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe long description for the Extension
string (url)A link to the extension's support guide
string (url)A small logo, 18-by-18 pixels.
stringMachine friendly display label
stringHuman friendly display label
string (url)A large logo, 75 pixels high and no more than 300 pixels wide.
arrayThe types of PagerDuty incident events that will activate this Extension
stringThe url that the webhook payload will be sent to for this Extension.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extension-schemas)

Scoped OAuth requires: `extension_schemas.read`
limit, offset, total, Accept, Content-TypeList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extension-schemas)

Scoped OAuth requires: `extension_schemas.read`
limit, offset, total, Accept, Content-TypeList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extension-schemas)

Scoped OAuth requires: `extension_schemas.read`
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extension-schemas)

Scoped OAuth requires: `extension_schemas.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
integerThe number of results per page.
integerOffset to start pagination search results.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extension-schemas)

Scoped OAuth requires: `extension_schemas.read`
+ +```sql +SELECT +description, +guide_url, +icon_url, +key, +label, +logo_url, +send_types, +url +FROM pagerduty.extension_schemas.extension_schemas +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extension-schemas)

Scoped OAuth requires: `extension_schemas.read`
+ +```sql +SELECT +description, +guide_url, +icon_url, +key, +label, +logo_url, +send_types, +url +FROM pagerduty.extension_schemas.extension_schemas +WHERE limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extension-schemas)

Scoped OAuth requires: `extension_schemas.read`
+ +```sql +EXEC pagerduty.extension_schemas.extension_schemas._list_extension_schemas +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extension-schemas)

Scoped OAuth requires: `extension_schemas.read`
+ +```sql +EXEC pagerduty.extension_schemas.extension_schemas._get_extension_schema +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/extension_schemas/index.md b/website/docs/services/extension_schemas/index.md new file mode 100644 index 0000000..3d23bb5 --- /dev/null +++ b/website/docs/services/extension_schemas/index.md @@ -0,0 +1,33 @@ +--- +title: extension_schemas +hide_title: false +hide_table_of_contents: false +keywords: + - extension_schemas + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +extension_schemas service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+extension_schemas +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/extensions/extensions/index.md b/website/docs/services/extensions/extensions/index.md new file mode 100644 index 0000000..f23c04f --- /dev/null +++ b/website/docs/services/extensions/extensions/index.md @@ -0,0 +1,531 @@ +--- +title: extensions +hide_title: false +hide_table_of_contents: false +keywords: + - extensions + - extensions + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an extensions resource. + +## Overview + + + + +
Nameextensions
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The extension that was requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the extension.
objectThe object that contains extension configuration values depending on the extension schema specification.
string (url)The url of the extension.
arrayThe objects for which the extension applies
object
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
booleanWhether or not this extension is temporarily disabled; for example, a webhook extension that is repeatedly rejected by the server.
stringThe type of object being created. (default: extension)
+ + + +A paginated array of extensions. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the extension.
objectThe object that contains extension configuration values depending on the extension schema specification.
string (url)The url of the extension.
arrayThe objects for which the extension applies
object
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
booleanWhether or not this extension is temporarily disabled; for example, a webhook extension that is repeatedly rejected by the server.
stringThe type of object being created. (default: extension)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)

Scoped OAuth requires: `extensions.read`
limit, offset, total, Accept, Content-Type, query, extension_object_id, extension_schema_id, include[]List existing extensions.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)

Scoped OAuth requires: `extensions.read`
data__extensionAccept, Content-TypeCreate a new Extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)

Scoped OAuth requires: `extensions.write`
idAccept, Content-TypeDelete 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)

Scoped OAuth requires: `extensions.write`
limit, offset, total, Accept, Content-Type, query, extension_object_id, extension_schema_id, include[]List existing extensions.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)

Scoped OAuth requires: `extensions.read`
idAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)

Scoped OAuth requires: `extensions.read`
id, extensionAccept, Content-TypeUpdate an existing extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)

Scoped OAuth requires: `extensions.write`
idAccept, Content-TypeEnable 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)

Scoped OAuth requires: `extensions.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringThe id of the extension object you want to filter by.
stringFilter the extensions by extension vendor id.
stringArray of additional details to include.
integerThe number of results per page.
integerOffset to start pagination search results.
stringFilters the result, showing only the records whose name matches the query.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)

Scoped OAuth requires: `extensions.read`
+ +```sql +SELECT +id, +name, +config, +endpoint_url, +extension_objects, +extension_schema, +html_url, +self, +summary, +temporarily_disabled, +type +FROM pagerduty.extensions.extensions +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND include[] = '{{ include[] }}' +; +``` + + + +List existing extensions.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)

Scoped OAuth requires: `extensions.read`
+ +```sql +SELECT +id, +name, +config, +endpoint_url, +extension_objects, +extension_schema, +html_url, +self, +summary, +temporarily_disabled, +type +FROM pagerduty.extensions.extensions +WHERE limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND query = '{{ query }}' +AND extension_object_id = '{{ extension_object_id }}' +AND extension_schema_id = '{{ extension_schema_id }}' +AND include[] = '{{ include[] }}' +; +``` + + + + +## `INSERT` examples + + + + +Create a new Extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)

Scoped OAuth requires: `extensions.write`
+ +```sql +INSERT INTO pagerduty.extensions.extensions ( +data__extension, +Accept, +Content-Type +) +SELECT +'{{ extension }}' /* required */, +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +extension +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: extensions + props: + - name: extension + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)

Scoped OAuth requires: `extensions.write`
+ +```sql +DELETE FROM pagerduty.extensions.extensions +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +List existing extensions.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)

Scoped OAuth requires: `extensions.read`
+ +```sql +EXEC pagerduty.extensions.extensions._list_extensions +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@query='{{ query }}', +@extension_object_id='{{ extension_object_id }}', +@extension_schema_id='{{ extension_schema_id }}', +@include[]='{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)

Scoped OAuth requires: `extensions.read`
+ +```sql +EXEC pagerduty.extensions.extensions._get_extension +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@include[]='{{ include[] }}' +; +``` + + + +Update an existing extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)

Scoped OAuth requires: `extensions.write`
+ +```sql +EXEC pagerduty.extensions.extensions.update_extension +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"extension": "{{ 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)

Scoped OAuth requires: `extensions.write`
+ +```sql +EXEC pagerduty.extensions.extensions.enable_extension +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/extensions/index.md b/website/docs/services/extensions/index.md new file mode 100644 index 0000000..5c55d4d --- /dev/null +++ b/website/docs/services/extensions/index.md @@ -0,0 +1,33 @@ +--- +title: extensions +hide_title: false +hide_table_of_contents: false +keywords: + - extensions + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +extensions service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+extensions +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/incident_workflows/actions/index.md b/website/docs/services/incident_workflows/actions/index.md new file mode 100644 index 0000000..3e0a20d --- /dev/null +++ b/website/docs/services/incident_workflows/actions/index.md @@ -0,0 +1,482 @@ +--- +title: actions +hide_title: false +hide_table_of_contents: false +keywords: + - actions + - incident_workflows + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an actions resource. + +## Overview + + + + +
Nameactions
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +An Incident Workflow Action + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe descriptive name of the Action
stringThe obfuscated Id of the User who created this Action
stringThe Verified Domain of the account that created the action
stringThe Function Name describing the specific functionality of the Action
stringThe Package Name corresponding to the broad category of the Action
stringThe type of Action
string (date-time)The date-time at which this Action was created
stringA description of the Action
string (url)a URL at which the entity is uniquely displayed in the Web app
arrayInputs whose values used during Action execution
stringJSON-formatted string of metadata pertaining to the Action
arrayOutputs whose values set during Action execution
arrayA set of search keywords to apply to this action.
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
arrayA set of tags to apply to this action.
stringThe type of Trigger this Action is, if action_type is trigger
string
numberThe version of the Action
+ + + +A paginated array of Incident Workflow Actions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe descriptive name of the Action
stringThe obfuscated Id of the User who created this Action
stringThe Verified Domain of the account that created the action
stringThe Function Name describing the specific functionality of the Action
stringThe Package Name corresponding to the broad category of the Action
stringThe type of Action
string (date-time)The date-time at which this Action was created
stringA description of the Action
string (url)a URL at which the entity is uniquely displayed in the Web app
arrayInputs whose values used during Action execution
stringJSON-formatted string of metadata pertaining to the Action
arrayOutputs whose values set during Action execution
arrayA set of search keywords to apply to this action.
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
arrayA set of tags to apply to this action.
stringThe type of Trigger this Action is, if action_type is trigger
string
numberThe version of the Action
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet an Incident Workflow Action

Scoped OAuth requires: `incident_workflows.read`
Accept, Content-Type, limit, cursor, keywordList Incident Workflow Actions

Scoped OAuth requires: `incident_workflows.read`
Accept, Content-Type, limit, cursor, keywordList Incident Workflow Actions

Scoped OAuth requires: `incident_workflows.read`
idAccept, Content-TypeGet an Incident Workflow Action

Scoped OAuth requires: `incident_workflows.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringOptional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set.
stringIf provided, only show actions tagged with the specified keyword
integerThe minimum of the `limit` parameter used in the request or the maximum request size of the API.
+ +## `SELECT` examples + + + + +Get an Incident Workflow Action

Scoped OAuth requires: `incident_workflows.read`
+ +```sql +SELECT +id, +name, +created_by_user_id, +domain_name, +function_name, +package_name, +action_type, +created_at, +description, +html_url, +inputs, +metadata, +outputs, +search_keywords, +self, +summary, +tags, +trigger_type, +type, +version +FROM pagerduty.incident_workflows.actions +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +List Incident Workflow Actions

Scoped OAuth requires: `incident_workflows.read`
+ +```sql +SELECT +id, +name, +created_by_user_id, +domain_name, +function_name, +package_name, +action_type, +created_at, +description, +html_url, +inputs, +metadata, +outputs, +search_keywords, +self, +summary, +tags, +trigger_type, +type, +version +FROM pagerduty.incident_workflows.actions +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND cursor = '{{ cursor }}' +AND keyword = '{{ keyword }}' +; +``` + + + + +## Lifecycle Methods + + + + +List Incident Workflow Actions

Scoped OAuth requires: `incident_workflows.read`
+ +```sql +EXEC pagerduty.incident_workflows.actions._list_incident_workflow_actions +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@cursor='{{ cursor }}', +@keyword='{{ keyword }}' +; +``` + + + +Get an Incident Workflow Action

Scoped OAuth requires: `incident_workflows.read`
+ +```sql +EXEC pagerduty.incident_workflows.actions._get_incident_workflow_action +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/incident_workflows/incident_workflows/index.md b/website/docs/services/incident_workflows/incident_workflows/index.md new file mode 100644 index 0000000..7332766 --- /dev/null +++ b/website/docs/services/incident_workflows/incident_workflows/index.md @@ -0,0 +1,511 @@ +--- +title: incident_workflows +hide_title: false +hide_table_of_contents: false +keywords: + - incident_workflows + - incident_workflows + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an incident_workflows resource. + +## Overview + + + + +
Nameincident_workflows
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The Incident Workflow + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringA descriptive name for the Incident Workflow
string (date-time)The timestamp this Incident Workflow was created
stringA description of what the Incident Workflow does
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
arrayThe ordered list of steps that execute sequentially as part of the workflow
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
objectIf specified then workflow edit permissions will be scoped to members of this team
string
+ + + +A paginated array of Incident Workflows. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringA descriptive name for the Incident Workflow
string (date-time)The timestamp this Incident Workflow was created
stringA description of what the Incident Workflow does
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
arrayThe ordered list of steps that execute sequentially as part of the workflow
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
objectIf specified then workflow edit permissions will be scoped to members of this team
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet 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`
Accept, Content-Type, limit, offset, total, query, include[]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 "listIncidentWorkflowsByService" endpoint.

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`
id, data__incident_workflow_instanceAccept, Content-TypeStart an Instance of 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:instances.write`
idAccept, Content-TypeDelete 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`
Accept, Content-Type, limit, offset, total, query, include[]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 "listIncidentWorkflowsByService" endpoint.

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`
incident_workflowAccept, Content-TypeCreate 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`
idAccept, Content-TypeGet 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`
id, incident_workflowAccept, Content-TypeUpdate 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`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringArray of additional details to include.
integerThe number of results per page.
integerOffset to start pagination search results.
stringFilters the result, showing only the records whose name matches the query.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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`
+ +```sql +SELECT +id, +name, +created_at, +description, +html_url, +self, +steps, +summary, +team, +type +FROM pagerduty.incident_workflows.incident_workflows +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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 "listIncidentWorkflowsByService" endpoint.

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`
+ +```sql +SELECT +id, +name, +created_at, +description, +html_url, +self, +steps, +summary, +team, +type +FROM pagerduty.incident_workflows.incident_workflows +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND query = '{{ query }}' +AND include[] = '{{ include[] }}' +; +``` + + + + +## `INSERT` examples + + + + +Start an Instance of 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:instances.write`
+ +```sql +INSERT INTO pagerduty.incident_workflows.incident_workflows ( +data__incident_workflow_instance, +id, +Accept, +Content-Type +) +SELECT +'{{ incident_workflow_instance }}' /* required */, +'{{ id }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +incident_workflow_instance +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: incident_workflows + props: + - name: id + value: string + description: Required parameter for the incident_workflows resource. + - name: incident_workflow_instance + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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`
+ +```sql +DELETE FROM pagerduty.incident_workflows.incident_workflows +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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 "listIncidentWorkflowsByService" endpoint.

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`
+ +```sql +EXEC pagerduty.incident_workflows.incident_workflows._list_incident_workflows +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@query='{{ query }}', +@include[]='{{ include[] }}' +; +``` + + + +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`
+ +```sql +EXEC pagerduty.incident_workflows.incident_workflows.post_incident_workflow +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"incident_workflow": "{{ 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`
+ +```sql +EXEC pagerduty.incident_workflows.incident_workflows._get_incident_workflow +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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`
+ +```sql +EXEC pagerduty.incident_workflows.incident_workflows.put_incident_workflow +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"incident_workflow": "{{ incident_workflow }}" +}' +; +``` + + diff --git a/website/docs/services/incident_workflows/index.md b/website/docs/services/incident_workflows/index.md new file mode 100644 index 0000000..2a6fcda --- /dev/null +++ b/website/docs/services/incident_workflows/index.md @@ -0,0 +1,34 @@ +--- +title: incident_workflows +hide_title: false +hide_table_of_contents: false +keywords: + - incident_workflows + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +incident_workflows service documentation. + +:::info[Service Summary] + +total resources: __3__ + +::: + +## Resources +
+
+actions
+incident_workflows +
+
+triggers +
+
\ No newline at end of file diff --git a/website/docs/services/incident_workflows/triggers/index.md b/website/docs/services/incident_workflows/triggers/index.md new file mode 100644 index 0000000..93719d3 --- /dev/null +++ b/website/docs/services/incident_workflows/triggers/index.md @@ -0,0 +1,588 @@ +--- +title: triggers +hide_title: false +hide_table_of_contents: false +keywords: + - triggers + - incident_workflows + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a triggers resource. + +## Overview + + + + +
Nametriggers
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The Incident Workflows Trigger + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringHuman readable name for the trigger type
stringA PCL condition string. If specified, the trigger will execute when the condition is met on an incident. If unspecified, the trigger will execute on incident creation. Required if trigger_type is “conditional”, not allowed if trigger_type is “manual”.
string (url)a URL at which the entity is uniquely displayed in the Web app
booleanIndicates that the Trigger should be associated with All Services
objectAn object detailing who can start this Trigger. Applicable only to manual Triggers.
string (url)the API show URL at which the object is accessible
arrayAn optional array of Services associated with this workflow. Incidents in any of the listed Services are eligible to fire this Trigger
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
string
string (url)
string
objectWorkflow to start when this trigger is invoked
+ + + +A paginated array of Incident Workflow Triggers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringHuman readable name for the trigger type
stringA PCL condition string. If specified, the trigger will execute when the condition is met on an incident. If unspecified, the trigger will execute on incident creation. Required if trigger_type is “conditional”, not allowed if trigger_type is “manual”.
string (url)a URL at which the entity is uniquely displayed in the Web app
booleanIndicates that the Trigger should be associated with All Services
objectAn object detailing who can start this Trigger. Applicable only to manual Triggers.
string (url)the API show URL at which the object is accessible
arrayAn optional array of Services associated with this workflow. Incidents in any of the listed Services are eligible to fire this Trigger
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
string
string (url)
string
objectWorkflow to start when this trigger is invoked
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeRetrieve an existing Incident Workflows Trigger

Scoped OAuth requires: `incident_workflows.read`
Accept, Content-Type, workflow_id, incident_id, service_id, trigger_type, sort_by, limit, cursorList existing Incident Workflow Triggers

Scoped OAuth requires: `incident_workflows.read`
data__triggerAccept, Content-TypeCreate new Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
trigger_id, service_idAccept, Content-TypeRemove a an existing Service from an Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
idAccept, Content-TypeDelete an existing Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
Accept, Content-Type, workflow_id, incident_id, service_id, trigger_type, sort_by, limit, cursorList existing Incident Workflow Triggers

Scoped OAuth requires: `incident_workflows.read`
idAccept, Content-TypeRetrieve an existing Incident Workflows Trigger

Scoped OAuth requires: `incident_workflows.read`
id, triggerAccept, Content-TypeUpdate an existing Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
id, serviceAccept, Content-TypeAssociate a Service with an existing Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringIdentifier for the Service
stringIdentifier for the Trigger
stringThe `Accept` header is used as a versioning header.
string
stringOptional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set.
stringIf provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided.
integerThe minimum of the `limit` parameter used in the request or the maximum request size of the API.
stringIf provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided.
stringIf provided, returns triggers sorted by the specified property.
stringIf provided, only show triggers of the given type. For example “manual” to search for manual triggers
stringIf provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow
+ +## `SELECT` examples + + + + +Retrieve an existing Incident Workflows Trigger

Scoped OAuth requires: `incident_workflows.read`
+ +```sql +SELECT +id, +trigger_type_name, +condition, +html_url, +is_subscribed_to_all_services, +permissions, +self, +services, +summary, +trigger_type, +trigger_url, +type, +workflow +FROM pagerduty.incident_workflows.triggers +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +List existing Incident Workflow Triggers

Scoped OAuth requires: `incident_workflows.read`
+ +```sql +SELECT +id, +trigger_type_name, +condition, +html_url, +is_subscribed_to_all_services, +permissions, +self, +services, +summary, +trigger_type, +trigger_url, +type, +workflow +FROM pagerduty.incident_workflows.triggers +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND workflow_id = '{{ workflow_id }}' +AND incident_id = '{{ incident_id }}' +AND service_id = '{{ service_id }}' +AND trigger_type = '{{ trigger_type }}' +AND sort_by = '{{ sort_by }}' +AND limit = '{{ limit }}' +AND cursor = '{{ cursor }}' +; +``` + + + + +## `INSERT` examples + + + + +Create new Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
+ +```sql +INSERT INTO pagerduty.incident_workflows.triggers ( +data__trigger, +Accept, +Content-Type +) +SELECT +'{{ trigger }}' /* required */, +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +trigger +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: triggers + props: + - name: trigger + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +Remove a an existing Service from an Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
+ +```sql +DELETE FROM pagerduty.incident_workflows.triggers +WHERE trigger_id = '{{ trigger_id }}' --required +AND service_id = '{{ service_id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +Delete an existing Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
+ +```sql +DELETE FROM pagerduty.incident_workflows.triggers +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +List existing Incident Workflow Triggers

Scoped OAuth requires: `incident_workflows.read`
+ +```sql +EXEC pagerduty.incident_workflows.triggers._list_incident_workflow_triggers +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@workflow_id='{{ workflow_id }}', +@incident_id='{{ incident_id }}', +@service_id='{{ service_id }}', +@trigger_type='{{ trigger_type }}', +@sort_by='{{ sort_by }}', +@limit='{{ limit }}', +@cursor='{{ cursor }}' +; +``` + + + +Retrieve an existing Incident Workflows Trigger

Scoped OAuth requires: `incident_workflows.read`
+ +```sql +EXEC pagerduty.incident_workflows.triggers._get_incident_workflow_trigger +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +Update an existing Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
+ +```sql +EXEC pagerduty.incident_workflows.triggers.update_incident_workflow_trigger +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"trigger": "{{ trigger }}" +}' +; +``` + + + +Associate a Service with an existing Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
+ +```sql +EXEC pagerduty.incident_workflows.triggers.associate_service_to_incident_workflow_trigger +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"service": "{{ service }}" +}' +; +``` + + diff --git a/website/docs/services/incidents/alerts/index.md b/website/docs/services/incidents/alerts/index.md new file mode 100644 index 0000000..43ddec8 --- /dev/null +++ b/website/docs/services/incidents/alerts/index.md @@ -0,0 +1,518 @@ +--- +title: alerts +hide_title: false +hide_table_of_contents: false +keywords: + - alerts + - incidents + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an alerts resource. + +## Overview + + + + +
Namealerts
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The alert requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe alert's de-duplication key.
objectA JSON object containing data describing the alert. (title: Body)
string (date-time)The date/time the alert was first triggered.
object
string (url)a URL at which the entity is uniquely displayed in the Web app
object
object
string (url)the API show URL at which the object is accessible
object
stringThe magnitude of the problem as reported by the monitoring tool.
stringThe current status of the alert.
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
booleanWhether or not an alert is suppressed. Suppressed alerts are not created with a parent incident.
stringThe type of object being created. (default: alert)
+ + + +A paginated array of the incident's alerts. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe alert's de-duplication key.
objectA JSON object containing data describing the alert. (title: Body)
string (date-time)The date/time the alert was first triggered.
object
string (url)a URL at which the entity is uniquely displayed in the Web app
object
object
string (url)the API show URL at which the object is accessible
object
stringThe magnitude of the problem as reported by the monitoring tool.
stringThe current status of the alert.
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
booleanWhether or not an alert is suppressed. Suppressed alerts are not created with a parent incident.
stringThe type of object being created. (default: alert)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, alert_idAccept, Content-TypeShow 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
idAccept, Content-Type, limit, offset, total, alert_key, statuses[], sort_by, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
idAccept, Content-Type, limit, offset, total, alert_key, statuses[], sort_by, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
id, From, alertsAccept, Content-Type, limit, offset, totalResolve 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 500 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
id, alert_idAccept, Content-TypeShow 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
id, alert_id, From, alertAccept, Content-TypeResolve 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (email)The email address of a valid user associated with the account making the request.
stringThe id of the alert to retrieve.
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringAlert de-duplication key.
stringArray of additional details to include.
integerThe number of results per page.
integerOffset to start pagination search results.
stringUsed to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.
stringReturn only alerts with the given statuses. (More status codes may be introduced in the future.)
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
+ +```sql +SELECT +id, +alert_key, +body, +created_at, +first_trigger_log_entry, +html_url, +incident, +integration, +self, +service, +severity, +status, +summary, +suppressed, +type +FROM pagerduty.incidents.alerts +WHERE id = '{{ id }}' -- required +AND alert_id = '{{ alert_id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
+ +```sql +SELECT +id, +alert_key, +body, +created_at, +first_trigger_log_entry, +html_url, +incident, +integration, +self, +service, +severity, +status, +summary, +suppressed, +type +FROM pagerduty.incidents.alerts +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND alert_key = '{{ alert_key }}' +AND statuses[] = '{{ statuses[] }}' +AND sort_by = '{{ sort_by }}' +AND include[] = '{{ include[] }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
+ +```sql +EXEC pagerduty.incidents.alerts._list_incident_alerts +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@alert_key='{{ alert_key }}', +@statuses[]='{{ statuses[] }}', +@sort_by='{{ sort_by }}', +@include[]='{{ include[] }}' +; +``` + + + +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 500 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
+ +```sql +EXEC pagerduty.incidents.alerts.update_incident_alerts +@id='{{ id }}' --required, +@From='{{ From }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }} +@@json= +'{ +"alerts": "{{ alerts }}" +}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
+ +```sql +EXEC pagerduty.incidents.alerts._get_incident_alert +@id='{{ id }}' --required, +@alert_id='{{ alert_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
+ +```sql +EXEC pagerduty.incidents.alerts.update_incident_alert +@id='{{ id }}' --required, +@alert_id='{{ alert_id }}' --required, +@From='{{ From }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"alert": "{{ alert }}" +}' +; +``` + + diff --git a/website/docs/services/incidents/business_services_impacts/index.md b/website/docs/services/incidents/business_services_impacts/index.md new file mode 100644 index 0000000..c9ecccb --- /dev/null +++ b/website/docs/services/incidents/business_services_impacts/index.md @@ -0,0 +1,223 @@ +--- +title: business_services_impacts +hide_title: false +hide_table_of_contents: false +keywords: + - business_services_impacts + - incidents + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a business_services_impacts resource. + +## Overview + + + + +
Namebusiness_services_impacts
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
stringThe current impact status of the object
stringThe kind of object that has been impacted
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, X-EARLY-ACCESSAcceptRetrieve a list of Business Services that are being impacted by the given Incident.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
id, business_service_id, X-EARLY-ACCESS, relationAcceptChange Impact of an Incident on a Business Service.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
id, X-EARLY-ACCESSAcceptRetrieve a list of Business Services that are being impacted by the given Incident.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `business-impact-early-access`. Do not use this endpoint in production, as it may change!
stringThe business service ID.
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
+ +## `SELECT` examples + + + + +Retrieve a list of Business Services that are being impacted by the given Incident.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +SELECT +id, +name, +additional_fields, +status, +type +FROM pagerduty.incidents.business_services_impacts +WHERE id = '{{ id }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND Accept = '{{ Accept }}' +; +``` + + + + +## Lifecycle Methods + + + + +Change Impact of an Incident on a Business Service.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +EXEC pagerduty.incidents.business_services_impacts.put_incident_manual_business_service_association +@id='{{ id }}' --required, +@business_service_id='{{ business_service_id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@Accept='{{ Accept }}' +@@json= +'{ +"relation": "{{ relation }}" +}' +; +``` + + + +Retrieve a list of Business Services that are being impacted by the given Incident.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +EXEC pagerduty.incidents.business_services_impacts._get_incident_impacted_business_services +@id='{{ id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@Accept='{{ Accept }}' +; +``` + + diff --git a/website/docs/services/incidents/field_values/index.md b/website/docs/services/incidents/field_values/index.md new file mode 100644 index 0000000..55daa33 --- /dev/null +++ b/website/docs/services/incidents/field_values/index.md @@ -0,0 +1,234 @@ +--- +title: field_values +hide_title: false +hide_table_of_contents: false +keywords: + - field_values + - incidents + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a field_values resource. + +## Overview + + + + +
Namefield_values
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The list of field values + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId of the field.
stringThe name of the field. May include ASCII characters, specifically lowercase letters, digits, and underescores. The `name` for a Field must be unique.
stringThe human-readable name of the field. This must be unique across an account.
stringThe kind of data the custom field is allowed to contain.
stringA description of the data this field contains.
booleanIf `true`, restricts the values allowed to be stored in the custom field to a limited set of options (configured via the Field Option sub-resource). Must be `false` if `datatype` is "boolean", "url", or "datetime"
booleanIf `true`, allows the custom field to store a set of multiple values. Must be `false` if `datatype` is not "string" or "url"
stringDetermines the type of the reference.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, X-EARLY-ACCESSGet field values for an incident

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
id, X-EARLY-ACCESSGet field values for an incident

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
id, field_valuesSet field values for an incident

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change!
stringThe ID of the resource.
+ +## `SELECT` examples + + + + +Get field values for an incident

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +SELECT +id, +name, +display_name, +datatype, +description, +fixed_options, +multi_value, +type, +value +FROM pagerduty.incidents.field_values +WHERE id = '{{ id }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +; +``` + + + + +## Lifecycle Methods + + + + +Get field values for an incident

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.incidents.field_values._get_incident_field_values +@id='{{ id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required +; +``` + + + +Set field values for an incident

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.incidents.field_values.set_incident_field_values +@id='{{ id }}' --required +@@json= +'{ +"field_values": "{{ field_values }}" +}' +; +``` + + diff --git a/website/docs/services/incidents/field_values_schema/index.md b/website/docs/services/incidents/field_values_schema/index.md new file mode 100644 index 0000000..f28eda5 --- /dev/null +++ b/website/docs/services/incidents/field_values_schema/index.md @@ -0,0 +1,207 @@ +--- +title: field_values_schema +hide_title: false +hide_table_of_contents: false +keywords: + - field_values_schema + - incidents + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a field_values_schema resource. + +## Overview + + + + +
Namefield_values_schema
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The schema requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringA description of this schema.
array
string (url)The API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
stringThe name of the schema.
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, X-EARLY-ACCESSinclude[]Get detailed information about a Schema for an incident.

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
id, X-EARLY-ACCESSinclude[]Get detailed information about a Schema for an incident.

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change!
stringThe ID of the resource.
stringArray of additional details to include. Including `field_options` will also include field options.
+ +## `SELECT` examples + + + + +Get detailed information about a Schema for an incident.

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +SELECT +id, +description, +field_configurations, +self, +summary, +title, +type +FROM pagerduty.incidents.field_values_schema +WHERE id = '{{ id }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND include[] = '{{ include[] }}' +; +``` + + + + +## Lifecycle Methods + + + + +Get detailed information about a Schema for an incident.

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +```sql +EXEC pagerduty.incidents.field_values_schema._get_schema_for_incident +@id='{{ id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@include[]='{{ include[] }}' +; +``` + + diff --git a/website/docs/services/incidents/incidents/index.md b/website/docs/services/incidents/incidents/index.md new file mode 100644 index 0000000..59470f0 --- /dev/null +++ b/website/docs/services/incidents/incidents/index.md @@ -0,0 +1,915 @@ +--- +title: incidents +hide_title: false +hide_table_of_contents: false +keywords: + - incidents + - incidents + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an incidents resource. + +## Overview + + + + +
Nameincidents
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The incident requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
arrayList of all acknowledgements for this incident. This list will be empty if the `Incident.status` is `resolved` or `triggered`.
object
stringHow the current incident assignments were decided. Note that `direct_assignment` incidents will not escalate up the attached `escalation_policy`
arrayList of all assignments for this incident. This list will be empty if the `Incident.status` is `resolved`.
object
object
string (date-time)The date/time the incident was first triggered.
object
object
string (url)a URL at which the entity is uniquely displayed in the Web app
stringThe incident's de-duplication key.
integerThe number of the incident. This is unique across your account.
array
string (date-time)The time at which the status of the incident last changed.
objectThe agent (user, service or integration) that created or modified the Incident Log Entry.
arrayThe list of pending_actions on the incident. A pending_action object contains a type of action which can be escalate, unacknowledge, resolve or urgency_change. A pending_action object contains at, the time at which the action will take place. An urgency_change pending_action will contain to, the urgency that the incident will change to.
object
object
array
string (url)the API show URL at which the object is accessible
object
stringThe current status of the incident.
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
arrayThe teams involved in the incident’s lifecycle.
stringA succinct description of the nature, symptoms, cause, or effect of the incident.
stringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.
stringThe current urgency of the incident.
+ + + +A paginated array of incidents. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
arrayList of all acknowledgements for this incident. This list will be empty if the `Incident.status` is `resolved` or `triggered`.
object
stringHow the current incident assignments were decided. Note that `direct_assignment` incidents will not escalate up the attached `escalation_policy`
arrayList of all assignments for this incident. This list will be empty if the `Incident.status` is `resolved`.
object
object
string (date-time)The date/time the incident was first triggered.
object
object
string (url)a URL at which the entity is uniquely displayed in the Web app
stringThe incident's de-duplication key.
integerThe number of the incident. This is unique across your account.
array
string (date-time)The time at which the status of the incident last changed.
objectThe agent (user, service or integration) that created or modified the Incident Log Entry.
arrayThe list of pending_actions on the incident. A pending_action object contains a type of action which can be escalate, unacknowledge, resolve or urgency_change. A pending_action object contains at, the time at which the action will take place. An urgency_change pending_action will contain to, the urgency that the incident will change to.
object
object
array
string (url)the API show URL at which the object is accessible
object
stringThe current status of the incident.
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
arrayThe teams involved in the incident’s lifecycle.
stringA succinct description of the nature, symptoms, cause, or effect of the incident.
stringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.
stringThe current urgency of the incident.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, X-EARLY-ACCESSAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

<!-- theme: warning -->
> ### Early Access
> The `include[]=field_values` part of this endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

Scoped OAuth requires: `incidents.read`
Accept, Content-Type, limit, offset, total, date_range, incident_key, service_ids[], team_ids[], user_ids[], urgencies[], time_zone, statuses[], sort_by, include[], since, untilList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
From, data__incidentAccept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
Accept, Content-Type, limit, offset, total, date_range, incident_key, service_ids[], team_ids[], user_ids[], urgencies[], time_zone, statuses[], sort_by, include[], since, untilList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
From, incidentsAccept, Content-Type, limit, offset, totalAcknowledge, 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).

Note: the manage incidents API endpoint is rate limited to 500 requests per minute.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
id, X-EARLY-ACCESSAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

<!-- theme: warning -->
> ### Early Access
> The `include[]=field_values` part of this endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

Scoped OAuth requires: `incidents.read`
id, From, incidentAccept, Content-TypeAcknowledge, 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
id, From, source_incidentsAccept, Content-TypeMerge a list of source incidents into this incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
id, From, requester_id, message, responder_request_targetsAccept, Content-TypeSend a new responder request 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
id, From, durationAccept, Content-TypeSnooze 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
id, From, messageAccept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
id, subscribersAcceptUnsubscribes the matching Subscribers from Incident Status Update Notifications.

Scoped OAuth requires: `subscribers.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (email)The email address of a valid user associated with the account making the request.
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change!
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringWhen set to all, the since and until parameters and defaults are ignored.
stringIncident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key.
stringArray of additional details to include.
integerThe number of results per page.
integerOffset to start pagination search results.
arrayReturns only the incidents associated with the passed service(s). This expects one or more service IDs.
stringThe start of the date range over which you want to search. Maximum range is 6 months and default is 1 month.
arrayUsed to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.
stringReturn only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)
arrayAn array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter.
string (tzinfo)Time zone in which dates in the result will be rendered.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
stringThe end of the date range over which you want to search. Maximum range is 6 months and default is 1 month.
stringArray of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this.
arrayReturns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

<!-- theme: warning -->
> ### Early Access
> The `include[]=field_values` part of this endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

Scoped OAuth requires: `incidents.read`
+ +```sql +SELECT +id, +acknowledgements, +alert_counts, +assigned_via, +assignments, +body, +conference_bridge, +created_at, +escalation_policy, +first_trigger_log_entry, +html_url, +incident_key, +incident_number, +incidents_responders, +last_status_change_at, +last_status_change_by, +pending_actions, +priority, +resolve_reason, +responder_requests, +self, +service, +status, +summary, +teams, +title, +type, +urgency +FROM pagerduty.incidents.incidents +WHERE id = '{{ id }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND include[] = '{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
+ +```sql +SELECT +id, +acknowledgements, +alert_counts, +assigned_via, +assignments, +body, +conference_bridge, +created_at, +escalation_policy, +first_trigger_log_entry, +html_url, +incident_key, +incident_number, +incidents_responders, +last_status_change_at, +last_status_change_by, +pending_actions, +priority, +resolve_reason, +responder_requests, +self, +service, +status, +summary, +teams, +title, +type, +urgency +FROM pagerduty.incidents.incidents +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND date_range = '{{ date_range }}' +AND incident_key = '{{ incident_key }}' +AND service_ids[] = '{{ service_ids[] }}' +AND team_ids[] = '{{ team_ids[] }}' +AND user_ids[] = '{{ user_ids[] }}' +AND urgencies[] = '{{ urgencies[] }}' +AND time_zone = '{{ time_zone }}' +AND statuses[] = '{{ statuses[] }}' +AND sort_by = '{{ sort_by }}' +AND include[] = '{{ include[] }}' +AND since = '{{ since }}' +AND until = '{{ until }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
+ +```sql +INSERT INTO pagerduty.incidents.incidents ( +data__incident, +From, +Accept, +Content-Type +) +SELECT +'{{ incident }}' /* required */, +'{{ From }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +incident +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: incidents + props: + - name: From + value: string (email) + description: Required parameter for the incidents resource. + - name: incident + value: object + description: | + Details of the incident to be created. + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
+ +```sql +EXEC pagerduty.incidents.incidents._list_incidents +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@date_range='{{ date_range }}', +@incident_key='{{ incident_key }}', +@service_ids[]='{{ service_ids[] }}', +@team_ids[]='{{ team_ids[] }}', +@user_ids[]='{{ user_ids[] }}', +@urgencies[]='{{ urgencies[] }}', +@time_zone='{{ time_zone }}', +@statuses[]='{{ statuses[] }}', +@sort_by='{{ sort_by }}', +@include[]='{{ include[] }}', +@since='{{ since }}', +@until='{{ until }}' +; +``` + + + +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).

Note: the manage incidents API endpoint is rate limited to 500 requests per minute.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
+ +```sql +EXEC pagerduty.incidents.incidents.update_incidents +@From='{{ From }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }} +@@json= +'{ +"incidents": "{{ incidents }}" +}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

<!-- theme: warning -->
> ### Early Access
> The `include[]=field_values` part of this endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

Scoped OAuth requires: `incidents.read`
+ +```sql +EXEC pagerduty.incidents.incidents._get_incident +@id='{{ id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@include[]='{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
+ +```sql +EXEC pagerduty.incidents.incidents.update_incident +@id='{{ id }}' --required, +@From='{{ From }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"incident": "{{ incident }}" +}' +; +``` + + + +Merge a list of source incidents into this incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
+ +```sql +EXEC pagerduty.incidents.incidents.merge_incidents +@id='{{ id }}' --required, +@From='{{ From }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"source_incidents": "{{ source_incidents }}" +}' +; +``` + + + +Send a new responder request 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
+ +```sql +EXEC pagerduty.incidents.incidents.create_incident_responder_request +@id='{{ id }}' --required, +@From='{{ From }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"requester_id": "{{ requester_id }}", +"message": "{{ message }}", +"responder_request_targets": "{{ responder_request_targets }}" +}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
+ +```sql +EXEC pagerduty.incidents.incidents.create_incident_snooze +@id='{{ id }}' --required, +@From='{{ From }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"duration": {{ duration }} +}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
+ +```sql +EXEC pagerduty.incidents.incidents.create_incident_status_update +@id='{{ id }}' --required, +@From='{{ From }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"message": "{{ message }}", +"subject": "{{ subject }}", +"html_message": "{{ html_message }}" +}' +; +``` + + + +Unsubscribes the matching Subscribers from Incident Status Update Notifications.

Scoped OAuth requires: `subscribers.write`
+ +```sql +EXEC pagerduty.incidents.incidents.remove_incident_notification_subscribers +@id='{{ id }}' --required, +@Accept='{{ Accept }}' +@@json= +'{ +"subscribers": "{{ subscribers }}" +}' +; +``` + + diff --git a/website/docs/services/incidents/index.md b/website/docs/services/incidents/index.md new file mode 100644 index 0000000..5b2d571 --- /dev/null +++ b/website/docs/services/incidents/index.md @@ -0,0 +1,42 @@ +--- +title: incidents +hide_title: false +hide_table_of_contents: false +keywords: + - incidents + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +incidents service documentation. + +:::info[Service Summary] + +total resources: __11__ + +::: + +## Resources +
+
+alerts
+business_services_impacts
+field_values
+field_values_schema
+incidents
+log_entries +
+
+notes
+outlier_incident
+past_incidents
+related_incidents
+status_updates_subscribers +
+
\ No newline at end of file diff --git a/website/docs/services/incidents/log_entries/index.md b/website/docs/services/incidents/log_entries/index.md new file mode 100644 index 0000000..7e5aa52 --- /dev/null +++ b/website/docs/services/incidents/log_entries/index.md @@ -0,0 +1,222 @@ +--- +title: log_entries +hide_title: false +hide_table_of_contents: false +keywords: + - log_entries + - incidents + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a log_entries resource. + +## Overview + + + + +
Namelog_entries
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +A paginated array of the incident's log entries. + + + + + + + + + + + +
NameDatatypeDescription
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, limit, offset, total, time_zone, since, until, is_overview, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
idAccept, Content-Type, limit, offset, total, time_zone, since, until, is_overview, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringArray of additional Models to include in response.
booleanIf `true`, will return a subset of log entries that show only the most important changes to the incident.
integerThe number of results per page.
integerOffset to start pagination search results.
string (date-time)The start of the date range over which you want to search.
string (tzinfo)Time zone in which dates in the result will be rendered.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
string (date-time)The end of the date range over which you want to search.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
+ +```sql +SELECT +* +FROM pagerduty.incidents.log_entries +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND time_zone = '{{ time_zone }}' +AND since = '{{ since }}' +AND until = '{{ until }}' +AND is_overview = '{{ is_overview }}' +AND include[] = '{{ include[] }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
+ +```sql +EXEC pagerduty.incidents.log_entries._list_incident_log_entries +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@time_zone='{{ time_zone }}', +@since='{{ since }}', +@until='{{ until }}', +@is_overview={{ is_overview }}, +@include[]='{{ include[] }}' +; +``` + + diff --git a/website/docs/services/incidents/notes/index.md b/website/docs/services/incidents/notes/index.md new file mode 100644 index 0000000..f61f83e --- /dev/null +++ b/website/docs/services/incidents/notes/index.md @@ -0,0 +1,263 @@ +--- +title: notes +hide_title: false +hide_table_of_contents: false +keywords: + - notes + - incidents + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a notes resource. + +## Overview + + + + +
Namenotes
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +An array of notes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectThe means by which this Note was created. Has different formats depending on type.
stringThe note content
string (date-time)The time at which the note was submitted
objectThe user who created a Note. If a service created this Note the `user.type` will be "bot_user_reference" and `user.summary` will list the name of the service rather than the user.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
id, From, data__noteAccept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
idAccept, Content-TypeList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (email)The email address of a valid user associated with the account making the request.
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
+ +```sql +SELECT +id, +channel, +content, +created_at, +user +FROM pagerduty.incidents.notes +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
+ +```sql +INSERT INTO pagerduty.incidents.notes ( +data__note, +id, +From, +Accept, +Content-Type +) +SELECT +'{{ note }}' /* required */, +'{{ id }}', +'{{ From }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +note +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: notes + props: + - name: id + value: string + description: Required parameter for the notes resource. + - name: From + value: string (email) + description: Required parameter for the notes resource. + - name: note + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
+ +```sql +EXEC pagerduty.incidents.notes._list_incident_notes +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/incidents/outlier_incident/index.md b/website/docs/services/incidents/outlier_incident/index.md new file mode 100644 index 0000000..776d75d --- /dev/null +++ b/website/docs/services/incidents/outlier_incident/index.md @@ -0,0 +1,191 @@ +--- +title: outlier_incident +hide_title: false +hide_table_of_contents: false +keywords: + - outlier_incident + - incidents + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an outlier_incident resource. + +## Overview + + + + +
Nameoutlier_incident
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Outlier Incident information calculated over the same Service as the given Incident. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
object
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, since, additional_details[]Gets Outlier Incident information for a given Incident on its Service.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#outlier-incident)

Scoped OAuth requires: `incidents.read`
idAccept, Content-Type, since, additional_details[]Gets Outlier Incident information for a given Incident on its Service.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#outlier-incident)

Scoped OAuth requires: `incidents.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringArray of additional attributes to any of the returned incidents for related incidents.
string (date-time)The start of the date range over which you want to search.
+ +## `SELECT` examples + + + + +Gets Outlier Incident information for a given Incident on its Service.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#outlier-incident)

Scoped OAuth requires: `incidents.read`
+ +```sql +SELECT +incident, +incident_template +FROM pagerduty.incidents.outlier_incident +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND since = '{{ since }}' +AND additional_details[] = '{{ additional_details[] }}' +; +``` + + + + +## Lifecycle Methods + + + + +Gets Outlier Incident information for a given Incident on its Service.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#outlier-incident)

Scoped OAuth requires: `incidents.read`
+ +```sql +EXEC pagerduty.incidents.outlier_incident._get_outlier_incident +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@since='{{ since }}', +@additional_details[]='{{ additional_details[] }}' +; +``` + + diff --git a/website/docs/services/incidents/past_incidents/index.md b/website/docs/services/incidents/past_incidents/index.md new file mode 100644 index 0000000..d1fc90f --- /dev/null +++ b/website/docs/services/incidents/past_incidents/index.md @@ -0,0 +1,175 @@ +--- +title: past_incidents +hide_title: false +hide_table_of_contents: false +keywords: + - past_incidents + - incidents + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a past_incidents resource. + +## Overview + + + + +
Namepast_incidents
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectIncident model reference
numberThe computed similarity score associated with the incident and parent incident
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypePast 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#past_incidents)

Scoped OAuth requires: `incidents.read`
idAccept, Content-TypePast 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#past_incidents)

Scoped OAuth requires: `incidents.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#past_incidents)

Scoped OAuth requires: `incidents.read`
+ +```sql +SELECT +incident, +score +FROM pagerduty.incidents.past_incidents +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#past_incidents)

Scoped OAuth requires: `incidents.read`
+ +```sql +EXEC pagerduty.incidents.past_incidents._get_past_incidents +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/incidents/related_incidents/index.md b/website/docs/services/incidents/related_incidents/index.md new file mode 100644 index 0000000..819cbf4 --- /dev/null +++ b/website/docs/services/incidents/related_incidents/index.md @@ -0,0 +1,184 @@ +--- +title: related_incidents +hide_title: false +hide_table_of_contents: false +keywords: + - related_incidents + - incidents + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a related_incidents resource. + +## Overview + + + + +
Namerelated_incidents
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +A list of Related Incidents and their relationships. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectDetails of the incident.
arrayA list of reasons for why the Incident is considered related.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, additional_details[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#related_incidents)

Scoped OAuth requires: `incidents.read`
idAccept, Content-Type, additional_details[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#related_incidents)

Scoped OAuth requires: `incidents.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringArray of additional attributes to any of the returned incidents for related incidents.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#related_incidents)

Scoped OAuth requires: `incidents.read`
+ +```sql +SELECT +incident_details, +relationship_details +FROM pagerduty.incidents.related_incidents +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND additional_details[] = '{{ additional_details[] }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#related_incidents)

Scoped OAuth requires: `incidents.read`
+ +```sql +EXEC pagerduty.incidents.related_incidents._get_related_incidents +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@additional_details[]='{{ additional_details[] }}' +; +``` + + diff --git a/website/docs/services/incidents/status_updates_subscribers/index.md b/website/docs/services/incidents/status_updates_subscribers/index.md new file mode 100644 index 0000000..8c2385b --- /dev/null +++ b/website/docs/services/incidents/status_updates_subscribers/index.md @@ -0,0 +1,234 @@ +--- +title: status_updates_subscribers +hide_title: false +hide_table_of_contents: false +keywords: + - status_updates_subscribers + - incidents + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a status_updates_subscribers resource. + +## Overview + + + + +
Namestatus_updates_subscribers
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the entity being subscribed
booleanIf this subcriber has an indirect subscription to this incident via another object
array
stringThe type of the entity being subscribed
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAcceptRetrieve 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`
id, data__subscribersAcceptSubscribe the given entities to Incident Status Update Notifications.

Scoped OAuth requires: `subscribers.write`
idAcceptRetrieve 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`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
+ +## `SELECT` examples + + + + +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`
+ +```sql +SELECT +subscriber_id, +has_indirect_subscription, +subscribed_via, +subscriber_type +FROM pagerduty.incidents.status_updates_subscribers +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +; +``` + + + + +## `INSERT` examples + + + + +Subscribe the given entities to Incident Status Update Notifications.

Scoped OAuth requires: `subscribers.write`
+ +```sql +INSERT INTO pagerduty.incidents.status_updates_subscribers ( +data__subscribers, +id, +Accept +) +SELECT +'{{ subscribers }}' /* required */, +'{{ id }}', +'{{ Accept }}' +RETURNING +subscriptions +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: status_updates_subscribers + props: + - name: id + value: string + description: Required parameter for the status_updates_subscribers resource. + - name: subscribers + value: array + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. +``` + + + + +## Lifecycle Methods + + + + +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`
+ +```sql +EXEC pagerduty.incidents.status_updates_subscribers._get_incident_notification_subscribers +@id='{{ id }}' --required, +@Accept='{{ Accept }}' +; +``` + + diff --git a/website/docs/services/licenses/index.md b/website/docs/services/licenses/index.md new file mode 100644 index 0000000..1774d52 --- /dev/null +++ b/website/docs/services/licenses/index.md @@ -0,0 +1,33 @@ +--- +title: licenses +hide_title: false +hide_table_of_contents: false +keywords: + - licenses + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +licenses service documentation. + +:::info[Service Summary] + +total resources: __2__ + +::: + +## Resources +
+
+license_allocations +
+
+licenses +
+
\ No newline at end of file diff --git a/website/docs/services/licenses/license_allocations/index.md b/website/docs/services/licenses/license_allocations/index.md new file mode 100644 index 0000000..8f5be84 --- /dev/null +++ b/website/docs/services/licenses/license_allocations/index.md @@ -0,0 +1,190 @@ +--- +title: license_allocations +hide_title: false +hide_table_of_contents: false +keywords: + - license_allocations + - licenses + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a license_allocations resource. + +## Overview + + + + +
Namelicense_allocations
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +License allocations to Users within your Account + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (date-time)Indicates the date and time the License was allocated to the User
object
object
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Accept, Content-Type, limit, offsetList the Licenses allocated to Users within your Account

Scoped OAuth requires: `licenses.read`
Accept, Content-Type, limit, offsetList the Licenses allocated to Users within your Account

Scoped OAuth requires: `licenses.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe `Accept` header is used as a versioning header.
string
integerThe number of results per page.
integerOffset to start pagination search results.
+ +## `SELECT` examples + + + + +List the Licenses allocated to Users within your Account

Scoped OAuth requires: `licenses.read`
+ +```sql +SELECT +allocated_at, +license, +user +FROM pagerduty.licenses.license_allocations +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +; +``` + + + + +## Lifecycle Methods + + + + +List the Licenses allocated to Users within your Account

Scoped OAuth requires: `licenses.read`
+ +```sql +EXEC pagerduty.licenses.license_allocations._list_license_allocations +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}' +; +``` + + diff --git a/website/docs/services/licenses/licenses/index.md b/website/docs/services/licenses/licenses/index.md new file mode 100644 index 0000000..3aa6045 --- /dev/null +++ b/website/docs/services/licenses/licenses/index.md @@ -0,0 +1,224 @@ +--- +title: licenses +hide_title: false +hide_table_of_contents: false +keywords: + - licenses + - licenses + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a licenses resource. + +## Overview + + + + +
Namelicenses
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Licenses associated with your Account + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUniquely identifies the resource
stringName of the License.
integerHow many of these licenses are available to be allocated to a user. If this value is "null" then there is no limit on the number of allocations allowed.
integerHow many of these Licenses are currently allocated to Users
stringDescription of the License. May include the names of add-ons associated with the License, if there are any.
stringHTML URL to access the License
stringIndicates whether this License is assignable to full or stakeholder Users (example: FullUser)
stringAPI URL to access the License
stringSummary of the License
stringType of object
arrayThe roles a User with this License can have
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Accept, Content-TypeList the Licenses associated with your Account

Scoped OAuth requires: `licenses.read`
Accept, Content-TypeList the Licenses associated with your Account

Scoped OAuth requires: `licenses.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +List the Licenses associated with your Account

Scoped OAuth requires: `licenses.read`
+ +```sql +SELECT +id, +name, +allocations_available, +current_value, +description, +html_url, +role_group, +self, +summary, +type, +valid_roles +FROM pagerduty.licenses.licenses +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +List the Licenses associated with your Account

Scoped OAuth requires: `licenses.read`
+ +```sql +EXEC pagerduty.licenses.licenses._list_licenses +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/log_entries/index.md b/website/docs/services/log_entries/index.md new file mode 100644 index 0000000..19d25af --- /dev/null +++ b/website/docs/services/log_entries/index.md @@ -0,0 +1,33 @@ +--- +title: log_entries +hide_title: false +hide_table_of_contents: false +keywords: + - log_entries + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +log_entries service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+log_entries +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/log_entries/log_entries/index.md b/website/docs/services/log_entries/log_entries/index.md new file mode 100644 index 0000000..dc5fb20 --- /dev/null +++ b/website/docs/services/log_entries/log_entries/index.md @@ -0,0 +1,320 @@ +--- +title: log_entries +hide_title: false +hide_table_of_contents: false +keywords: + - log_entries + - log_entries + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a log_entries resource. + +## Overview + + + + +
Namelog_entries
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +A single log entry. + + + + + + + + + + + +
NameDatatypeDescription
+ + + +A paginated array of log entries. + + + + + + + + + + + +
NameDatatypeDescription
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, time_zone, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#log-entries)

Scoped OAuth requires: `incidents.read`
Accept, Content-Type, limit, offset, total, time_zone, since, until, is_overview, include[], team_ids[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#log-entries)

Scoped OAuth requires: `incidents.read`
Accept, Content-Type, limit, offset, total, time_zone, since, until, is_overview, include[], team_ids[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#log-entries)

Scoped OAuth requires: `incidents.read`
idAccept, Content-Type, time_zone, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#log-entries)

Scoped OAuth requires: `incidents.read`
id, From, channelAccept, Content-TypeUpdate an existing incident log entry channel.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#log-entries)

Scoped OAuth requires: `incidents.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (email)The email address of a valid user associated with the account making the request.
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringArray of additional Models to include in response.
booleanIf `true`, will return a subset of log entries that show only the most important changes to the incident.
integerThe number of results per page.
integerOffset to start pagination search results.
string (date-time)The start of the date range over which you want to search.
arrayAn array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter.
string (tzinfo)Time zone in which dates in the result will be rendered.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
string (date-time)The end of the date range over which you want to search.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#log-entries)

Scoped OAuth requires: `incidents.read`
+ +```sql +SELECT +* +FROM pagerduty.log_entries.log_entries +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND time_zone = '{{ time_zone }}' +AND include[] = '{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#log-entries)

Scoped OAuth requires: `incidents.read`
+ +```sql +SELECT +* +FROM pagerduty.log_entries.log_entries +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND time_zone = '{{ time_zone }}' +AND since = '{{ since }}' +AND until = '{{ until }}' +AND is_overview = '{{ is_overview }}' +AND include[] = '{{ include[] }}' +AND team_ids[] = '{{ team_ids[] }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#log-entries)

Scoped OAuth requires: `incidents.read`
+ +```sql +EXEC pagerduty.log_entries.log_entries._list_log_entries +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@time_zone='{{ time_zone }}', +@since='{{ since }}', +@until='{{ until }}', +@is_overview={{ is_overview }}, +@include[]='{{ include[] }}', +@team_ids[]='{{ team_ids[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#log-entries)

Scoped OAuth requires: `incidents.read`
+ +```sql +EXEC pagerduty.log_entries.log_entries._get_log_entry +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@time_zone='{{ time_zone }}', +@include[]='{{ include[] }}' +; +``` + + + +Update an existing incident log entry channel.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#log-entries)

Scoped OAuth requires: `incidents.write`
+ +```sql +EXEC pagerduty.log_entries.log_entries.update_log_entry_channel +@id='{{ id }}' --required, +@From='{{ From }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"channel": "{{ channel }}" +}' +; +``` + + diff --git a/website/docs/services/maintenance_windows/index.md b/website/docs/services/maintenance_windows/index.md new file mode 100644 index 0000000..4e7a984 --- /dev/null +++ b/website/docs/services/maintenance_windows/index.md @@ -0,0 +1,33 @@ +--- +title: maintenance_windows +hide_title: false +hide_table_of_contents: false +keywords: + - maintenance_windows + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +maintenance_windows service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+maintenance_windows +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/maintenance_windows/maintenance_windows/index.md b/website/docs/services/maintenance_windows/maintenance_windows/index.md new file mode 100644 index 0000000..ce6de3f --- /dev/null +++ b/website/docs/services/maintenance_windows/maintenance_windows/index.md @@ -0,0 +1,540 @@ +--- +title: maintenance_windows +hide_title: false +hide_table_of_contents: false +keywords: + - maintenance_windows + - maintenance_windows + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a maintenance_windows resource. + +## Overview + + + + +
Namemaintenance_windows
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The maintenance window that was updated. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
stringA description for this maintenance window.
string (date-time)This maintenance window's end time. This is when the services will start creating incidents again. This date must be in the future and after the `start_time`.
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
integerThe order in which the maintenance window was created.
array
string (date-time)This maintenance window's start time. This is when the services will stop creating incidents. If this date is in the past, it will be updated to be the current time.
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
array
stringThe type of object being created. (default: maintenance_window)
+ + + +A paginated array of maintenance windows. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
stringA description for this maintenance window.
string (date-time)This maintenance window's end time. This is when the services will start creating incidents again. This date must be in the future and after the `start_time`.
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
integerThe order in which the maintenance window was created.
array
string (date-time)This maintenance window's start time. This is when the services will stop creating incidents. If this date is in the past, it will be updated to be the current time.
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
array
stringThe type of object being created. (default: maintenance_window)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.read`
Accept, Content-Type, query, limit, offset, total, team_ids[], service_ids[], include[], filterList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.read`
From, data__maintenance_windowAccept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.write`
idAccept, Content-TypeDelete 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.write`
Accept, Content-Type, query, limit, offset, total, team_ids[], service_ids[], include[], filterList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.read`
idAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.read`
id, maintenance_windowAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (email)The email address of a valid user associated with the account making the request.
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringOnly return maintenance windows in a given state.
stringArray of additional Models to include in response.
integerThe number of results per page.
integerOffset to start pagination search results.
stringFilters the result, showing only the records whose name matches the query.
arrayAn array of service IDs. Only results related to these services will be returned.
arrayAn array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.read`
+ +```sql +SELECT +id, +created_by, +description, +end_time, +html_url, +self, +sequence_number, +services, +start_time, +summary, +teams, +type +FROM pagerduty.maintenance_windows.maintenance_windows +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND include[] = '{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.read`
+ +```sql +SELECT +id, +created_by, +description, +end_time, +html_url, +self, +sequence_number, +services, +start_time, +summary, +teams, +type +FROM pagerduty.maintenance_windows.maintenance_windows +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND query = '{{ query }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND team_ids[] = '{{ team_ids[] }}' +AND service_ids[] = '{{ service_ids[] }}' +AND include[] = '{{ include[] }}' +AND filter = '{{ filter }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.write`
+ +```sql +INSERT INTO pagerduty.maintenance_windows.maintenance_windows ( +data__maintenance_window, +From, +Accept, +Content-Type +) +SELECT +'{{ maintenance_window }}' /* required */, +'{{ From }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +maintenance_window +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: maintenance_windows + props: + - name: From + value: string (email) + description: Required parameter for the maintenance_windows resource. + - name: maintenance_window + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.write`
+ +```sql +DELETE FROM pagerduty.maintenance_windows.maintenance_windows +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.read`
+ +```sql +EXEC pagerduty.maintenance_windows.maintenance_windows._list_maintenance_windows +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@query='{{ query }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@team_ids[]='{{ team_ids[] }}', +@service_ids[]='{{ service_ids[] }}', +@include[]='{{ include[] }}', +@filter='{{ filter }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.read`
+ +```sql +EXEC pagerduty.maintenance_windows.maintenance_windows._get_maintenance_window +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@include[]='{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.write`
+ +```sql +EXEC pagerduty.maintenance_windows.maintenance_windows.update_maintenance_window +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"maintenance_window": "{{ maintenance_window }}" +}' +; +``` + + diff --git a/website/docs/services/notifications/index.md b/website/docs/services/notifications/index.md new file mode 100644 index 0000000..9732088 --- /dev/null +++ b/website/docs/services/notifications/index.md @@ -0,0 +1,33 @@ +--- +title: notifications +hide_title: false +hide_table_of_contents: false +keywords: + - notifications + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +notifications service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+notifications +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/notifications/notifications/index.md b/website/docs/services/notifications/notifications/index.md new file mode 100644 index 0000000..2d6d598 --- /dev/null +++ b/website/docs/services/notifications/notifications/index.md @@ -0,0 +1,262 @@ +--- +title: notifications +hide_title: false +hide_table_of_contents: false +keywords: + - notifications + - notifications + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a notifications resource. + +## Overview + + + + +
Namenotifications
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +A paginated array of notifications. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe address where the notification was sent. This will be null for notification type `push_notification`.
stringThe address of the conference bridge
string (date-time)The time at which the notification was sent
string
stringThe type of notification.
object
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
since, untilAccept, Content-Type, limit, offset, total, time_zone, filter, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#notifications)

Scoped OAuth requires: `users:notifications.read`
since, untilAccept, Content-Type, limit, offset, total, time_zone, filter, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#notifications)

Scoped OAuth requires: `users:notifications.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (date-time)The start of the date range over which you want to search. The time element is optional.
string (date-time)The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months.
stringThe `Accept` header is used as a versioning header.
string
stringReturn notification of this type only.
stringArray of additional details to include.
integerThe number of results per page.
integerOffset to start pagination search results.
string (tzinfo)Time zone in which dates in the result will be rendered.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#notifications)

Scoped OAuth requires: `users:notifications.read`
+ +```sql +SELECT +id, +, +address, +conferenceAddress, +started_at, +status, +type, +user +FROM pagerduty.notifications.notifications +WHERE since = '{{ since }}' -- required +AND until = '{{ until }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND time_zone = '{{ time_zone }}' +AND filter = '{{ filter }}' +AND include[] = '{{ include[] }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#notifications)

Scoped OAuth requires: `users:notifications.read`
+ +```sql +EXEC pagerduty.notifications.notifications._list_notifications +@since='{{ since }}' --required, +@until='{{ until }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@time_zone='{{ time_zone }}', +@filter='{{ filter }}', +@include[]='{{ include[] }}' +; +``` + + diff --git a/website/docs/services/on_calls/index.md b/website/docs/services/on_calls/index.md new file mode 100644 index 0000000..ca0c059 --- /dev/null +++ b/website/docs/services/on_calls/index.md @@ -0,0 +1,33 @@ +--- +title: on_calls +hide_title: false +hide_table_of_contents: false +keywords: + - on_calls + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +on_calls service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+oncalls +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/on_calls/oncalls/index.md b/website/docs/services/on_calls/oncalls/index.md new file mode 100644 index 0000000..7c0ac19 --- /dev/null +++ b/website/docs/services/on_calls/oncalls/index.md @@ -0,0 +1,271 @@ +--- +title: oncalls +hide_title: false +hide_table_of_contents: false +keywords: + - oncalls + - on_calls + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an oncalls resource. + +## Overview + + + + +
Nameoncalls
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +A paginated array of on-call objects. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (date-time)The end of the on-call. If `null`, the user does not go off-call.
integerThe escalation level for the on-call.
object
object
string (date-time)The start of the on-call. If `null`, the on-call is a permanent user on-call.
object
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Accept, Content-Type, time_zone, limit, offset, total, include[], user_ids[], escalation_policy_ids[], schedule_ids[], since, until, earliestList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#on-calls)

Scoped OAuth requires: `oncalls.read`
Accept, Content-Type, time_zone, limit, offset, total, include[], user_ids[], escalation_policy_ids[], schedule_ids[], since, until, earliestList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#on-calls)

Scoped OAuth requires: `oncalls.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe `Accept` header is used as a versioning header.
string
booleanThis will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.
arrayFilters the results, showing only on-calls for the specified escalation policy IDs.
stringArray of additional details to include.
integerThe number of results per page.
integerOffset to start pagination search results.
arrayFilters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets.
string (date-time)The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.
string (tzinfo)Time zone in which dates in the result will be rendered.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
string (date-time)The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time.
arrayFilters the results, showing only on-calls for the specified user IDs.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#on-calls)

Scoped OAuth requires: `oncalls.read`
+ +```sql +SELECT +end, +escalation_level, +escalation_policy, +schedule, +start, +user +FROM pagerduty.on_calls.oncalls +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND time_zone = '{{ time_zone }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND include[] = '{{ include[] }}' +AND user_ids[] = '{{ user_ids[] }}' +AND escalation_policy_ids[] = '{{ escalation_policy_ids[] }}' +AND schedule_ids[] = '{{ schedule_ids[] }}' +AND since = '{{ since }}' +AND until = '{{ until }}' +AND earliest = '{{ earliest }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#on-calls)

Scoped OAuth requires: `oncalls.read`
+ +```sql +EXEC pagerduty.on_calls.oncalls._list_on_calls +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@time_zone='{{ time_zone }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@include[]='{{ include[] }}', +@user_ids[]='{{ user_ids[] }}', +@escalation_policy_ids[]='{{ escalation_policy_ids[] }}', +@schedule_ids[]='{{ schedule_ids[] }}', +@since='{{ since }}', +@until='{{ until }}', +@earliest={{ earliest }} +; +``` + + diff --git a/website/docs/services/paused_incident_reports/alerts/index.md b/website/docs/services/paused_incident_reports/alerts/index.md new file mode 100644 index 0000000..1cb5a48 --- /dev/null +++ b/website/docs/services/paused_incident_reports/alerts/index.md @@ -0,0 +1,210 @@ +--- +title: alerts +hide_title: false +hide_table_of_contents: false +keywords: + - alerts + - paused_incident_reports + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an alerts resource. + +## Overview + + + + +
Namealerts
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Paused Incident Reporting on Alerts for the Account or scoped to a Service. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayAn array of Alerts that were resolved after being paused.
stringThe start of the date range over which the report data is represented.
arrayAn array of Alerts that were triggered after being paused.
stringThe end of the date range over which the report data is represented.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Accept, Content-Type, since, until, service_id, suspended_byReturns 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#paused-incident-reports)

Scoped OAuth requires: `incidents.read`
Accept, Content-Type, since, until, service_id, suspended_byReturns 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#paused-incident-reports)

Scoped OAuth requires: `incidents.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe `Accept` header is used as a versioning header.
string
stringSpecifies a filter to limit the scope of reporting to a particular service
string (date-time)The start of the date range over which you want to search.
Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules.
string (date-time)The end of the date range over which you want to search.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#paused-incident-reports)

Scoped OAuth requires: `incidents.read`
+ +```sql +SELECT +resolved_after_pause_alerts, +since, +triggered_after_pause_alerts, +until +FROM pagerduty.paused_incident_reports.alerts +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND since = '{{ since }}' +AND until = '{{ until }}' +AND service_id = '{{ service_id }}' +AND suspended_by = '{{ suspended_by }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#paused-incident-reports)

Scoped OAuth requires: `incidents.read`
+ +```sql +EXEC pagerduty.paused_incident_reports.alerts._get_paused_incident_report_alerts +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@since='{{ since }}', +@until='{{ until }}', +@service_id='{{ service_id }}', +@suspended_by='{{ suspended_by }}' +; +``` + + diff --git a/website/docs/services/paused_incident_reports/counts/index.md b/website/docs/services/paused_incident_reports/counts/index.md new file mode 100644 index 0000000..c87ec12 --- /dev/null +++ b/website/docs/services/paused_incident_reports/counts/index.md @@ -0,0 +1,216 @@ +--- +title: counts +hide_title: false +hide_table_of_contents: false +keywords: + - counts + - paused_incident_reports + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a counts resource. + +## Overview + + + + +
Namecounts
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Paused Incident Reporting counts for the Account or scoped to a Service. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
numberThe total number of paused Alerts for the Account or Servce.
numberThe total number of paused Alerts for the Account or Service that were resolved after being paused and not triggered (transient Alerts).
stringThe start of the date range over which the report data is represented.
numberThe total number of paused Alerts for the Account or Service that were triggerd after being paused (non-transient Alerts).
stringThe end of the date range over which the report data is represented.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Accept, Content-Type, since, until, service_id, suspended_byReturns 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#paused-incident-reports)

Scoped OAuth requires: `incidents.read`
Accept, Content-Type, since, until, service_id, suspended_byReturns 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#paused-incident-reports)

Scoped OAuth requires: `incidents.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe `Accept` header is used as a versioning header.
string
stringSpecifies a filter to limit the scope of reporting to a particular service
string (date-time)The start of the date range over which you want to search.
Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules.
string (date-time)The end of the date range over which you want to search.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#paused-incident-reports)

Scoped OAuth requires: `incidents.read`
+ +```sql +SELECT +paused_count, +resolved_after_pause_count, +since, +triggered_after_pause_count, +until +FROM pagerduty.paused_incident_reports.counts +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND since = '{{ since }}' +AND until = '{{ until }}' +AND service_id = '{{ service_id }}' +AND suspended_by = '{{ suspended_by }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#paused-incident-reports)

Scoped OAuth requires: `incidents.read`
+ +```sql +EXEC pagerduty.paused_incident_reports.counts._get_paused_incident_report_counts +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@since='{{ since }}', +@until='{{ until }}', +@service_id='{{ service_id }}', +@suspended_by='{{ suspended_by }}' +; +``` + + diff --git a/website/docs/services/paused_incident_reports/index.md b/website/docs/services/paused_incident_reports/index.md new file mode 100644 index 0000000..0d6f7eb --- /dev/null +++ b/website/docs/services/paused_incident_reports/index.md @@ -0,0 +1,33 @@ +--- +title: paused_incident_reports +hide_title: false +hide_table_of_contents: false +keywords: + - paused_incident_reports + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +paused_incident_reports service documentation. + +:::info[Service Summary] + +total resources: __2__ + +::: + +## Resources +
+
+alerts +
+
+counts +
+
\ No newline at end of file diff --git a/website/docs/services/priorities/index.md b/website/docs/services/priorities/index.md new file mode 100644 index 0000000..9b5ab99 --- /dev/null +++ b/website/docs/services/priorities/index.md @@ -0,0 +1,33 @@ +--- +title: priorities +hide_title: false +hide_table_of_contents: false +keywords: + - priorities + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +priorities service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+priorities +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/priorities/priorities/index.md b/website/docs/services/priorities/priorities/index.md new file mode 100644 index 0000000..edd283a --- /dev/null +++ b/website/docs/services/priorities/priorities/index.md @@ -0,0 +1,221 @@ +--- +title: priorities +hide_title: false +hide_table_of_contents: false +keywords: + - priorities + - priorities + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a priorities resource. + +## Overview + + + + +
Namepriorities
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +A paginated array of priorities. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe user-provided short name of the priority.
stringThe user-provided description of the priority.
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
stringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Accept, Content-Type, limit, offset, totalList existing priorities, in order (most to least severe).

A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#priorities)

Scoped OAuth requires: `priorities.read`
Accept, Content-Type, limit, offset, totalList existing priorities, in order (most to least severe).

A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#priorities)

Scoped OAuth requires: `priorities.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe `Accept` header is used as a versioning header.
string
integerThe number of results per page.
integerOffset to start pagination search results.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +List existing priorities, in order (most to least severe).

A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#priorities)

Scoped OAuth requires: `priorities.read`
+ +```sql +SELECT +id, +name, +description, +html_url, +self, +summary, +type +FROM pagerduty.priorities.priorities +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +; +``` + + + + +## Lifecycle Methods + + + + +List existing priorities, in order (most to least severe).

A priority is a label representing the importance and impact of an incident. This feature is only available on Standard and Enterprise plans.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#priorities)

Scoped OAuth requires: `priorities.read`
+ +```sql +EXEC pagerduty.priorities.priorities._list_priorities +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }} +; +``` + + diff --git a/website/docs/services/response_plays/index.md b/website/docs/services/response_plays/index.md new file mode 100644 index 0000000..6275445 --- /dev/null +++ b/website/docs/services/response_plays/index.md @@ -0,0 +1,33 @@ +--- +title: response_plays +hide_title: false +hide_table_of_contents: false +keywords: + - response_plays + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +response_plays service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+response_plays +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/response_plays/response_plays/index.md b/website/docs/services/response_plays/response_plays/index.md new file mode 100644 index 0000000..3d543ac --- /dev/null +++ b/website/docs/services/response_plays/response_plays/index.md @@ -0,0 +1,490 @@ +--- +title: response_plays +hide_title: false +hide_table_of_contents: false +keywords: + - response_plays + - response_plays + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a response_plays resource. + +## Overview + + + + +
Nameresponse_plays
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The Response Play requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the response play.
stringThe telephone number that will be set as the conference number for any incident on which this response play is run.
stringThis field has three possible values and indicates how the response play was created. - `none` : The response play had no conference_number or conference_url set at time of creation. - `manual` : The response play had one or both of conference_number and conference_url set at time of creation. - `zoom` : Customers with the Zoom-Integration Entitelment can use this value to dynamicly configure conference number and url for zoom (default: none)
stringThe URL that will be set as the conference URL for any incident on which this response play is run.
stringThe description of the response play.
string (url)a URL at which the entity is uniquely displayed in the Web app
arrayAn array containing the users and/or escalation policies to be requested as responders to any incident on which this response play is run.
stringThe message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent.
stringString representing how this response play is allowed to be run. Valid options are: - `services`: This response play cannot be manually run by any users. It will run automatically for new incidents triggered on any services that are configured with this response play. - `teams`: This response play can be run manually on an incident only by members of its configured team. This option can only be selected when the `team` property for this response play is not empty. - `responders`: This response play can be run manually on an incident by any responders in this account. (default: services)
string (url)the API show URL at which the object is accessible
arrayAn array containing the users and/or teams to be added as subscribers to any incident on which this response play is run.
stringThe content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent.
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
stringThe type of object being created. (default: response_play)
+ + + +The array of Response Plays returned by the query. + + + + + + + + + + + +
NameDatatypeDescription
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, FromGet details about an existing Response Play.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays)

When using a Global API token, the `From` header is required.
Scoped OAuth requires: `response_plays.read`
query, filter_for_manual_run, Accept, Content-Type, FromList all of the existing Response Plays.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays)

When using a Global API token, the `From` header is required.

Scoped OAuth requires: `response_plays.read`
From, data__response_playAccept, Content-TypeCreates a new Response Plays.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays)

Scoped OAuth requires: `response_plays.write`
id, FromAccept, Content-TypeDelete an existing Response Play. Once the Response Play is deleted, the action cannot be undone.

WARNING: When the Response Play is deleted, it is also removed from any Services that were using it.

Response Plays allow you to create packages of Incident Actions that can be applied to an Incident.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays)

Scoped OAuth requires: `response_plays.write`
query, filter_for_manual_run, Accept, Content-Type, FromList all of the existing Response Plays.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays)

When using a Global API token, the `From` header is required.

Scoped OAuth requires: `response_plays.read`
idAccept, Content-Type, FromGet details about an existing Response Play.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays)

When using a Global API token, the `From` header is required.
Scoped OAuth requires: `response_plays.read`
id, From, response_playAccept, Content-TypeUpdates an existing Response Play.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays)

Scoped OAuth requires: `response_plays.write`
response_play_id, From, incidentAccept, Content-TypeRun a specified response play on a given incident.

Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays)

Scoped OAuth requires: `response_plays.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (email)The email address of a valid user associated with the account making the request.
stringThe ID of the resource.
stringThe response play ID of the response play associated with the request.
stringThe `Accept` header is used as a versioning header.
string
string (email)The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.
booleanWhen this parameter is present, only those Response Plays that can be run manually will be returned.
stringFilters the result, showing only the records whose name matches the query.
+ +## `SELECT` examples + + + + +Get details about an existing Response Play.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays)

When using a Global API token, the `From` header is required.
Scoped OAuth requires: `response_plays.read`
+ +```sql +SELECT +id, +name, +conference_number, +conference_type, +conference_url, +description, +html_url, +responders, +responders_message, +runnability, +self, +subscribers, +subscribers_message, +summary, +team, +type +FROM pagerduty.response_plays.response_plays +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND From = '{{ From }}' +; +``` + + + +List all of the existing Response Plays.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays)

When using a Global API token, the `From` header is required.

Scoped OAuth requires: `response_plays.read`
+ +```sql +SELECT +* +FROM pagerduty.response_plays.response_plays +WHERE query = '{{ query }}' +AND filter_for_manual_run = '{{ filter_for_manual_run }}' +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND From = '{{ From }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates a new Response Plays.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays)

Scoped OAuth requires: `response_plays.write`
+ +```sql +INSERT INTO pagerduty.response_plays.response_plays ( +data__response_play, +From, +Accept, +Content-Type +) +SELECT +'{{ response_play }}' /* required */, +'{{ From }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +response_play +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: response_plays + props: + - name: From + value: string (email) + description: Required parameter for the response_plays resource. + - name: response_play + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +Delete an existing Response Play. Once the Response Play is deleted, the action cannot be undone.

WARNING: When the Response Play is deleted, it is also removed from any Services that were using it.

Response Plays allow you to create packages of Incident Actions that can be applied to an Incident.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays)

Scoped OAuth requires: `response_plays.write`
+ +```sql +DELETE FROM pagerduty.response_plays.response_plays +WHERE id = '{{ id }}' --required +AND From = '{{ From }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +List all of the existing Response Plays.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays)

When using a Global API token, the `From` header is required.

Scoped OAuth requires: `response_plays.read`
+ +```sql +EXEC pagerduty.response_plays.response_plays._list_response_plays +@query='{{ query }}', +@filter_for_manual_run={{ filter_for_manual_run }}, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@From='{{ From }}' +; +``` + + + +Get details about an existing Response Play.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays)

When using a Global API token, the `From` header is required.
Scoped OAuth requires: `response_plays.read`
+ +```sql +EXEC pagerduty.response_plays.response_plays._get_response_play +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@From='{{ From }}' +; +``` + + + +Updates an existing Response Play.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays)

Scoped OAuth requires: `response_plays.write`
+ +```sql +EXEC pagerduty.response_plays.response_plays.update_response_play +@id='{{ id }}' --required, +@From='{{ From }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"response_play": "{{ response_play }}" +}' +; +``` + + + +Run a specified response play on a given incident.

Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#response-plays)

Scoped OAuth requires: `response_plays.write`
+ +```sql +EXEC pagerduty.response_plays.response_plays.run_response_play +@response_play_id='{{ response_play_id }}' --required, +@From='{{ From }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"incident": "{{ incident }}" +}' +; +``` + + diff --git a/website/docs/services/rulesets/index.md b/website/docs/services/rulesets/index.md new file mode 100644 index 0000000..c40c21a --- /dev/null +++ b/website/docs/services/rulesets/index.md @@ -0,0 +1,33 @@ +--- +title: rulesets +hide_title: false +hide_table_of_contents: false +keywords: + - rulesets + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +rulesets service documentation. + +:::info[Service Summary] + +total resources: __2__ + +::: + +## Resources +
+
+rules +
+
+rulesets +
+
\ No newline at end of file diff --git a/website/docs/services/rulesets/rules/index.md b/website/docs/services/rulesets/rules/index.md new file mode 100644 index 0000000..1a268de --- /dev/null +++ b/website/docs/services/rulesets/rules/index.md @@ -0,0 +1,474 @@ +--- +title: rules +hide_title: false +hide_table_of_contents: false +keywords: + - rules + - rulesets + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a rules resource. + +## Overview + + + + +
Namerules
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The Event Rule object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the Event Rule.
objectWhen an event matches this Event Rule, the actions that will be taken to change the resulting Alert and Incident.
booleanIndicates whether the Event Rule is the last Event Rule of the Ruleset that serves as a catch-all. It has limited functionality compared to other rules and always matches.
objectConditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though.
booleanIndicates whether the Event Rule is disabled and would therefore not be evaluated.
integerPosition/index of the Event Rule in the Ruleset. Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching rule is found.
string (url)the API show URL at which the object is accessible.
objectTime-based conditions for limiting when the rule is active.
array[Early Access] Populate variables from event payloads and use those variables in other event actions.
+ + + +A paginated array of Event Rule objects. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the Event Rule.
objectWhen an event matches this Event Rule, the actions that will be taken to change the resulting Alert and Incident.
booleanIndicates whether the Event Rule is the last Event Rule of the Ruleset that serves as a catch-all. It has limited functionality compared to other rules and always matches.
objectConditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though.
booleanIndicates whether the Event Rule is disabled and would therefore not be evaluated.
integerPosition/index of the Event Rule in the Ruleset. Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching rule is found.
string (url)the API show URL at which the object is accessible.
objectTime-based conditions for limiting when the rule is active.
array[Early Access] Populate variables from event payloads and use those variables in other event actions.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, rule_idAccept, Content-TypeGet 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](https://developer.pagerduty.com/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`
idAccept, Content-Type, limit, offset, totalList 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](https://developer.pagerduty.com/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`
id, data__ruleAccept, Content-TypeCreate 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](https://developer.pagerduty.com/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`
id, rule_idAccept, Content-TypeDelete 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.write`
idAccept, Content-Type, limit, offset, totalList 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](https://developer.pagerduty.com/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`
id, rule_idAccept, Content-TypeGet 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](https://developer.pagerduty.com/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`
id, rule_id, rule_idAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/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`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe id of the Event Rule to retrieve.
stringThe `Accept` header is used as a versioning header.
string
integerThe number of results per page.
integerOffset to start pagination search results.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/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`
+ +```sql +SELECT +id, +actions, +catch_all, +conditions, +disabled, +position, +self, +time_frame, +variables +FROM pagerduty.rulesets.rules +WHERE id = '{{ id }}' -- required +AND rule_id = '{{ rule_id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/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`
+ +```sql +SELECT +id, +actions, +catch_all, +conditions, +disabled, +position, +self, +time_frame, +variables +FROM pagerduty.rulesets.rules +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/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`
+ +```sql +INSERT INTO pagerduty.rulesets.rules ( +data__rule, +id, +Accept, +Content-Type +) +SELECT +'{{ rule }}' /* required */, +'{{ id }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +rule +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: rules + props: + - name: id + value: string + description: Required parameter for the rules resource. + - name: rule + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.write`
+ +```sql +DELETE FROM pagerduty.rulesets.rules +WHERE id = '{{ id }}' --required +AND rule_id = '{{ rule_id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/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`
+ +```sql +EXEC pagerduty.rulesets.rules._list_ruleset_event_rules +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }} +; +``` + + + +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](https://developer.pagerduty.com/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`
+ +```sql +EXEC pagerduty.rulesets.rules._get_ruleset_event_rule +@id='{{ id }}' --required, +@rule_id='{{ rule_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/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`
+ +```sql +EXEC pagerduty.rulesets.rules.update_ruleset_event_rule +@id='{{ id }}' --required, +@rule_id='{{ rule_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"rule": "{{ rule }}", +"rule_id": "{{ rule_id }}" +}' +; +``` + + diff --git a/website/docs/services/rulesets/rulesets/index.md b/website/docs/services/rulesets/rulesets/index.md new file mode 100644 index 0000000..cb2bdb7 --- /dev/null +++ b/website/docs/services/rulesets/rulesets/index.md @@ -0,0 +1,469 @@ +--- +title: rulesets +hide_title: false +hide_table_of_contents: false +keywords: + - rulesets + - rulesets + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a rulesets resource. + +## Overview + + + + +
Namerulesets
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The Ruleset object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the Ruleset.
stringName of the Ruleset.
string (date-time)The date the Ruleset was created at.
objectReference to the user that has created the Ruleset.
arrayRouting keys routed to this Ruleset.
string (url)the API show URL at which the object is accessible
objectReference to the team that owns the Ruleset. If none is specified, only admins have access.
string
string (date-time)The date the Ruleset was last updated.
objectReference to the user that has updated the Ruleset last.
+ + + +A paginated array of Ruleset objects. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the Ruleset.
stringName of the Ruleset.
string (date-time)The date the Ruleset was created at.
objectReference to the user that has created the Ruleset.
arrayRouting keys routed to this Ruleset.
string (url)the API show URL at which the object is accessible
objectReference to the team that owns the Ruleset. If none is specified, only admins have access.
string
string (date-time)The date the Ruleset was last updated.
objectReference to the user that has updated the Ruleset last.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.read`
Accept, Content-Type, limit, offset, totalList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.read`
data__rulesetAccept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.write`
idAccept, Content-TypeDelete 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.write`
Accept, Content-Type, limit, offset, totalList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.read`
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.read`
id, rulesetAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
integerThe number of results per page.
integerOffset to start pagination search results.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.read`
+ +```sql +SELECT +id, +name, +created_at, +creator, +routing_keys, +self, +team, +type, +updated_at, +updater +FROM pagerduty.rulesets.rulesets +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.read`
+ +```sql +SELECT +id, +name, +created_at, +creator, +routing_keys, +self, +team, +type, +updated_at, +updater +FROM pagerduty.rulesets.rulesets +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.write`
+ +```sql +INSERT INTO pagerduty.rulesets.rulesets ( +data__ruleset, +Accept, +Content-Type +) +SELECT +'{{ ruleset }}' /* required */, +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +ruleset +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: rulesets + props: + - name: ruleset + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.write`
+ +```sql +DELETE FROM pagerduty.rulesets.rulesets +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.read`
+ +```sql +EXEC pagerduty.rulesets.rulesets._list_rulesets +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }} +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.read`
+ +```sql +EXEC pagerduty.rulesets.rulesets._get_ruleset +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.write`
+ +```sql +EXEC pagerduty.rulesets.rulesets.update_ruleset +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"ruleset": "{{ ruleset }}" +}' +; +``` + + diff --git a/website/docs/services/schedules/audit_records/index.md b/website/docs/services/schedules/audit_records/index.md new file mode 100644 index 0000000..cc35d48 --- /dev/null +++ b/website/docs/services/schedules/audit_records/index.md @@ -0,0 +1,247 @@ +--- +title: audit_records +hide_title: false +hide_table_of_contents: false +keywords: + - audit_records + - schedules + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an audit_records resource. + +## Overview + + + + +
Nameaudit_records
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Records matching the query criteria. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (example: create)
array
objectAdditional details to provide further information about the action or the resource that has been audited.
objectAction execution context
string (date-time)The date/time the action executed, in ISO8601 format and millisecond precision.
objectThe method information
object
stringRecord URL.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, limit, cursor, since, untilThe 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`
idAccept, Content-Type, limit, cursor, since, untilThe 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`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringOptional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set.
integerThe minimum of the `limit` parameter used in the request or the maximum request size of the API.
string (date-time)The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)
string (date-time)The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.
+ +## `SELECT` 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`
+ +```sql +SELECT +id, +action, +actors, +details, +execution_context, +execution_time, +method, +root_resource, +self +FROM pagerduty.schedules.audit_records +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND cursor = '{{ cursor }}' +AND since = '{{ since }}' +AND until = '{{ until }}' +; +``` + + + + +## Lifecycle Methods + + + + +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`
+ +```sql +EXEC pagerduty.schedules.audit_records._list_schedules_audit_records +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@cursor='{{ cursor }}', +@since='{{ since }}', +@until='{{ until }}' +; +``` + + diff --git a/website/docs/services/schedules/index.md b/website/docs/services/schedules/index.md new file mode 100644 index 0000000..0329850 --- /dev/null +++ b/website/docs/services/schedules/index.md @@ -0,0 +1,35 @@ +--- +title: schedules +hide_title: false +hide_table_of_contents: false +keywords: + - schedules + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +schedules service documentation. + +:::info[Service Summary] + +total resources: __4__ + +::: + +## Resources +
+
+audit_records
+overrides +
+
+schedules
+users +
+
\ No newline at end of file diff --git a/website/docs/services/schedules/overrides/index.md b/website/docs/services/schedules/overrides/index.md new file mode 100644 index 0000000..1ce8da0 --- /dev/null +++ b/website/docs/services/schedules/overrides/index.md @@ -0,0 +1,337 @@ +--- +title: overrides +hide_title: false +hide_table_of_contents: false +keywords: + - overrides + - schedules + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an overrides resource. + +## Overview + + + + +
Nameoverrides
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The collection of override objects returned by the query. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (date-time)The end date and time for the override.
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
string (date-time)The start date and time for the override.
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
stringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.
object
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, since, untilAccept, Content-Type, editable, overflowList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.read`
idAccept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
id, override_idAccept, Content-TypeRemove 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
id, since, untilAccept, Content-Type, editable, overflowList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe override ID on the schedule.
string (date-time)The start of the date range over which you want to search.
string (date-time)The end of the date range over which you want to search.
stringThe `Accept` header is used as a versioning header.
string
booleanWhen this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.
booleanAny on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.read`
+ +```sql +SELECT +id, +end, +html_url, +self, +start, +summary, +type, +user +FROM pagerduty.schedules.overrides +WHERE id = '{{ id }}' -- required +AND since = '{{ since }}' -- required +AND until = '{{ until }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND editable = '{{ editable }}' +AND overflow = '{{ overflow }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
+ +```sql +INSERT INTO pagerduty.schedules.overrides ( +data__overrides, +id, +Accept, +Content-Type +) +SELECT +'{{ overrides }}', +'{{ id }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +errors, +override, +status +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: overrides + props: + - name: id + value: string + description: Required parameter for the overrides resource. + - name: overrides + value: array + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
+ +```sql +DELETE FROM pagerduty.schedules.overrides +WHERE id = '{{ id }}' --required +AND override_id = '{{ override_id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.read`
+ +```sql +EXEC pagerduty.schedules.overrides._list_schedule_overrides +@id='{{ id }}' --required, +@since='{{ since }}' --required, +@until='{{ until }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@editable={{ editable }}, +@overflow={{ overflow }} +; +``` + + diff --git a/website/docs/services/schedules/schedules/index.md b/website/docs/services/schedules/schedules/index.md new file mode 100644 index 0000000..c6f0e48 --- /dev/null +++ b/website/docs/services/schedules/schedules/index.md @@ -0,0 +1,602 @@ +--- +title: schedules +hide_title: false +hide_table_of_contents: false +keywords: + - schedules + - schedules + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a schedules resource. + +## Overview + + + + +
Nameschedules
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The schedule object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the schedule
stringThe description of the schedule
arrayAn array of all of the escalation policies that uses this schedule.
object
string (url)a URL at which the entity is uniquely displayed in the Web app
object
arrayA list of schedule layers.
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
arrayAn array of all of the teams on the schedule.
string (activesupport-time-zone)The time zone of the schedule.
stringThe type of object being created. (default: schedule)
arrayAn array of all of the users on the schedule.
+ + + +A paginated array of schedule objects. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the schedule
stringThe description of the schedule
arrayAn array of all of the escalation policies that uses this schedule.
object
string (url)a URL at which the entity is uniquely displayed in the Web app
object
arrayA list of schedule layers.
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
arrayAn array of all of the teams on the schedule.
string (activesupport-time-zone)The time zone of the schedule.
stringThe type of object being created. (default: schedule)
arrayAn array of all of the users on the schedule.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, time_zone, since, untilShow detailed information about a schedule, including entries for each layer and sub-schedule.
Scoped OAuth requires: `schedules.read`
Accept, Content-Type, limit, offset, total, query, include[]List the on-call schedules.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.read`
data__scheduleAccept, Content-Type, overflowCreate a new on-call schedule.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
data__scheduleAccept, Content-Type, since, until, overflowPreview 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
idAccept, Content-TypeDelete an on-call schedule.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
Accept, Content-Type, limit, offset, total, query, include[]List the on-call schedules.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.read`
idAccept, Content-Type, time_zone, since, untilShow detailed information about a schedule, including entries for each layer and sub-schedule.
Scoped OAuth requires: `schedules.read`
id, scheduleAccept, Content-Type, overflowUpdate an existing on-call schedule.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringArray of additional details to include.
integerThe number of results per page.
integerOffset to start pagination search results.
booleanAny on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`.
stringFilters the result, showing only the records whose name matches the query.
string (date-time)The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given.
string (tzinfo)Time zone in which dates in the result will be rendered.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
string (date-time)The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given.
+ +## `SELECT` examples + + + + +Show detailed information about a schedule, including entries for each layer and sub-schedule.
Scoped OAuth requires: `schedules.read`
+ +```sql +SELECT +id, +name, +description, +escalation_policies, +final_schedule, +html_url, +overrides_subschedule, +schedule_layers, +self, +summary, +teams, +time_zone, +type, +users +FROM pagerduty.schedules.schedules +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND time_zone = '{{ time_zone }}' +AND since = '{{ since }}' +AND until = '{{ until }}' +; +``` + + + +List the on-call schedules.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.read`
+ +```sql +SELECT +id, +name, +description, +escalation_policies, +final_schedule, +html_url, +overrides_subschedule, +schedule_layers, +self, +summary, +teams, +time_zone, +type, +users +FROM pagerduty.schedules.schedules +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND query = '{{ query }}' +AND include[] = '{{ include[] }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
+ +```sql +INSERT INTO pagerduty.schedules.schedules ( +data__schedule, +Accept, +Content-Type, +overflow +) +SELECT +'{{ schedule }}' /* required */, +'{{ Accept }}', +'{{ Content-Type }}', +'{{ overflow }}' +RETURNING +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
+ +```sql +INSERT INTO pagerduty.schedules.schedules ( +data__schedule, +Accept, +Content-Type, +since, +until, +overflow +) +SELECT +'{{ schedule }}' /* required */, +'{{ Accept }}', +'{{ Content-Type }}', +'{{ since }}', +'{{ until }}', +'{{ overflow }}' +RETURNING +schedule +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: schedules + props: + - name: schedule + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string + - name: overflow + value: boolean + description: Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. + - name: since + value: string (date-time) + description: The start of the date range over which you want to search. + - name: until + value: string (date-time) + description: The end of the date range over which you want to search. +``` + + + + +## `DELETE` examples + + + + +Delete an on-call schedule.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
+ +```sql +DELETE FROM pagerduty.schedules.schedules +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +List the on-call schedules.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.read`
+ +```sql +EXEC pagerduty.schedules.schedules._list_schedules +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@query='{{ query }}', +@include[]='{{ include[] }}' +; +``` + + + +Show detailed information about a schedule, including entries for each layer and sub-schedule.
Scoped OAuth requires: `schedules.read`
+ +```sql +EXEC pagerduty.schedules.schedules._get_schedule +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@time_zone='{{ time_zone }}', +@since='{{ since }}', +@until='{{ until }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
+ +```sql +EXEC pagerduty.schedules.schedules.update_schedule +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@overflow={{ overflow }} +@@json= +'{ +"schedule": "{{ schedule }}" +}' +; +``` + + diff --git a/website/docs/services/schedules/users/index.md b/website/docs/services/schedules/users/index.md new file mode 100644 index 0000000..114800c --- /dev/null +++ b/website/docs/services/schedules/users/index.md @@ -0,0 +1,287 @@ +--- +title: users +hide_title: false +hide_table_of_contents: false +keywords: + - users + - schedules + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a users resource. + +## Overview + + + + +
Nameusers
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The users on the given schedule. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the user.
string (url)The URL of the user's avatar.
stringThe schedule color.
arrayThe list of contact methods for the user.
stringThe user's bio.
string (email)The user's email address.
string (url)a URL at which the entity is uniquely displayed in the Web app
booleanIf true, the user has an outstanding invitation.
stringThe user's title.
objectThe License assigned to the User
arrayThe list of notification rules for the user.
stringThe user role. Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`.
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
arrayThe list of teams to which the user belongs. Account must have the `teams` ability to set this.
string (tzinfo)The preferred time zone name. If null, the account's time zone will be used.
stringThe type of object being created. (default: user)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, since, untilList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `users.read`
idAccept, Content-Type, since, untilList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `users.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
string (date-time)The start of the date range over which you want to search.
string (date-time)The end of the date range over which you want to search.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `users.read`
+ +```sql +SELECT +id, +name, +avatar_url, +color, +contact_methods, +description, +email, +html_url, +invitation_sent, +job_title, +license, +notification_rules, +role, +self, +summary, +teams, +time_zone, +type +FROM pagerduty.schedules.users +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND since = '{{ since }}' +AND until = '{{ until }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules)

Scoped OAuth requires: `users.read`
+ +```sql +EXEC pagerduty.schedules.users._list_schedule_users +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@since='{{ since }}', +@until='{{ until }}' +; +``` + + diff --git a/website/docs/services/service_dependencies/business_services/index.md b/website/docs/services/service_dependencies/business_services/index.md new file mode 100644 index 0000000..45bfefc --- /dev/null +++ b/website/docs/services/service_dependencies/business_services/index.md @@ -0,0 +1,189 @@ +--- +title: business_services +hide_title: false +hide_table_of_contents: false +keywords: + - business_services + - service_dependencies + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a business_services resource. + +## Overview + + + + +
Namebusiness_services
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +An array of service relationships. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectThe reference to the service that is dependent on the Business Service.
objectThe reference to the service that supports the Business Service.
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.read`
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.read`
+ +```sql +SELECT +id, +dependent_service, +supporting_service, +type +FROM pagerduty.service_dependencies.business_services +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.read`
+ +```sql +EXEC pagerduty.service_dependencies.business_services._get_business_service_service_dependencies +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/service_dependencies/index.md b/website/docs/services/service_dependencies/index.md new file mode 100644 index 0000000..ad3cba5 --- /dev/null +++ b/website/docs/services/service_dependencies/index.md @@ -0,0 +1,33 @@ +--- +title: service_dependencies +hide_title: false +hide_table_of_contents: false +keywords: + - service_dependencies + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +service_dependencies service documentation. + +:::info[Service Summary] + +total resources: __2__ + +::: + +## Resources +
+
+business_services +
+
+technical_services +
+
\ No newline at end of file diff --git a/website/docs/services/service_dependencies/technical_services/index.md b/website/docs/services/service_dependencies/technical_services/index.md new file mode 100644 index 0000000..e98bc01 --- /dev/null +++ b/website/docs/services/service_dependencies/technical_services/index.md @@ -0,0 +1,267 @@ +--- +title: technical_services +hide_title: false +hide_table_of_contents: false +keywords: + - technical_services + - service_dependencies + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a technical_services resource. + +## Overview + + + + +
Nametechnical_services
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +An array of service relationships. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectThe reference to the service that is dependent on the technical service.
objectThe reference to the service that supports the technical service.
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet all immediate dependencies of any technical service.
Technical services are also known as `services`.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.read`
Accept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.write`
Accept, Content-TypeDisassociate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.write`
idAccept, Content-TypeGet all immediate dependencies of any technical service.
Technical services are also known as `services`.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +Get all immediate dependencies of any technical service.
Technical services are also known as `services`.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.read`
+ +```sql +SELECT +id, +dependent_service, +supporting_service, +type +FROM pagerduty.service_dependencies.technical_services +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.write`
+ +```sql +INSERT INTO pagerduty.service_dependencies.technical_services ( +data__relationships, +Accept, +Content-Type +) +SELECT +'{{ relationships }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +relationships +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: technical_services + props: + - name: relationships + value: array + description: | + List of all service dependencies to be created. + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#business-services)

Scoped OAuth requires: `services.write`
+ +```sql +EXEC pagerduty.service_dependencies.technical_services.delete_service_dependency +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"relationships": "{{ relationships }}" +}' +; +``` + + + +Get all immediate dependencies of any technical service.
Technical services are also known as `services`.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.read`
+ +```sql +EXEC pagerduty.service_dependencies.technical_services._get_technical_service_service_dependencies +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/services/audit_records/index.md b/website/docs/services/services/audit_records/index.md new file mode 100644 index 0000000..82391e2 --- /dev/null +++ b/website/docs/services/services/audit_records/index.md @@ -0,0 +1,247 @@ +--- +title: audit_records +hide_title: false +hide_table_of_contents: false +keywords: + - audit_records + - services + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an audit_records resource. + +## Overview + + + + +
Nameaudit_records
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Records matching the query criteria. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (example: create)
array
objectAdditional details to provide further information about the action or the resource that has been audited.
objectAction execution context
string (date-time)The date/time the action executed, in ISO8601 format and millisecond precision.
objectThe method information
object
stringRecord URL.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, limit, cursor, since, untilThe 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`
idAccept, Content-Type, limit, cursor, since, untilThe 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`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringOptional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set.
integerThe minimum of the `limit` parameter used in the request or the maximum request size of the API.
string (date-time)The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)
string (date-time)The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.
+ +## `SELECT` 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`
+ +```sql +SELECT +id, +action, +actors, +details, +execution_context, +execution_time, +method, +root_resource, +self +FROM pagerduty.services.audit_records +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND cursor = '{{ cursor }}' +AND since = '{{ since }}' +AND until = '{{ until }}' +; +``` + + + + +## Lifecycle Methods + + + + +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`
+ +```sql +EXEC pagerduty.services.audit_records._list_service_audit_records +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@cursor='{{ cursor }}', +@since='{{ since }}', +@until='{{ until }}' +; +``` + + diff --git a/website/docs/services/services/index.md b/website/docs/services/services/index.md new file mode 100644 index 0000000..af32a55 --- /dev/null +++ b/website/docs/services/services/index.md @@ -0,0 +1,35 @@ +--- +title: services +hide_title: false +hide_table_of_contents: false +keywords: + - services + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +services service documentation. + +:::info[Service Summary] + +total resources: __4__ + +::: + +## Resources +
+
+audit_records
+integrations +
+
+rules
+services +
+
\ No newline at end of file diff --git a/website/docs/services/services/integrations/index.md b/website/docs/services/services/integrations/index.md new file mode 100644 index 0000000..1558543 --- /dev/null +++ b/website/docs/services/services/integrations/index.md @@ -0,0 +1,352 @@ +--- +title: integrations +hide_title: false +hide_table_of_contents: false +keywords: + - integrations + - services + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an integrations resource. + +## Overview + + + + +
Nameintegrations
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The integration that was requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of this integration.
string (date-time)The date/time when this integration was created.
stringSpecify for generic_email_inbound_integration. May override email_incident_creation
arraySpecify for generic_email_inbound_integration.
stringSpecify for generic_email_inbound_integration
arraySpecify for generic_email_inbound_integration.
stringSpecify for generic_email_inbound_integration.
string (url)a URL at which the entity is uniquely displayed in the Web app
stringSpecify for generic_email_inbound_integration. Must be set to an email address @your-subdomain.pagerduty.com
string (url)the API show URL at which the object is accessible
object
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
string
object
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, integration_idAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.read`
id, data__integrationAccept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.write`
id, integration_id, integrationAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.write`
id, integration_idAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe integration ID on the service.
stringThe `Accept` header is used as a versioning header.
string
stringArray of additional details to include.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.read`
+ +```sql +SELECT +id, +name, +created_at, +email_filter_mode, +email_filters, +email_incident_creation, +email_parsers, +email_parsing_fallback, +html_url, +integration_email, +self, +service, +summary, +type, +vendor +FROM pagerduty.services.integrations +WHERE id = '{{ id }}' -- required +AND integration_id = '{{ integration_id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND include[] = '{{ include[] }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.write`
+ +```sql +INSERT INTO pagerduty.services.integrations ( +data__integration, +id, +Accept, +Content-Type +) +SELECT +'{{ integration }}' /* required */, +'{{ id }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +integration +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: integrations + props: + - name: id + value: string + description: Required parameter for the integrations resource. + - name: integration + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.write`
+ +```sql +EXEC pagerduty.services.integrations.update_service_integration +@id='{{ id }}' --required, +@integration_id='{{ integration_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"integration": "{{ 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.read`
+ +```sql +EXEC pagerduty.services.integrations._get_service_integration +@id='{{ id }}' --required, +@integration_id='{{ integration_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@include[]='{{ include[] }}' +; +``` + + diff --git a/website/docs/services/services/rules/index.md b/website/docs/services/services/rules/index.md new file mode 100644 index 0000000..1c40fd2 --- /dev/null +++ b/website/docs/services/services/rules/index.md @@ -0,0 +1,462 @@ +--- +title: rules +hide_title: false +hide_table_of_contents: false +keywords: + - rules + - services + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a rules resource. + +## Overview + + + + +
Namerules
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The Event Rule object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the Event Rule.
objectWhen an event matches this Event Rule, the actions that will be taken to change the resulting Alert and Incident.
objectConditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though.
booleanIndicates whether the Event Rule is disabled and would therefore not be evaluated.
integerPosition/index of the Event Rule on the Service. Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching Event Rule is found or the end of the list is reached.
string (url)the API show URL at which the object is accessible.
objectTime-based conditions for limiting when the rule is active.
array[Early Access] Populate variables from event payloads and use those variables in other event actions.
+ + + +A paginated array of Event Rule objects. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the Event Rule.
objectWhen an event matches this Event Rule, the actions that will be taken to change the resulting Alert and Incident.
objectConditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though.
booleanIndicates whether the Event Rule is disabled and would therefore not be evaluated.
integerPosition/index of the Event Rule on the Service. Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching Event Rule is found or the end of the list is reached.
string (url)the API show URL at which the object is accessible.
objectTime-based conditions for limiting when the rule is active.
array[Early Access] Populate variables from event payloads and use those variables in other event actions.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, rule_idAccept, Content-TypeGet 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`
idAccept, Content-Type, limit, offset, totalList 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`
id, data__ruleAccept, Content-TypeCreate 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`
id, rule_idAccept, Content-TypeDelete 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`
idAccept, Content-Type, limit, offset, totalList 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`
id, rule_idAccept, Content-TypeGet 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`
id, rule_id, rule_idAccept, Content-TypeUpdate 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`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe id of the Event Rule to retrieve.
stringThe `Accept` header is used as a versioning header.
string
integerThe number of results per page.
integerOffset to start pagination search results.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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`
+ +```sql +SELECT +id, +actions, +conditions, +disabled, +position, +self, +time_frame, +variables +FROM pagerduty.services.rules +WHERE id = '{{ id }}' -- required +AND rule_id = '{{ rule_id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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`
+ +```sql +SELECT +id, +actions, +conditions, +disabled, +position, +self, +time_frame, +variables +FROM pagerduty.services.rules +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +; +``` + + + + +## `INSERT` examples + + + + +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`
+ +```sql +INSERT INTO pagerduty.services.rules ( +data__rule, +id, +Accept, +Content-Type +) +SELECT +'{{ rule }}' /* required */, +'{{ id }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +rule +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: rules + props: + - name: id + value: string + description: Required parameter for the rules resource. + - name: rule + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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`
+ +```sql +DELETE FROM pagerduty.services.rules +WHERE id = '{{ id }}' --required +AND rule_id = '{{ rule_id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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`
+ +```sql +EXEC pagerduty.services.rules._list_service_event_rules +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }} +; +``` + + + +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`
+ +```sql +EXEC pagerduty.services.rules._get_service_event_rule +@id='{{ id }}' --required, +@rule_id='{{ rule_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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`
+ +```sql +EXEC pagerduty.services.rules.update_service_event_rule +@id='{{ id }}' --required, +@rule_id='{{ rule_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"rule": "{{ rule }}", +"rule_id": "{{ rule_id }}" +}' +; +``` + + diff --git a/website/docs/services/services/services/index.md b/website/docs/services/services/services/index.md new file mode 100644 index 0000000..ac9769a --- /dev/null +++ b/website/docs/services/services/services/index.md @@ -0,0 +1,686 @@ +--- +title: services +hide_title: false +hide_table_of_contents: false +keywords: + - services + - services + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a services resource. + +## Overview + + + + +
Nameservices
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The service requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the service.
integerTime in seconds that an incident changes to the Triggered State after being Acknowledged. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature.
arrayThe array of Add-ons associated with this service.
stringWhether a service creates only incidents, or both alerts and incidents. A service must create alerts in order to enable incident merging. * "create_incidents" - The service will create one incident and zero alerts for each incoming event. * "create_alerts_and_incidents" - The service will create one incident and one associated alert for each incoming event.
stringDefines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. There are three available options: * null - No alert grouping on the service. Each alert will create a separate incident; * "time" - All alerts within a specified duration will be grouped into the same incident. This duration is set in the `alert_grouping_timeout` setting (described below). Available on Standard, Enterprise, and Event Intelligence plans; * "intelligent" - Alerts will be intelligently grouped based on a machine learning model that looks at the alert summary, timing, and the history of grouped alerts. Available on Enterprise and Event Intelligence plans
objectDefines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. To turn grouping off set the type to null.
integerThe duration in minutes within which to automatically group incoming alerts. This setting applies only when `alert_grouping` is set to `time`. To continue grouping alerts until the Incident is resolved, set this value to `0`.
objectDefines how alerts on this service are automatically suspended for a period of time before triggering, when identified as likely being transient. Note that automatically pausing notifications is only available on certain plans. (title: AutoPauseNotificationsParameters)
integerTime in seconds that an incident is automatically resolved if left open for that long. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature.
string (date-time)The date/time when this service was created
stringThe user-provided description of the service.
object
string (url)a URL at which the entity is uniquely displayed in the Web app
object
arrayAn array containing Integration objects that belong to this service. If `integrations` is passed as an argument, these are full objects - otherwise, these are references.
string (date-time)The date/time when the most recent incident was created for this service.
objectResponse plays associated with this service.
arrayAn array containing scheduled actions for the service.
string (url)the API show URL at which the object is accessible
stringThe current state of the Service. Valid statuses are: - `active`: The service is enabled and has no open incidents. This is the only status a service can be created with. - `warning`: The service is enabled and has one or more acknowledged incidents. - `critical`: The service is enabled and has one or more triggered incidents. - `maintenance`: The service is under maintenance, no new incidents will be triggered during maintenance mode. - `disabled`: The service is disabled and will not have any new triggered incidents. (default: active)
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
object
arrayThe set of teams associated with this service.
stringThe type of object being created. (default: service)
+ + + +A paginated array of services. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the service.
integerTime in seconds that an incident changes to the Triggered State after being Acknowledged. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature.
arrayThe array of Add-ons associated with this service.
stringWhether a service creates only incidents, or both alerts and incidents. A service must create alerts in order to enable incident merging. * "create_incidents" - The service will create one incident and zero alerts for each incoming event. * "create_alerts_and_incidents" - The service will create one incident and one associated alert for each incoming event.
stringDefines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. There are three available options: * null - No alert grouping on the service. Each alert will create a separate incident; * "time" - All alerts within a specified duration will be grouped into the same incident. This duration is set in the `alert_grouping_timeout` setting (described below). Available on Standard, Enterprise, and Event Intelligence plans; * "intelligent" - Alerts will be intelligently grouped based on a machine learning model that looks at the alert summary, timing, and the history of grouped alerts. Available on Enterprise and Event Intelligence plans
objectDefines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. To turn grouping off set the type to null.
integerThe duration in minutes within which to automatically group incoming alerts. This setting applies only when `alert_grouping` is set to `time`. To continue grouping alerts until the Incident is resolved, set this value to `0`.
objectDefines how alerts on this service are automatically suspended for a period of time before triggering, when identified as likely being transient. Note that automatically pausing notifications is only available on certain plans. (title: AutoPauseNotificationsParameters)
integerTime in seconds that an incident is automatically resolved if left open for that long. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature.
string (date-time)The date/time when this service was created
stringThe user-provided description of the service.
object
string (url)a URL at which the entity is uniquely displayed in the Web app
object
arrayAn array containing Integration objects that belong to this service. If `integrations` is passed as an argument, these are full objects - otherwise, these are references.
string (date-time)The date/time when the most recent incident was created for this service.
objectResponse plays associated with this service.
arrayAn array containing scheduled actions for the service.
string (url)the API show URL at which the object is accessible
stringThe current state of the Service. Valid statuses are: - `active`: The service is enabled and has no open incidents. This is the only status a service can be created with. - `warning`: The service is enabled and has one or more acknowledged incidents. - `critical`: The service is enabled and has one or more triggered incidents. - `maintenance`: The service is under maintenance, no new incidents will be triggered during maintenance mode. - `disabled`: The service is disabled and will not have any new triggered incidents. (default: active)
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
object
arrayThe set of teams associated with this service.
stringThe type of object being created. (default: service)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.read`
Accept, Content-Type, query, limit, offset, total, team_ids[], time_zone, sort_by, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.read`
data__serviceAccept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.write`
idAccept, Content-TypeDelete 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.write`
Accept, Content-Type, query, limit, offset, total, team_ids[], time_zone, sort_by, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.read`
idAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.read`
id, serviceAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringArray of additional details to include.
integerThe number of results per page.
integerOffset to start pagination search results.
stringFilters the result, showing only the records whose name matches the query.
stringUsed to specify the field you wish to sort the results on.
arrayAn array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter.
string (tzinfo)Time zone in which dates in the result will be rendered.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.read`
+ +```sql +SELECT +id, +name, +acknowledgement_timeout, +addons, +alert_creation, +alert_grouping, +alert_grouping_parameters, +alert_grouping_timeout, +auto_pause_notifications_parameters, +auto_resolve_timeout, +created_at, +description, +escalation_policy, +html_url, +incident_urgency_rule, +integrations, +last_incident_timestamp, +response_play, +scheduled_actions, +self, +status, +summary, +support_hours, +teams, +type +FROM pagerduty.services.services +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND include[] = '{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.read`
+ +```sql +SELECT +id, +name, +acknowledgement_timeout, +addons, +alert_creation, +alert_grouping, +alert_grouping_parameters, +alert_grouping_timeout, +auto_pause_notifications_parameters, +auto_resolve_timeout, +created_at, +description, +escalation_policy, +html_url, +incident_urgency_rule, +integrations, +last_incident_timestamp, +response_play, +scheduled_actions, +self, +status, +summary, +support_hours, +teams, +type +FROM pagerduty.services.services +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND query = '{{ query }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND team_ids[] = '{{ team_ids[] }}' +AND time_zone = '{{ time_zone }}' +AND sort_by = '{{ sort_by }}' +AND include[] = '{{ include[] }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.write`
+ +```sql +INSERT INTO pagerduty.services.services ( +data__service, +Accept, +Content-Type +) +SELECT +'{{ service }}' /* required */, +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +service +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: services + props: + - name: service + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.write`
+ +```sql +DELETE FROM pagerduty.services.services +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.read`
+ +```sql +EXEC pagerduty.services.services._list_services +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@query='{{ query }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@team_ids[]='{{ team_ids[] }}', +@time_zone='{{ time_zone }}', +@sort_by='{{ sort_by }}', +@include[]='{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.read`
+ +```sql +EXEC pagerduty.services.services._get_service +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@include[]='{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#services)

Scoped OAuth requires: `services.write`
+ +```sql +EXEC pagerduty.services.services.update_service +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"service": "{{ service }}" +}' +; +``` + + diff --git a/website/docs/services/status_dashboards/index.md b/website/docs/services/status_dashboards/index.md new file mode 100644 index 0000000..6c0aca5 --- /dev/null +++ b/website/docs/services/status_dashboards/index.md @@ -0,0 +1,35 @@ +--- +title: status_dashboards +hide_title: false +hide_table_of_contents: false +keywords: + - status_dashboards + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +status_dashboards service documentation. + +:::info[Service Summary] + +total resources: __4__ + +::: + +## Resources +
+
+service_impacts
+status_dashboards +
+
+url_slugs
+url_slugs_service_impacts +
+
\ No newline at end of file diff --git a/website/docs/services/status_dashboards/service_impacts/index.md b/website/docs/services/status_dashboards/service_impacts/index.md new file mode 100644 index 0000000..b6fc7da --- /dev/null +++ b/website/docs/services/status_dashboards/service_impacts/index.md @@ -0,0 +1,200 @@ +--- +title: service_impacts +hide_title: false +hide_table_of_contents: false +keywords: + - service_impacts + - status_dashboards + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a service_impacts resource. + +## Overview + + + + +
Nameservice_impacts
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
stringThe current impact status of the object
stringThe kind of object that has been impacted
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, X-EARLY-ACCESSAccept, additional_fields[]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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
id, X-EARLY-ACCESSAccept, additional_fields[]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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
stringProvides access to additional fields such as highest priority per business service and total impacted count
+ +## `SELECT` examples + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +SELECT +id, +name, +additional_fields, +status, +type +FROM pagerduty.status_dashboards.service_impacts +WHERE id = '{{ id }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND Accept = '{{ Accept }}' +AND additional_fields[] = '{{ additional_fields[] }}' +; +``` + + + + +## Lifecycle Methods + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +EXEC pagerduty.status_dashboards.service_impacts._get_status_dashboard_service_impacts_by_id +@id='{{ id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@Accept='{{ Accept }}', +@additional_fields[]='{{ additional_fields[] }}' +; +``` + + diff --git a/website/docs/services/status_dashboards/status_dashboards/index.md b/website/docs/services/status_dashboards/status_dashboards/index.md new file mode 100644 index 0000000..c1a168d --- /dev/null +++ b/website/docs/services/status_dashboards/status_dashboards/index.md @@ -0,0 +1,253 @@ +--- +title: status_dashboards +hide_title: false +hide_table_of_contents: false +keywords: + - status_dashboards + - status_dashboards + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a status_dashboards resource. + +## Overview + + + + +
Namestatus_dashboards
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, X-EARLY-ACCESSAcceptGet a Status Dashboard by its PagerDuty `id`.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
X-EARLY-ACCESSAcceptGet all your account's custom Status Dashboard views

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
X-EARLY-ACCESSAcceptGet all your account's custom Status Dashboard views

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
id, X-EARLY-ACCESSAcceptGet a Status Dashboard by its PagerDuty `id`.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
+ +## `SELECT` examples + + + + +Get a Status Dashboard by its PagerDuty `id`.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +SELECT +id, +name, +url_slug +FROM pagerduty.status_dashboards.status_dashboards +WHERE id = '{{ id }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND Accept = '{{ Accept }}' +; +``` + + + +Get all your account's custom Status Dashboard views

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +SELECT +id, +name, +url_slug +FROM pagerduty.status_dashboards.status_dashboards +WHERE X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND Accept = '{{ Accept }}' +; +``` + + + + +## Lifecycle Methods + + + + +Get all your account's custom Status Dashboard views

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +EXEC pagerduty.status_dashboards.status_dashboards._list_status_dashboards +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@Accept='{{ Accept }}' +; +``` + + + +Get a Status Dashboard by its PagerDuty `id`.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +EXEC pagerduty.status_dashboards.status_dashboards._get_status_dashboard_by_id +@id='{{ id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@Accept='{{ Accept }}' +; +``` + + diff --git a/website/docs/services/status_dashboards/url_slugs/index.md b/website/docs/services/status_dashboards/url_slugs/index.md new file mode 100644 index 0000000..34a5bfa --- /dev/null +++ b/website/docs/services/status_dashboards/url_slugs/index.md @@ -0,0 +1,181 @@ +--- +title: url_slugs +hide_title: false +hide_table_of_contents: false +keywords: + - url_slugs + - status_dashboards + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a url_slugs resource. + +## Overview + + + + +
Nameurl_slugs
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
url_slug, X-EARLY-ACCESSAcceptGet 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`.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
url_slug, X-EARLY-ACCESSAcceptGet 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`.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!
stringThe `url_slug` for a status dashboard
stringThe `Accept` header is used as a versioning header.
+ +## `SELECT` examples + + + + +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`.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +SELECT +id, +name, +url_slug +FROM pagerduty.status_dashboards.url_slugs +WHERE url_slug = '{{ url_slug }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND Accept = '{{ Accept }}' +; +``` + + + + +## Lifecycle Methods + + + + +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`.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +EXEC pagerduty.status_dashboards.url_slugs._get_status_dashboard_by_url_slug +@url_slug='{{ url_slug }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@Accept='{{ Accept }}' +; +``` + + diff --git a/website/docs/services/status_dashboards/url_slugs_service_impacts/index.md b/website/docs/services/status_dashboards/url_slugs_service_impacts/index.md new file mode 100644 index 0000000..d34ed17 --- /dev/null +++ b/website/docs/services/status_dashboards/url_slugs_service_impacts/index.md @@ -0,0 +1,200 @@ +--- +title: url_slugs_service_impacts +hide_title: false +hide_table_of_contents: false +keywords: + - url_slugs_service_impacts + - status_dashboards + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a url_slugs_service_impacts resource. + +## Overview + + + + +
Nameurl_slugs_service_impacts
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
stringThe current impact status of the object
stringThe kind of object that has been impacted
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
url_slug, X-EARLY-ACCESSAccept, additional_fields[]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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
url_slug, X-EARLY-ACCESSAccept, additional_fields[]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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header with the value `status-dashboards`. Do not use this endpoint in production, as it may change!
stringThe `url_slug` for a status dashboard
stringThe `Accept` header is used as a versioning header.
stringProvides access to additional fields such as highest priority per business service and total impacted count
+ +## `SELECT` examples + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +SELECT +id, +name, +additional_fields, +status, +type +FROM pagerduty.status_dashboards.url_slugs_service_impacts +WHERE url_slug = '{{ url_slug }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND Accept = '{{ Accept }}' +AND additional_fields[] = '{{ additional_fields[] }}' +; +``` + + + + +## Lifecycle Methods + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. + +```sql +EXEC pagerduty.status_dashboards.url_slugs_service_impacts._get_status_dashboard_service_impacts_by_url_slug +@url_slug='{{ url_slug }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@Accept='{{ Accept }}', +@additional_fields[]='{{ additional_fields[] }}' +; +``` + + diff --git a/website/docs/services/tags/index.md b/website/docs/services/tags/index.md new file mode 100644 index 0000000..03ec1f2 --- /dev/null +++ b/website/docs/services/tags/index.md @@ -0,0 +1,33 @@ +--- +title: tags +hide_title: false +hide_table_of_contents: false +keywords: + - tags + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +tags service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+tags +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/tags/tags/index.md b/website/docs/services/tags/tags/index.md new file mode 100644 index 0000000..fb6af43 --- /dev/null +++ b/website/docs/services/tags/tags/index.md @@ -0,0 +1,627 @@ +--- +title: tags +hide_title: false +hide_table_of_contents: false +keywords: + - tags + - tags + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a tags resource. + +## Overview + + + + +
Nametags
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +An array of tags. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (url)a URL at which the entity is uniquely displayed in the Web app
stringThe label of the tag.
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
stringThe type of object being created. (default: tag)
+ + + +An array of connected entities. + + + + + + + + + + + +
NameDatatypeDescription
+ + + +The tag requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (url)a URL at which the entity is uniquely displayed in the Web app
stringThe label of the tag.
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
stringThe type of object being created. (default: tag)
+ + + +An array of tags names. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (url)a URL at which the entity is uniquely displayed in the Web app
stringThe label of the tag.
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
stringThe type of object being created. (default: tag)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
entity_type, idAccept, Content-Type, limit, offset, totalGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.read`
id, entity_typeAccept, Content-Type, limit, offset, totalGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.read`
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.read`
Accept, Content-Type, limit, offset, total, queryList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.read`
entity_type, idAccept, Content-TypeAssign 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.write`
data__tagAccept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.write`
idAccept, Content-TypeRemove 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.write`
entity_type, idAccept, Content-Type, limit, offset, totalGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.read`
Accept, Content-Type, limit, offset, total, queryList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.read`
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.read`
id, entity_typeAccept, Content-Type, limit, offset, totalGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringType of entity related with the tag
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
integerThe number of results per page.
integerOffset to start pagination search results.
stringFilters the result, showing only the tags whose label matches the query.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.read`
+ +```sql +SELECT +id, +html_url, +label, +self, +summary, +type +FROM pagerduty.tags.tags +WHERE entity_type = '{{ entity_type }}' -- required +AND id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.read`
+ +```sql +SELECT +* +FROM pagerduty.tags.tags +WHERE id = '{{ id }}' -- required +AND entity_type = '{{ entity_type }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.read`
+ +```sql +SELECT +id, +html_url, +label, +self, +summary, +type +FROM pagerduty.tags.tags +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.read`
+ +```sql +SELECT +id, +html_url, +label, +self, +summary, +type +FROM pagerduty.tags.tags +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND query = '{{ query }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.write`
+ +```sql +INSERT INTO pagerduty.tags.tags ( +data__add, +data__remove, +entity_type, +id, +Accept, +Content-Type +) +SELECT +'{{ add }}', +'{{ remove }}', +'{{ entity_type }}', +'{{ id }}', +'{{ Accept }}', +'{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.write`
+ +```sql +INSERT INTO pagerduty.tags.tags ( +data__tag, +Accept, +Content-Type +) +SELECT +'{{ tag }}' /* required */, +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +tag +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: tags + props: + - name: entity_type + value: string + description: Required parameter for the tags resource. + - name: id + value: string + description: Required parameter for the tags resource. + - name: add + value: array + description: | + Array of tags and/or tag references to add to the entity. + For elements with type `tag_reference`, the tag with the corresponding `id` is added to the entity. + For elements with type `tag`, if there is an existing tag with the given + label that tag is added to the entity. If there is no existing tag with that label and the user has permission + to create tags, a new tag is created with that label and assigned to the entity. + - name: remove + value: array + description: | + Array of tag references to remove from the entity. + - name: tag + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.write`
+ +```sql +DELETE FROM pagerduty.tags.tags +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.read`
+ +```sql +EXEC pagerduty.tags.tags._get_entity_type_by_id_tags +@entity_type='{{ entity_type }}' --required, +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }} +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.read`
+ +```sql +EXEC pagerduty.tags.tags._list_tags +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@query='{{ query }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.read`
+ +```sql +EXEC pagerduty.tags.tags._get_tag +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)

Scoped OAuth requires: `tags.read`
+ +```sql +EXEC pagerduty.tags.tags._get_tags_by_entity_type +@id='{{ id }}' --required, +@entity_type='{{ entity_type }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }} +; +``` + + diff --git a/website/docs/services/teams/audit_records/index.md b/website/docs/services/teams/audit_records/index.md new file mode 100644 index 0000000..5faa244 --- /dev/null +++ b/website/docs/services/teams/audit_records/index.md @@ -0,0 +1,247 @@ +--- +title: audit_records +hide_title: false +hide_table_of_contents: false +keywords: + - audit_records + - teams + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an audit_records resource. + +## Overview + + + + +
Nameaudit_records
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Records matching the query criteria. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (example: create)
array
objectAdditional details to provide further information about the action or the resource that has been audited.
objectAction execution context
string (date-time)The date/time the action executed, in ISO8601 format and millisecond precision.
objectThe method information
object
stringRecord URL.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, limit, cursor, since, untilThe 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`
idAccept, Content-Type, limit, cursor, since, untilThe 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`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringOptional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set.
integerThe minimum of the `limit` parameter used in the request or the maximum request size of the API.
string (date-time)The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)
string (date-time)The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.
+ +## `SELECT` 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`
+ +```sql +SELECT +id, +action, +actors, +details, +execution_context, +execution_time, +method, +root_resource, +self +FROM pagerduty.teams.audit_records +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND cursor = '{{ cursor }}' +AND since = '{{ since }}' +AND until = '{{ until }}' +; +``` + + + + +## Lifecycle Methods + + + + +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`
+ +```sql +EXEC pagerduty.teams.audit_records._list_teams_audit_records +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@cursor='{{ cursor }}', +@since='{{ since }}', +@until='{{ until }}' +; +``` + + diff --git a/website/docs/services/teams/escalation_policies/index.md b/website/docs/services/teams/escalation_policies/index.md new file mode 100644 index 0000000..a833e8f --- /dev/null +++ b/website/docs/services/teams/escalation_policies/index.md @@ -0,0 +1,150 @@ +--- +title: escalation_policies +hide_title: false +hide_table_of_contents: false +keywords: + - escalation_policies + - teams + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an escalation_policies resource. + +## Overview + + + + +
Nameescalation_policies
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, escalation_policy_idAccept, Content-TypeRemove 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.write`
id, escalation_policy_idAccept, Content-TypeAdd 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe escalation policy ID on the team.
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
+ +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.write`
+ +```sql +DELETE FROM pagerduty.teams.escalation_policies +WHERE id = '{{ id }}' --required +AND escalation_policy_id = '{{ escalation_policy_id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.write`
+ +```sql +EXEC pagerduty.teams.escalation_policies.update_team_escalation_policy +@id='{{ id }}' --required, +@escalation_policy_id='{{ escalation_policy_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/teams/index.md b/website/docs/services/teams/index.md new file mode 100644 index 0000000..556d3c3 --- /dev/null +++ b/website/docs/services/teams/index.md @@ -0,0 +1,36 @@ +--- +title: teams +hide_title: false +hide_table_of_contents: false +keywords: + - teams + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +teams service documentation. + +:::info[Service Summary] + +total resources: __5__ + +::: + +## Resources +
+
+audit_records
+escalation_policies
+members +
+
+notification_subscriptions
+teams +
+
\ No newline at end of file diff --git a/website/docs/services/teams/members/index.md b/website/docs/services/teams/members/index.md new file mode 100644 index 0000000..d51d8a8 --- /dev/null +++ b/website/docs/services/teams/members/index.md @@ -0,0 +1,266 @@ +--- +title: members +hide_title: false +hide_table_of_contents: false +keywords: + - members + - teams + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a members resource. + +## Overview + + + + +
Namemembers
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +A paginated array of users within the requested team. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, limit, offset, total, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.read`
id, user_idAccept, Content-TypeRemove 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.write`
idAccept, Content-Type, limit, offset, total, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.read`
id, user_idAccept, Content-TypeAdd 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe user ID on the team.
stringThe `Accept` header is used as a versioning header.
string
stringArray of additional Models to include in response.
integerThe number of results per page.
integerOffset to start pagination search results.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.read`
+ +```sql +SELECT +role, +user +FROM pagerduty.teams.members +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND include[] = '{{ include[] }}' +; +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.write`
+ +```sql +DELETE FROM pagerduty.teams.members +WHERE id = '{{ id }}' --required +AND user_id = '{{ user_id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.read`
+ +```sql +EXEC pagerduty.teams.members._list_team_users +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@include[]='{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.write`
+ +```sql +EXEC pagerduty.teams.members.update_team_user +@id='{{ id }}' --required, +@user_id='{{ user_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"role": "{{ role }}" +}' +; +``` + + diff --git a/website/docs/services/teams/notification_subscriptions/index.md b/website/docs/services/teams/notification_subscriptions/index.md new file mode 100644 index 0000000..9733113 --- /dev/null +++ b/website/docs/services/teams/notification_subscriptions/index.md @@ -0,0 +1,245 @@ +--- +title: notification_subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - notification_subscriptions + - teams + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a notification_subscriptions resource. + +## Overview + + + + +
Namenotification_subscriptions
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the subscribable
objectAn object describing the relationship of a NotificationSubscriber and a NotificationSubscribable. (title: NotificationSubscription)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAcceptRetrieve 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`
id, data__subscribablesAcceptCreate new Notification Subscriptions for the given Team.

Scoped OAuth requires: `subscribers.write`
idAcceptRetrieve 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`
id, subscribablesAcceptUnsubscribe the given Team from Notifications on the matching Subscribable entities.

Scoped OAuth requires: `subscribers.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
+ +## `SELECT` examples + + + + +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`
+ +```sql +SELECT +subscribable_name, +subscription +FROM pagerduty.teams.notification_subscriptions +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +; +``` + + + + +## `INSERT` examples + + + + +Create new Notification Subscriptions for the given Team.

Scoped OAuth requires: `subscribers.write`
+ +```sql +INSERT INTO pagerduty.teams.notification_subscriptions ( +data__subscribables, +id, +Accept +) +SELECT +'{{ subscribables }}' /* required */, +'{{ id }}', +'{{ Accept }}' +RETURNING +subscriptions +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: notification_subscriptions + props: + - name: id + value: string + description: Required parameter for the notification_subscriptions resource. + - name: subscribables + value: array + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. +``` + + + + +## Lifecycle Methods + + + + +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`
+ +```sql +EXEC pagerduty.teams.notification_subscriptions._get_team_notification_subscriptions +@id='{{ id }}' --required, +@Accept='{{ Accept }}' +; +``` + + + +Unsubscribe the given Team from Notifications on the matching Subscribable entities.

Scoped OAuth requires: `subscribers.write`
+ +```sql +EXEC pagerduty.teams.notification_subscriptions.remove_team_notification_subscriptions +@id='{{ id }}' --required, +@Accept='{{ Accept }}' +@@json= +'{ +"subscribables": "{{ subscribables }}" +}' +; +``` + + diff --git a/website/docs/services/teams/teams/index.md b/website/docs/services/teams/teams/index.md new file mode 100644 index 0000000..a49b026 --- /dev/null +++ b/website/docs/services/teams/teams/index.md @@ -0,0 +1,465 @@ +--- +title: teams +hide_title: false +hide_table_of_contents: false +keywords: + - teams + - teams + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a teams resource. + +## Overview + + + + +
Nameteams
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The team requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the team.
stringThe description of the team.
string (url)a URL at which the entity is uniquely displayed in the Web app
object
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
stringThe type of object being created. (default: team)
+ + + +A paginated array of teams. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the team.
stringThe description of the team.
string (url)a URL at which the entity is uniquely displayed in the Web app
object
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
stringThe type of object being created. (default: team)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.read`
Accept, Content-Type, limit, offset, total, queryList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.read`
data__teamAccept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.write`
idAccept, Content-Type, reassignment_teamRemove 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.write`
Accept, Content-Type, limit, offset, total, queryList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.read`
idAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.read`
id, teamAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringArray of additional Models to include in response.
integerThe number of results per page.
integerOffset to start pagination search results.
stringFilters the result, showing only the records whose name matches the query.
stringTeam to reassign unresolved incident to. If an unresolved incident exists on both the reassignment team and the team being deleted, a duplicate will not be made. If not supplied, unresolved incidents will be made account-level.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.read`
+ +```sql +SELECT +id, +name, +description, +html_url, +parent, +self, +summary, +type +FROM pagerduty.teams.teams +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND include[] = '{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.read`
+ +```sql +SELECT +id, +name, +description, +html_url, +parent, +self, +summary, +type +FROM pagerduty.teams.teams +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND query = '{{ query }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.write`
+ +```sql +INSERT INTO pagerduty.teams.teams ( +data__team, +Accept, +Content-Type +) +SELECT +'{{ team }}' /* required */, +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +team +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: teams + props: + - name: team + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.write`
+ +```sql +DELETE FROM pagerduty.teams.teams +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND reassignment_team = '{{ reassignment_team }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.read`
+ +```sql +EXEC pagerduty.teams.teams._list_teams +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@query='{{ query }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.read`
+ +```sql +EXEC pagerduty.teams.teams._get_team +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@include[]='{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#teams)

Scoped OAuth requires: `teams.write`
+ +```sql +EXEC pagerduty.teams.teams.update_team +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"team": "{{ team }}" +}' +; +``` + + diff --git a/website/docs/services/templates/index.md b/website/docs/services/templates/index.md new file mode 100644 index 0000000..5a26394 --- /dev/null +++ b/website/docs/services/templates/index.md @@ -0,0 +1,33 @@ +--- +title: templates +hide_title: false +hide_table_of_contents: false +keywords: + - templates + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +templates service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+templates +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/templates/templates/index.md b/website/docs/services/templates/templates/index.md new file mode 100644 index 0000000..f1d48b2 --- /dev/null +++ b/website/docs/services/templates/templates/index.md @@ -0,0 +1,495 @@ +--- +title: templates +hide_title: false +hide_table_of_contents: false +keywords: + - templates + - templates + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a templates resource. + +## Overview + + + + +
Nametemplates
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Successful operation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the template
User/Account object reference of the creator
stringDescription of the template
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
stringThe type of template (`status_update` is the only supported template at this time)
object
string
User/Account object reference of the updator
+ + + +A paginated array of templates. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the template
User/Account object reference of the creator
stringDescription of the template
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
stringThe type of template (`status_update` is the only supported template at this time)
object
string
User/Account object reference of the updator
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idGet a single template on the account

Scoped OAuth requires: `templates.read`
limit, offset, total, query, template_type, sort_byGet a list of all the template on an account

Scoped OAuth requires: `templates.read`
data__templateCreate a new template

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

Scoped OAuth requires: `templates.write`
limit, offset, total, query, template_type, sort_byGet a list of all the template on an account

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

Scoped OAuth requires: `templates.read`
id, templateUpdate an existing template

Scoped OAuth requires: `templates.write`
idRender 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`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
integerThe number of results per page.
integerOffset to start pagination search results.
stringTemplate name or description to search
stringUsed to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.
stringFilters templates by type.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +Get a single template on the account

Scoped OAuth requires: `templates.read`
+ +```sql +SELECT +id, +name, +created_by, +description, +html_url, +self, +summary, +template_type, +templated_fields, +type, +updated_by +FROM pagerduty.templates.templates +WHERE id = '{{ id }}' -- required +; +``` + + + +Get a list of all the template on an account

Scoped OAuth requires: `templates.read`
+ +```sql +SELECT +id, +name, +created_by, +description, +html_url, +self, +summary, +template_type, +templated_fields, +type, +updated_by +FROM pagerduty.templates.templates +WHERE limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND query = '{{ query }}' +AND template_type = '{{ template_type }}' +AND sort_by = '{{ sort_by }}' +; +``` + + + + +## `INSERT` examples + + + + +Create a new template

Scoped OAuth requires: `templates.write`
+ +```sql +INSERT INTO pagerduty.templates.templates ( +data__template +) +SELECT +'{{ template }}' /* required */ +RETURNING +template +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: templates + props: + - name: template + value: object +``` + + + + +## `DELETE` examples + + + + +Delete a specific of templates on the account

Scoped OAuth requires: `templates.write`
+ +```sql +DELETE FROM pagerduty.templates.templates +WHERE id = '{{ id }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Get a list of all the template on an account

Scoped OAuth requires: `templates.read`
+ +```sql +EXEC pagerduty.templates.templates._get_templates +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@query='{{ query }}', +@template_type='{{ template_type }}', +@sort_by='{{ sort_by }}' +; +``` + + + +Get a single template on the account

Scoped OAuth requires: `templates.read`
+ +```sql +EXEC pagerduty.templates.templates._get_template +@id='{{ id }}' --required +; +``` + + + +Update an existing template

Scoped OAuth requires: `templates.write`
+ +```sql +EXEC pagerduty.templates.templates.update_template +@id='{{ id }}' --required +@@json= +'{ +"template": "{{ 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`
+ +```sql +EXEC pagerduty.templates.templates.render_template +@id='{{ id }}' --required +@@json= +'{ +"incident_id": "{{ incident_id }}", +"status_update": "{{ status_update }}", +"external": "{{ external }}" +}' +; +``` + + diff --git a/website/docs/services/users/audit_records/index.md b/website/docs/services/users/audit_records/index.md new file mode 100644 index 0000000..d11fc4a --- /dev/null +++ b/website/docs/services/users/audit_records/index.md @@ -0,0 +1,247 @@ +--- +title: audit_records +hide_title: false +hide_table_of_contents: false +keywords: + - audit_records + - users + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an audit_records resource. + +## Overview + + + + +
Nameaudit_records
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Records matching the query criteria. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (example: create)
array
objectAdditional details to provide further information about the action or the resource that has been audited.
objectAction execution context
string (date-time)The date/time the action executed, in ISO8601 format and millisecond precision.
objectThe method information
object
stringRecord URL.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, limit, cursor, since, untilThe 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`
idAccept, Content-Type, limit, cursor, since, untilThe 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`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringOptional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set.
integerThe minimum of the `limit` parameter used in the request or the maximum request size of the API.
string (date-time)The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)
string (date-time)The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.
+ +## `SELECT` examples + + + + +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`
+ +```sql +SELECT +id, +action, +actors, +details, +execution_context, +execution_time, +method, +root_resource, +self +FROM pagerduty.users.audit_records +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND cursor = '{{ cursor }}' +AND since = '{{ since }}' +AND until = '{{ until }}' +; +``` + + + + +## Lifecycle Methods + + + + +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`
+ +```sql +EXEC pagerduty.users.audit_records._list_users_audit_records +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@cursor='{{ cursor }}', +@since='{{ since }}', +@until='{{ until }}' +; +``` + + diff --git a/website/docs/services/users/contact_methods/index.md b/website/docs/services/users/contact_methods/index.md new file mode 100644 index 0000000..c0796f4 --- /dev/null +++ b/website/docs/services/users/contact_methods/index.md @@ -0,0 +1,346 @@ +--- +title: contact_methods +hide_title: false +hide_table_of_contents: false +keywords: + - contact_methods + - users + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a contact_methods resource. + +## Overview + + + + +
Namecontact_methods
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The user's contact method requested. + + + + + + + + + + + +
NameDatatypeDescription
+ + + +A list of contact methods. + + + + + + + + + + + +
NameDatatypeDescription
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, contact_method_idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
idAccept, Content-TypeList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
id, data__contact_methodAccept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
id, contact_method_idAccept, Content-TypeRemove 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
idAccept, Content-TypeList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
id, contact_method_idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
id, contact_method_id, contact_methodAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe contact method ID on the user.
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
+ +```sql +SELECT +* +FROM pagerduty.users.contact_methods +WHERE id = '{{ id }}' -- required +AND contact_method_id = '{{ contact_method_id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
+ +```sql +SELECT +* +FROM pagerduty.users.contact_methods +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
+ +```sql +INSERT INTO pagerduty.users.contact_methods ( +data__contact_method, +id, +Accept, +Content-Type +) +SELECT +'{{ contact_method }}' /* required */, +'{{ id }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +contact_method +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: contact_methods + props: + - name: id + value: string + description: Required parameter for the contact_methods resource. + - name: contact_method + value: string + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
+ +```sql +DELETE FROM pagerduty.users.contact_methods +WHERE id = '{{ id }}' --required +AND contact_method_id = '{{ contact_method_id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
+ +```sql +EXEC pagerduty.users.contact_methods._get_user_contact_methods +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
+ +```sql +EXEC pagerduty.users.contact_methods._get_user_contact_method +@id='{{ id }}' --required, +@contact_method_id='{{ contact_method_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
+ +```sql +EXEC pagerduty.users.contact_methods.update_user_contact_method +@id='{{ id }}' --required, +@contact_method_id='{{ contact_method_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"contact_method": "{{ contact_method }}" +}' +; +``` + + diff --git a/website/docs/services/users/index.md b/website/docs/services/users/index.md new file mode 100644 index 0000000..eef40e2 --- /dev/null +++ b/website/docs/services/users/index.md @@ -0,0 +1,41 @@ +--- +title: users +hide_title: false +hide_table_of_contents: false +keywords: + - users + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +users service documentation. + +:::info[Service Summary] + +total resources: __10__ + +::: + +## Resources +
+
+audit_records
+contact_methods
+license
+me
+notification_rules +
+
+notification_subscriptions
+oncall_handoff_notification_rules
+sessions
+status_update_notification_rules
+users +
+
\ No newline at end of file diff --git a/website/docs/services/users/license/index.md b/website/docs/services/users/license/index.md new file mode 100644 index 0000000..ad005d5 --- /dev/null +++ b/website/docs/services/users/license/index.md @@ -0,0 +1,219 @@ +--- +title: license +hide_title: false +hide_table_of_contents: false +keywords: + - license + - users + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a license resource. + +## Overview + + + + +
Namelicense
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The License allocated to the User + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUniquely identifies the resource
stringName of the License.
stringDescription of the License. May include the names of add-ons associated with the License, if there are any.
stringHTML URL to access the License
stringIndicates whether this License is assignable to full or stakeholder Users (example: FullUser)
stringAPI URL to access the License
stringSummary of the License
stringType of object
arrayThe roles a User with this License can have
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet the License allocated to a User

Scoped OAuth requires: `licenses.read`
idAccept, Content-TypeGet the License allocated to a User

Scoped OAuth requires: `licenses.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +Get the License allocated to a User

Scoped OAuth requires: `licenses.read`
+ +```sql +SELECT +id, +name, +description, +html_url, +role_group, +self, +summary, +type, +valid_roles +FROM pagerduty.users.license +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +Get the License allocated to a User

Scoped OAuth requires: `licenses.read`
+ +```sql +EXEC pagerduty.users.license._get_user_license +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/users/me/index.md b/website/docs/services/users/me/index.md new file mode 100644 index 0000000..46dc76c --- /dev/null +++ b/website/docs/services/users/me/index.md @@ -0,0 +1,273 @@ +--- +title: me +hide_title: false +hide_table_of_contents: false +keywords: + - me + - users + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a me resource. + +## Overview + + + + +
Nameme
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The requesting user. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the user.
string (url)The URL of the user's avatar.
stringThe schedule color.
arrayThe list of contact methods for the user.
stringThe user's bio.
string (email)The user's email address.
string (url)a URL at which the entity is uniquely displayed in the Web app
booleanIf true, the user has an outstanding invitation.
stringThe user's title.
objectThe License assigned to the User
arrayThe list of notification rules for the user.
stringThe user role. Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`.
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
arrayThe list of teams to which the user belongs. Account must have the `teams` ability to set this.
string (tzinfo)The preferred time zone name. If null, the account's time zone will be used.
stringThe type of object being created. (default: user)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Accept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)
Accept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe `Accept` header is used as a versioning header.
string
stringArray of additional Models to include in response.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)
+ +```sql +SELECT +id, +name, +avatar_url, +color, +contact_methods, +description, +email, +html_url, +invitation_sent, +job_title, +license, +notification_rules, +role, +self, +summary, +teams, +time_zone, +type +FROM pagerduty.users.me +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND include[] = '{{ include[] }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)
+ +```sql +EXEC pagerduty.users.me._get_current_user +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@include[]='{{ include[] }}' +; +``` + + diff --git a/website/docs/services/users/notification_rules/index.md b/website/docs/services/users/notification_rules/index.md new file mode 100644 index 0000000..0f3c711 --- /dev/null +++ b/website/docs/services/users/notification_rules/index.md @@ -0,0 +1,411 @@ +--- +title: notification_rules +hide_title: false +hide_table_of_contents: false +keywords: + - notification_rules + - users + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a notification_rules resource. + +## Overview + + + + +
Namenotification_rules
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The user's notification rule requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)the API show URL at which the object is accessible
integerThe delay before firing the rule, in minutes.
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
stringThe type of object being created. (default: assignment_notification_rule)
stringWhich incident urgency this rule is used for. Account must have the `urgencies` ability to have a low urgency notification rule.
+ + + +A list of notification rules. + + + + + + + + + + + +
NameDatatypeDescription
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, notification_rule_idAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
idAccept, Content-Type, include[], urgencyList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
id, data__notification_ruleAccept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
id, notification_rule_idAccept, Content-TypeRemove 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
idAccept, Content-Type, include[], urgencyList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
id, notification_rule_idAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
id, notification_rule_id, notification_ruleAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe notification rule ID on the user.
stringThe `Accept` header is used as a versioning header.
string
stringArray of additional details to include.
stringThe incident urgency for which the notification rules are applied. If not specified, defaults to `high`.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
+ +```sql +SELECT +id, +contact_method, +html_url, +self, +start_delay_in_minutes, +summary, +type, +urgency +FROM pagerduty.users.notification_rules +WHERE id = '{{ id }}' -- required +AND notification_rule_id = '{{ notification_rule_id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND include[] = '{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
+ +```sql +SELECT +* +FROM pagerduty.users.notification_rules +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND include[] = '{{ include[] }}' +AND urgency = '{{ urgency }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
+ +```sql +INSERT INTO pagerduty.users.notification_rules ( +data__notification_rule, +id, +Accept, +Content-Type +) +SELECT +'{{ notification_rule }}' /* required */, +'{{ id }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +notification_rule +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: notification_rules + props: + - name: id + value: string + description: Required parameter for the notification_rules resource. + - name: notification_rule + value: object + description: | + A rule for contacting the user. + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
+ +```sql +DELETE FROM pagerduty.users.notification_rules +WHERE id = '{{ id }}' --required +AND notification_rule_id = '{{ notification_rule_id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
+ +```sql +EXEC pagerduty.users.notification_rules._get_user_notification_rules +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@include[]='{{ include[] }}', +@urgency='{{ urgency }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
+ +```sql +EXEC pagerduty.users.notification_rules._get_user_notification_rule +@id='{{ id }}' --required, +@notification_rule_id='{{ notification_rule_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@include[]='{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
+ +```sql +EXEC pagerduty.users.notification_rules.update_user_notification_rule +@id='{{ id }}' --required, +@notification_rule_id='{{ notification_rule_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"notification_rule": "{{ notification_rule }}" +}' +; +``` + + diff --git a/website/docs/services/users/notification_subscriptions/index.md b/website/docs/services/users/notification_subscriptions/index.md new file mode 100644 index 0000000..7e9c935 --- /dev/null +++ b/website/docs/services/users/notification_subscriptions/index.md @@ -0,0 +1,245 @@ +--- +title: notification_subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - notification_subscriptions + - users + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a notification_subscriptions resource. + +## Overview + + + + +
Namenotification_subscriptions
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the subscribable
objectAn object describing the relationship of a NotificationSubscriber and a NotificationSubscribable. (title: NotificationSubscription)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAcceptRetrieve 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`
id, data__subscribablesAcceptCreate new Notification Subscriptions for the given User.

Scoped OAuth requires: `subscribers.write`
idAcceptRetrieve 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`
id, subscribablesAcceptUnsubscribe the given User from Notifications on the matching Subscribable entities.

Scoped OAuth requires: `subscribers.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
+ +## `SELECT` examples + + + + +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`
+ +```sql +SELECT +subscribable_name, +subscription +FROM pagerduty.users.notification_subscriptions +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +; +``` + + + + +## `INSERT` examples + + + + +Create new Notification Subscriptions for the given User.

Scoped OAuth requires: `subscribers.write`
+ +```sql +INSERT INTO pagerduty.users.notification_subscriptions ( +data__subscribables, +id, +Accept +) +SELECT +'{{ subscribables }}' /* required */, +'{{ id }}', +'{{ Accept }}' +RETURNING +subscriptions +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: notification_subscriptions + props: + - name: id + value: string + description: Required parameter for the notification_subscriptions resource. + - name: subscribables + value: array + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. +``` + + + + +## Lifecycle Methods + + + + +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`
+ +```sql +EXEC pagerduty.users.notification_subscriptions._get_user_notification_subscriptions +@id='{{ id }}' --required, +@Accept='{{ Accept }}' +; +``` + + + +Unsubscribe the given User from Notifications on the matching Subscribable entities.

Scoped OAuth requires: `subscribers.write`
+ +```sql +EXEC pagerduty.users.notification_subscriptions.unsubscribe_user_notification_subscriptions +@id='{{ id }}' --required, +@Accept='{{ Accept }}' +@@json= +'{ +"subscribables": "{{ subscribables }}" +}' +; +``` + + diff --git a/website/docs/services/users/oncall_handoff_notification_rules/index.md b/website/docs/services/users/oncall_handoff_notification_rules/index.md new file mode 100644 index 0000000..9dc2b21 --- /dev/null +++ b/website/docs/services/users/oncall_handoff_notification_rules/index.md @@ -0,0 +1,394 @@ +--- +title: oncall_handoff_notification_rules +hide_title: false +hide_table_of_contents: false +keywords: + - oncall_handoff_notification_rules + - users + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an oncall_handoff_notification_rules resource. + +## Overview + + + + +
Nameoncall_handoff_notification_rules
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The user's handoff notification rule requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
stringThe type of handoff being created. (default: both)
integerThe delay before firing the rule, in minutes.
+ + + +A list of Handoff Notification Rules. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
stringThe type of handoff being created. (default: both)
integerThe delay before firing the rule, in minutes.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, oncall_handoff_notification_rule_idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
idAccept, Content-TypeList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
id, data__oncall_handoff_notification_ruleAccept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
id, oncall_handoff_notification_rule_idAccept, Content-TypeRemove 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
idAccept, Content-TypeList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
id, oncall_handoff_notification_rule_idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
id, oncall_handoff_notification_rule_id, oncall_handoff_notification_ruleAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe oncall handoff notification rule ID on the user.
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
+ +```sql +SELECT +id, +contact_method, +handoff_type, +notify_advance_in_minutes +FROM pagerduty.users.oncall_handoff_notification_rules +WHERE id = '{{ id }}' -- required +AND oncall_handoff_notification_rule_id = '{{ oncall_handoff_notification_rule_id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
+ +```sql +SELECT +id, +contact_method, +handoff_type, +notify_advance_in_minutes +FROM pagerduty.users.oncall_handoff_notification_rules +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
+ +```sql +INSERT INTO pagerduty.users.oncall_handoff_notification_rules ( +data__oncall_handoff_notification_rule, +id, +Accept, +Content-Type +) +SELECT +'{{ oncall_handoff_notification_rule }}' /* required */, +'{{ id }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +oncall_handoff_notification_rule +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: oncall_handoff_notification_rules + props: + - name: id + value: string + description: Required parameter for the oncall_handoff_notification_rules resource. + - name: oncall_handoff_notification_rule + value: object + description: | + A rule for contacting the user for Handoff Notifications. + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
+ +```sql +DELETE FROM pagerduty.users.oncall_handoff_notification_rules +WHERE id = '{{ id }}' --required +AND oncall_handoff_notification_rule_id = '{{ oncall_handoff_notification_rule_id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
+ +```sql +EXEC pagerduty.users.oncall_handoff_notification_rules._get_user_handoff_notification_rules +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
+ +```sql +EXEC pagerduty.users.oncall_handoff_notification_rules._get_user_handoff_notifiaction_rule +@id='{{ id }}' --required, +@oncall_handoff_notification_rule_id='{{ oncall_handoff_notification_rule_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
+ +```sql +EXEC pagerduty.users.oncall_handoff_notification_rules.update_user_handoff_notification +@id='{{ id }}' --required, +@oncall_handoff_notification_rule_id='{{ oncall_handoff_notification_rule_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"oncall_handoff_notification_rule": "{{ oncall_handoff_notification_rule }}" +}' +; +``` + + diff --git a/website/docs/services/users/sessions/index.md b/website/docs/services/users/sessions/index.md new file mode 100644 index 0000000..7bbb1a1 --- /dev/null +++ b/website/docs/services/users/sessions/index.md @@ -0,0 +1,320 @@ +--- +title: sessions +hide_title: false +hide_table_of_contents: false +keywords: + - sessions + - users + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a sessions resource. + +## Overview + + + + +
Namesessions
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The user's session requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string (date-time)The date/time the user session was first created.
stringThe summary of the session
stringThe type of the session
+ + + +A list of the user's active sessions. + + + + + + + + + + + +
NameDatatypeDescription
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, type, session_idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:sessions.read`
idAccept, Content-TypeList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:sessions.read`
id, type, session_idAccept, Content-TypeDelete 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:sessions.write`
idAccept, Content-TypeDelete all user sessions.

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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:sessions.write`
idAccept, Content-TypeList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:sessions.read`
id, type, session_idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:sessions.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe session ID for the user.
stringThe session type for the user session ID.
stringThe `Accept` header is used as a versioning header.
string
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:sessions.read`
+ +```sql +SELECT +id, +user_id, +created_at, +summary, +type +FROM pagerduty.users.sessions +WHERE id = '{{ id }}' -- required +AND type = '{{ type }}' -- required +AND session_id = '{{ session_id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:sessions.read`
+ +```sql +SELECT +* +FROM pagerduty.users.sessions +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:sessions.write`
+ +```sql +DELETE FROM pagerduty.users.sessions +WHERE id = '{{ id }}' --required +AND type = '{{ type }}' --required +AND session_id = '{{ session_id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +Delete all user sessions.

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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:sessions.write`
+ +```sql +DELETE FROM pagerduty.users.sessions +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:sessions.read`
+ +```sql +EXEC pagerduty.users.sessions._get_user_sessions +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users:sessions.read`
+ +```sql +EXEC pagerduty.users.sessions._get_user_session +@id='{{ id }}' --required, +@type='{{ type }}' --required, +@session_id='{{ session_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/users/status_update_notification_rules/index.md b/website/docs/services/users/status_update_notification_rules/index.md new file mode 100644 index 0000000..a701cf4 --- /dev/null +++ b/website/docs/services/users/status_update_notification_rules/index.md @@ -0,0 +1,378 @@ +--- +title: status_update_notification_rules +hide_title: false +hide_table_of_contents: false +keywords: + - status_update_notification_rules + - users + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a status_update_notification_rules resource. + +## Overview + + + + +
Namestatus_update_notification_rules
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The user's status update notification rule requested. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
+ + + +A list of status update notification rules. + + + + + + + + + + + +
NameDatatypeDescription
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
X-EARLY-ACCESS, id, status_update_notification_rule_idAccept, Content-Type, include[]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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
id, X-EARLY-ACCESSAccept, Content-Type, include[]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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
X-EARLY-ACCESS, id, data__status_update_notification_ruleAccept, Content-TypeCreate 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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
X-EARLY-ACCESS, id, status_update_notification_rule_idAccept, Content-TypeRemove 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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
id, X-EARLY-ACCESSAccept, Content-Type, include[]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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
X-EARLY-ACCESS, id, status_update_notification_rule_idAccept, Content-Type, include[]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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
X-EARLY-ACCESS, id, status_update_notification_rule_id, status_update_notification_ruleAccept, Content-TypeUpdate 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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis header indicates that this API endpoint is __UNDER CONSTRUCTION__ and may change at any time. You __MUST__ pass in this header and the above value. Do not use this endpoint in production, as it may change!
stringThe ID of the resource.
stringThe status update notification rule ID on the user.
stringThe `Accept` header is used as a versioning header.
string
stringArray of additional details to include.
+ +## `SELECT` examples + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
+ +```sql +SELECT +contact_method +FROM pagerduty.users.status_update_notification_rules +WHERE X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND id = '{{ id }}' -- required +AND status_update_notification_rule_id = '{{ status_update_notification_rule_id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND include[] = '{{ include[] }}' +; +``` + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
+ +```sql +SELECT +* +FROM pagerduty.users.status_update_notification_rules +WHERE id = '{{ id }}' -- required +AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND include[] = '{{ include[] }}' +; +``` + + + + +## `INSERT` examples + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
+ +```sql +INSERT INTO pagerduty.users.status_update_notification_rules ( +data__status_update_notification_rule, +X-EARLY-ACCESS, +id, +Accept, +Content-Type +) +SELECT +'{{ status_update_notification_rule }}' /* required */, +'{{ X-EARLY-ACCESS }}', +'{{ id }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +status_update_notification_rule +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: status_update_notification_rules + props: + - name: X-EARLY-ACCESS + value: string + description: Required parameter for the status_update_notification_rules resource. + - name: id + value: string + description: Required parameter for the status_update_notification_rules resource. + - name: status_update_notification_rule + value: object + description: | + A rule for contacting the user for Incident Status Updates. + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
+ +```sql +DELETE FROM pagerduty.users.status_update_notification_rules +WHERE X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' --required +AND id = '{{ id }}' --required +AND status_update_notification_rule_id = '{{ status_update_notification_rule_id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
+ +```sql +EXEC pagerduty.users.status_update_notification_rules._get_user_status_update_notification_rules +@id='{{ id }}' --required, +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@include[]='{{ include[] }}' +; +``` + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
+ +```sql +EXEC pagerduty.users.status_update_notification_rules._get_user_status_update_notification_rule +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@id='{{ id }}' --required, +@status_update_notification_rule_id='{{ status_update_notification_rule_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@include[]='{{ include[] }}' +; +``` + + + +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.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
+ +```sql +EXEC pagerduty.users.status_update_notification_rules.update_user_status_update_notification_rule +@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, +@id='{{ id }}' --required, +@status_update_notification_rule_id='{{ status_update_notification_rule_id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"status_update_notification_rule": "{{ status_update_notification_rule }}" +}' +; +``` + + diff --git a/website/docs/services/users/users/index.md b/website/docs/services/users/users/index.md new file mode 100644 index 0000000..297ace3 --- /dev/null +++ b/website/docs/services/users/users/index.md @@ -0,0 +1,598 @@ +--- +title: users +hide_title: false +hide_table_of_contents: false +keywords: + - users + - users + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a users resource. + +## Overview + + + + +
Nameusers
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The user requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the user.
string (url)The URL of the user's avatar.
stringThe schedule color.
arrayThe list of contact methods for the user.
stringThe user's bio.
string (email)The user's email address.
string (url)a URL at which the entity is uniquely displayed in the Web app
booleanIf true, the user has an outstanding invitation.
stringThe user's title.
objectThe License assigned to the User
arrayThe list of notification rules for the user.
stringThe user role. Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`.
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
arrayThe list of teams to which the user belongs. Account must have the `teams` ability to set this.
string (tzinfo)The preferred time zone name. If null, the account's time zone will be used.
stringThe type of object being created. (default: user)
+ + + +A paginated array of users. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the user.
string (url)The URL of the user's avatar.
stringThe schedule color.
arrayThe list of contact methods for the user.
stringThe user's bio.
string (email)The user's email address.
string (url)a URL at which the entity is uniquely displayed in the Web app
booleanIf true, the user has an outstanding invitation.
stringThe user's title.
objectThe License assigned to the User
arrayThe list of notification rules for the user.
stringThe user role. Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`.
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
arrayThe list of teams to which the user belongs. Account must have the `teams` ability to set this.
string (tzinfo)The preferred time zone name. If null, the account's time zone will be used.
stringThe type of object being created. (default: user)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
Accept, Content-Type, query, team_ids[], limit, offset, total, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
From, data__userAccept, Content-TypeCreate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
idAccept, Content-TypeRemove 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
Accept, Content-Type, query, team_ids[], limit, offset, total, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
idAccept, Content-Type, include[]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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
id, userAccept, Content-TypeUpdate 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (email)The email address of a valid user associated with the account making the request.
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringArray of additional Models to include in response.
integerThe number of results per page.
integerOffset to start pagination search results.
stringFilters the result, showing only the records whose name matches the query.
arrayAn array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
+ +```sql +SELECT +id, +name, +avatar_url, +color, +contact_methods, +description, +email, +html_url, +invitation_sent, +job_title, +license, +notification_rules, +role, +self, +summary, +teams, +time_zone, +type +FROM pagerduty.users.users +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND include[] = '{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
+ +```sql +SELECT +id, +name, +avatar_url, +color, +contact_methods, +description, +email, +html_url, +invitation_sent, +job_title, +license, +notification_rules, +role, +self, +summary, +teams, +time_zone, +type +FROM pagerduty.users.users +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND query = '{{ query }}' +AND team_ids[] = '{{ team_ids[] }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND include[] = '{{ include[] }}' +; +``` + + + + +## `INSERT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
+ +```sql +INSERT INTO pagerduty.users.users ( +data__user, +From, +Accept, +Content-Type +) +SELECT +'{{ user }}' /* required */, +'{{ From }}', +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +user +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: users + props: + - name: From + value: string (email) + description: Required parameter for the users resource. + - name: user + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
+ +```sql +DELETE FROM pagerduty.users.users +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
+ +```sql +EXEC pagerduty.users.users._list_users +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@query='{{ query }}', +@team_ids[]='{{ team_ids[] }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@include[]='{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.read`
+ +```sql +EXEC pagerduty.users.users._get_user +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@include[]='{{ include[] }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)

Scoped OAuth requires: `users.write`
+ +```sql +EXEC pagerduty.users.users.update_user +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"user": "{{ user }}" +}' +; +``` + + diff --git a/website/docs/services/vendors/index.md b/website/docs/services/vendors/index.md new file mode 100644 index 0000000..d1aa8bc --- /dev/null +++ b/website/docs/services/vendors/index.md @@ -0,0 +1,33 @@ +--- +title: vendors +hide_title: false +hide_table_of_contents: false +keywords: + - vendors + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +vendors service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+vendors +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/vendors/vendors/index.md b/website/docs/services/vendors/vendors/index.md new file mode 100644 index 0000000..eda57f7 --- /dev/null +++ b/website/docs/services/vendors/vendors/index.md @@ -0,0 +1,374 @@ +--- +title: vendors +hide_title: false +hide_table_of_contents: false +keywords: + - vendors + - vendors + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a vendors resource. + +## Overview + + + + +
Namevendors
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The vendor requested + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe short name of the vendor
stringA short description of this vendor, and common use-cases of integrations for this vendor.
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)URL of an integration guide for this vendor
string (url)URL of a logo identifying the vendor
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
string (url)URL of a small thumbnail image identifying the vendor
stringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.
string (url)URL of the vendor's main website
+ + + +A paginated array of vendors. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe short name of the vendor
stringA short description of this vendor, and common use-cases of integrations for this vendor.
string (url)a URL at which the entity is uniquely displayed in the Web app
string (url)URL of an integration guide for this vendor
string (url)URL of a logo identifying the vendor
string (url)the API show URL at which the object is accessible
stringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.
string (url)URL of a small thumbnail image identifying the vendor
stringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.
string (url)URL of the vendor's main website
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#vendors)

Scoped OAuth requires: `vendors.read`
Accept, Content-Type, limit, offset, totalList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#vendors)

Scoped OAuth requires: `vendors.read`
Accept, Content-Type, limit, offset, totalList 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#vendors)

Scoped OAuth requires: `vendors.read`
idAccept, Content-TypeGet 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#vendors)

Scoped OAuth requires: `vendors.read`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
integerThe number of results per page.
integerOffset to start pagination search results.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#vendors)

Scoped OAuth requires: `vendors.read`
+ +```sql +SELECT +id, +name, +description, +html_url, +integration_guide_url, +logo_url, +self, +summary, +thumbnail_url, +type, +website_url +FROM pagerduty.vendors.vendors +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#vendors)

Scoped OAuth requires: `vendors.read`
+ +```sql +SELECT +id, +name, +description, +html_url, +integration_guide_url, +logo_url, +self, +summary, +thumbnail_url, +type, +website_url +FROM pagerduty.vendors.vendors +WHERE Accept = '{{ Accept }}' +AND Content-Type = '{{ Content-Type }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +; +``` + + + + +## Lifecycle Methods + + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#vendors)

Scoped OAuth requires: `vendors.read`
+ +```sql +EXEC pagerduty.vendors.vendors._list_vendors +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }} +; +``` + + + +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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#vendors)

Scoped OAuth requires: `vendors.read`
+ +```sql +EXEC pagerduty.vendors.vendors._get_vendor +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +; +``` + + diff --git a/website/docs/services/webhooks/index.md b/website/docs/services/webhooks/index.md new file mode 100644 index 0000000..9dd8085 --- /dev/null +++ b/website/docs/services/webhooks/index.md @@ -0,0 +1,33 @@ +--- +title: webhooks +hide_title: false +hide_table_of_contents: false +keywords: + - webhooks + - pagerduty + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +webhooks service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+webhook_subscriptions +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/webhooks/webhook_subscriptions/index.md b/website/docs/services/webhooks/webhook_subscriptions/index.md new file mode 100644 index 0000000..c047dfa --- /dev/null +++ b/website/docs/services/webhooks/webhook_subscriptions/index.md @@ -0,0 +1,480 @@ +--- +title: webhook_subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - webhook_subscriptions + - webhooks + - pagerduty + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage pagerduty resources using SQL +custom_edit_url: null +image: /img/stackql-pagerduty-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a webhook_subscriptions resource. + +## Overview + + + + +
Namewebhook_subscriptions
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The webhook subscription that was requested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
booleanDetermines whether this subscription will produce webhook events.
object
stringA short description of the webhook subscription.
arrayThe set of outbound event types the webhook will receive.
object
stringThe type indicating the schema of the object. (default: webhook_subscription)
+ + + +A set of webhook subscriptions matching the request. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
booleanDetermines whether this subscription will produce webhook events.
object
stringA short description of the webhook subscription.
arrayThe set of outbound event types the webhook will receive.
object
stringThe type indicating the schema of the object. (default: webhook_subscription)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idAcceptGets details about an existing webhook subscription.
Accept, limit, offset, total, filter_type, filter_idList 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/).
data__webhook_subscriptionAccept, Content-TypeCreates 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/).
idAcceptDeletes a webhook subscription.
Accept, limit, offset, total, filter_type, filter_idList 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/).
idAcceptGets details about an existing webhook subscription.
idAccept, Content-TypeUpdates 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.
idAcceptEnable 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.
idAcceptTest 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.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the resource.
stringThe `Accept` header is used as a versioning header.
string
stringThe id of the resource to filter upon.
stringThe type of resource to filter upon.
integerThe number of results per page.
integerOffset to start pagination search results.
booleanBy default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
+ +## `SELECT` examples + + + + +Gets details about an existing webhook subscription.
+ +```sql +SELECT +id, +active, +delivery_method, +description, +events, +filter, +type +FROM pagerduty.webhooks.webhook_subscriptions +WHERE id = '{{ id }}' -- required +AND Accept = '{{ Accept }}' +; +``` + + + +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/).
+ +```sql +SELECT +id, +active, +delivery_method, +description, +events, +filter, +type +FROM pagerduty.webhooks.webhook_subscriptions +WHERE Accept = '{{ Accept }}' +AND limit = '{{ limit }}' +AND offset = '{{ offset }}' +AND total = '{{ total }}' +AND filter_type = '{{ filter_type }}' +AND filter_id = '{{ filter_id }}' +; +``` + + + + +## `INSERT` examples + + + + +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/).
+ +```sql +INSERT INTO pagerduty.webhooks.webhook_subscriptions ( +data__webhook_subscription, +Accept, +Content-Type +) +SELECT +'{{ webhook_subscription }}' /* required */, +'{{ Accept }}', +'{{ Content-Type }}' +RETURNING +webhook_subscription +; +``` + + + +```yaml +# Description fields are for documentation purposes +- name: webhook_subscriptions + props: + - name: webhook_subscription + value: object + - name: Accept + value: string + description: The `Accept` header is used as a versioning header. + - name: Content-Type + value: string +``` + + + + +## `DELETE` examples + + + + +Deletes a webhook subscription.
+ +```sql +DELETE FROM pagerduty.webhooks.webhook_subscriptions +WHERE id = '{{ id }}' --required +AND Accept = '{{ Accept }}' +; +``` + + + + +## Lifecycle Methods + + + + +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/).
+ +```sql +EXEC pagerduty.webhooks.webhook_subscriptions._list_webhook_subscriptions +@Accept='{{ Accept }}', +@limit='{{ limit }}', +@offset='{{ offset }}', +@total={{ total }}, +@filter_type='{{ filter_type }}', +@filter_id='{{ filter_id }}' +; +``` + + + +Gets details about an existing webhook subscription.
+ +```sql +EXEC pagerduty.webhooks.webhook_subscriptions._get_webhook_subscription +@id='{{ id }}' --required, +@Accept='{{ Accept }}' +; +``` + + + +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.
+ +```sql +EXEC pagerduty.webhooks.webhook_subscriptions.update_webhook_subscription +@id='{{ id }}' --required, +@Accept='{{ Accept }}', +@Content-Type='{{ Content-Type }}' +@@json= +'{ +"webhook_subscription": "{{ 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.
+ +```sql +EXEC pagerduty.webhooks.webhook_subscriptions.enable_webhook_subscription +@id='{{ id }}' --required, +@Accept='{{ Accept }}' +; +``` + + + +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.
+ +```sql +EXEC pagerduty.webhooks.webhook_subscriptions.test_webhook_subscription +@id='{{ id }}' --required, +@Accept='{{ Accept }}' +; +``` + + diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 0257689..4ec628b 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -7,8 +7,8 @@ import {themes as prismThemes} from 'prism-react-renderer'; // Provider configuration - change these for different providers -const providerName = "yourprovidername"; -const providerTitle = "Your Provider Title"; +const providerName = "pagerduty"; +const providerTitle = "PagerDuty Provider"; const providerDropDownListItems = [ { diff --git a/website/yarn.lock b/website/yarn.lock new file mode 100644 index 0000000..13a8418 --- /dev/null +++ b/website/yarn.lock @@ -0,0 +1,9087 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@algolia/abtesting@1.3.0": + version "1.3.0" + resolved "https://registry.yarnpkg.com/@algolia/abtesting/-/abtesting-1.3.0.tgz#3fade769bf5b03244baaee8034b83e2b49f8e86c" + integrity sha512-KqPVLdVNfoJzX5BKNGM9bsW8saHeyax8kmPFXul5gejrSPN3qss7PgsFH5mMem7oR8tvjvNkia97ljEYPYCN8Q== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/autocomplete-core@1.17.9": + version "1.17.9" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.17.9.tgz#83374c47dc72482aa45d6b953e89377047f0dcdc" + integrity sha512-O7BxrpLDPJWWHv/DLA9DRFWs+iY1uOJZkqUwjS5HSZAGcl0hIVCQ97LTLewiZmZ402JYUrun+8NqFP+hCknlbQ== + dependencies: + "@algolia/autocomplete-plugin-algolia-insights" "1.17.9" + "@algolia/autocomplete-shared" "1.17.9" + +"@algolia/autocomplete-plugin-algolia-insights@1.17.9": + version "1.17.9" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.17.9.tgz#74c86024d09d09e8bfa3dd90b844b77d9f9947b6" + integrity sha512-u1fEHkCbWF92DBeB/KHeMacsjsoI0wFhjZtlCq2ddZbAehshbZST6Hs0Avkc0s+4UyBGbMDnSuXHLuvRWK5iDQ== + dependencies: + "@algolia/autocomplete-shared" "1.17.9" + +"@algolia/autocomplete-preset-algolia@1.17.9": + version "1.17.9" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-preset-algolia/-/autocomplete-preset-algolia-1.17.9.tgz#911f3250544eb8ea4096fcfb268f156b085321b5" + integrity sha512-Na1OuceSJeg8j7ZWn5ssMu/Ax3amtOwk76u4h5J4eK2Nx2KB5qt0Z4cOapCsxot9VcEN11ADV5aUSlQF4RhGjQ== + dependencies: + "@algolia/autocomplete-shared" "1.17.9" + +"@algolia/autocomplete-shared@1.17.9": + version "1.17.9" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.17.9.tgz#5f38868f7cb1d54b014b17a10fc4f7e79d427fa8" + integrity sha512-iDf05JDQ7I0b7JEA/9IektxN/80a2MZ1ToohfmNS3rfeuQnIKI3IJlIafD0xu4StbtQTghx9T3Maa97ytkXenQ== + +"@algolia/client-abtesting@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/client-abtesting/-/client-abtesting-5.37.0.tgz#37df3674ccc37dfb0aa4cbfea42002bb136fb909" + integrity sha512-Dp2Zq+x9qQFnuiQhVe91EeaaPxWBhzwQ6QnznZQnH9C1/ei3dvtmAFfFeaTxM6FzfJXDLvVnaQagTYFTQz3R5g== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/client-analytics@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/client-analytics/-/client-analytics-5.37.0.tgz#6fb4d748e1af43d8bc9f955d73d98205ce1c1ee5" + integrity sha512-wyXODDOluKogTuZxRII6mtqhAq4+qUR3zIUJEKTiHLe8HMZFxfUEI4NO2qSu04noXZHbv/sRVdQQqzKh12SZuQ== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/client-common@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/client-common/-/client-common-5.37.0.tgz#f7ca097c4bae44e4ea365ee8f420693d0005c98e" + integrity sha512-GylIFlPvLy9OMgFG8JkonIagv3zF+Dx3H401Uo2KpmfMVBBJiGfAb9oYfXtplpRMZnZPxF5FnkWaI/NpVJMC+g== + +"@algolia/client-insights@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/client-insights/-/client-insights-5.37.0.tgz#f4f4011fc89bc0b2dfc384acc3c6fb38f633f4ec" + integrity sha512-T63afO2O69XHKw2+F7mfRoIbmXWGzgpZxgOFAdP3fR4laid7pWBt20P4eJ+Zn23wXS5kC9P2K7Bo3+rVjqnYiw== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/client-personalization@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/client-personalization/-/client-personalization-5.37.0.tgz#c1688db681623b189f353599815a118033ceebb5" + integrity sha512-1zOIXM98O9zD8bYDCJiUJRC/qNUydGHK/zRK+WbLXrW1SqLFRXECsKZa5KoG166+o5q5upk96qguOtE8FTXDWQ== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/client-query-suggestions@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/client-query-suggestions/-/client-query-suggestions-5.37.0.tgz#fa514df8d36fb548258c712f3ba6f97eb84ebb87" + integrity sha512-31Nr2xOLBCYVal+OMZn1rp1H4lPs1914Tfr3a34wU/nsWJ+TB3vWjfkUUuuYhWoWBEArwuRzt3YNLn0F/KRVkg== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/client-search@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-5.37.0.tgz#38c7110d96fbbbda7b7fb0578a18b8cad3c25af2" + integrity sha512-DAFVUvEg+u7jUs6BZiVz9zdaUebYULPiQ4LM2R4n8Nujzyj7BZzGr2DCd85ip4p/cx7nAZWKM8pLcGtkTRTdsg== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/events@^4.0.1": + version "4.0.1" + resolved "https://registry.yarnpkg.com/@algolia/events/-/events-4.0.1.tgz#fd39e7477e7bc703d7f893b556f676c032af3950" + integrity sha512-FQzvOCgoFXAbf5Y6mYozw2aj5KCJoA3m4heImceldzPSMbdyS4atVjJzXKMsfX3wnZTFYwkkt8/z8UesLHlSBQ== + +"@algolia/ingestion@1.37.0": + version "1.37.0" + resolved "https://registry.yarnpkg.com/@algolia/ingestion/-/ingestion-1.37.0.tgz#bb6016e656c68014050814abf130e103f977794e" + integrity sha512-pkCepBRRdcdd7dTLbFddnu886NyyxmhgqiRcHHaDunvX03Ij4WzvouWrQq7B7iYBjkMQrLS8wQqSP0REfA4W8g== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/monitoring@1.37.0": + version "1.37.0" + resolved "https://registry.yarnpkg.com/@algolia/monitoring/-/monitoring-1.37.0.tgz#6d20c220d648db8faea45679350f1516917cc13d" + integrity sha512-fNw7pVdyZAAQQCJf1cc/ih4fwrRdQSgKwgor4gchsI/Q/ss9inmC6bl/69jvoRSzgZS9BX4elwHKdo0EfTli3w== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/recommend@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/recommend/-/recommend-5.37.0.tgz#dd5e814f30bbb92395902e120fdb28a120b91341" + integrity sha512-U+FL5gzN2ldx3TYfQO5OAta2TBuIdabEdFwD5UVfWPsZE5nvOKkc/6BBqP54Z/adW/34c5ZrvvZhlhNTZujJXQ== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/requester-browser-xhr@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/requester-browser-xhr/-/requester-browser-xhr-5.37.0.tgz#8851ab846d8005055c36a59422161ebe1594ae48" + integrity sha512-Ao8GZo8WgWFABrU7iq+JAftXV0t+UcOtCDL4mzHHZ+rQeTTf1TZssr4d0vIuoqkVNnKt9iyZ7T4lQff4ydcTrw== + dependencies: + "@algolia/client-common" "5.37.0" + +"@algolia/requester-fetch@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/requester-fetch/-/requester-fetch-5.37.0.tgz#93602fdc9a59b41ecd53768c53c11cddb0db846a" + integrity sha512-H7OJOXrFg5dLcGJ22uxx8eiFId0aB9b0UBhoOi4SMSuDBe6vjJJ/LeZyY25zPaSvkXNBN3vAM+ad6M0h6ha3AA== + dependencies: + "@algolia/client-common" "5.37.0" + +"@algolia/requester-node-http@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/requester-node-http/-/requester-node-http-5.37.0.tgz#83da1b52f3ee86f262a5d4b2a88a74db665211c2" + integrity sha512-npZ9aeag4SGTx677eqPL3rkSPlQrnzx/8wNrl1P7GpWq9w/eTmRbOq+wKrJ2r78idlY0MMgmY/mld2tq6dc44g== + dependencies: + "@algolia/client-common" "5.37.0" + +"@babel/code-frame@^7.0.0", "@babel/code-frame@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.27.1.tgz#200f715e66d52a23b221a9435534a91cc13ad5be" + integrity sha512-cjQ7ZlQ0Mv3b47hABuTevyTuYN4i+loJKGeV9flcCgIK37cCXRh+L1bd3iBHlynerhQ7BhCkn2BPbQUL+rGqFg== + dependencies: + "@babel/helper-validator-identifier" "^7.27.1" + js-tokens "^4.0.0" + picocolors "^1.1.1" + +"@babel/compat-data@^7.27.2", "@babel/compat-data@^7.27.7", "@babel/compat-data@^7.28.0": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.28.4.tgz#96fdf1af1b8859c8474ab39c295312bfb7c24b04" + integrity sha512-YsmSKC29MJwf0gF8Rjjrg5LQCmyh+j/nD8/eP7f+BeoQTKYqs9RoWbjGOdy0+1Ekr68RJZMUOPVQaQisnIo4Rw== + +"@babel/core@^7.21.3", "@babel/core@^7.25.9": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.28.4.tgz#12a550b8794452df4c8b084f95003bce1742d496" + integrity sha512-2BCOP7TN8M+gVDj7/ht3hsaO/B/n5oDbiAyyvnRlNOs+u1o+JWNYTQrmpuNp1/Wq2gcFrI01JAW+paEKDMx/CA== + dependencies: + "@babel/code-frame" "^7.27.1" + "@babel/generator" "^7.28.3" + "@babel/helper-compilation-targets" "^7.27.2" + "@babel/helper-module-transforms" "^7.28.3" + "@babel/helpers" "^7.28.4" + "@babel/parser" "^7.28.4" + "@babel/template" "^7.27.2" + "@babel/traverse" "^7.28.4" + "@babel/types" "^7.28.4" + "@jridgewell/remapping" "^2.3.5" + convert-source-map "^2.0.0" + debug "^4.1.0" + gensync "^1.0.0-beta.2" + json5 "^2.2.3" + semver "^6.3.1" + +"@babel/generator@^7.25.9", "@babel/generator@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.28.3.tgz#9626c1741c650cbac39121694a0f2d7451b8ef3e" + integrity sha512-3lSpxGgvnmZznmBkCRnVREPUFJv2wrv9iAoFDvADJc0ypmdOxdUtcLeBgBJ6zE0PMeTKnxeQzyk0xTBq4Ep7zw== + dependencies: + "@babel/parser" "^7.28.3" + "@babel/types" "^7.28.2" + "@jridgewell/gen-mapping" "^0.3.12" + "@jridgewell/trace-mapping" "^0.3.28" + jsesc "^3.0.2" + +"@babel/helper-annotate-as-pure@^7.27.1", "@babel/helper-annotate-as-pure@^7.27.3": + version "7.27.3" + resolved "https://registry.yarnpkg.com/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.27.3.tgz#f31fd86b915fc4daf1f3ac6976c59be7084ed9c5" + integrity sha512-fXSwMQqitTGeHLBC08Eq5yXz2m37E4pJX1qAU1+2cNedz/ifv/bVXft90VeSav5nFO61EcNgwr0aJxbyPaWBPg== + dependencies: + "@babel/types" "^7.27.3" + +"@babel/helper-compilation-targets@^7.27.1", "@babel/helper-compilation-targets@^7.27.2": + version "7.27.2" + resolved "https://registry.yarnpkg.com/@babel/helper-compilation-targets/-/helper-compilation-targets-7.27.2.tgz#46a0f6efab808d51d29ce96858dd10ce8732733d" + integrity sha512-2+1thGUUWWjLTYTHZWK1n8Yga0ijBz1XAhUXcKy81rd5g6yh7hGqMp45v7cadSbEHc9G3OTv45SyneRN3ps4DQ== + dependencies: + "@babel/compat-data" "^7.27.2" + "@babel/helper-validator-option" "^7.27.1" + browserslist "^4.24.0" + lru-cache "^5.1.1" + semver "^6.3.1" + +"@babel/helper-create-class-features-plugin@^7.27.1", "@babel/helper-create-class-features-plugin@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.28.3.tgz#3e747434ea007910c320c4d39a6b46f20f371d46" + integrity sha512-V9f6ZFIYSLNEbuGA/92uOvYsGCJNsuA8ESZ4ldc09bWk/j8H8TKiPw8Mk1eG6olpnO0ALHJmYfZvF4MEE4gajg== + dependencies: + "@babel/helper-annotate-as-pure" "^7.27.3" + "@babel/helper-member-expression-to-functions" "^7.27.1" + "@babel/helper-optimise-call-expression" "^7.27.1" + "@babel/helper-replace-supers" "^7.27.1" + "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" + "@babel/traverse" "^7.28.3" + semver "^6.3.1" + +"@babel/helper-create-regexp-features-plugin@^7.18.6", "@babel/helper-create-regexp-features-plugin@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.27.1.tgz#05b0882d97ba1d4d03519e4bce615d70afa18c53" + integrity sha512-uVDC72XVf8UbrH5qQTc18Agb8emwjTiZrQE11Nv3CuBEZmVvTwwE9CBUEvHku06gQCAyYf8Nv6ja1IN+6LMbxQ== + dependencies: + "@babel/helper-annotate-as-pure" "^7.27.1" + regexpu-core "^6.2.0" + semver "^6.3.1" + +"@babel/helper-define-polyfill-provider@^0.6.5": + version "0.6.5" + resolved "https://registry.yarnpkg.com/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.5.tgz#742ccf1cb003c07b48859fc9fa2c1bbe40e5f753" + integrity sha512-uJnGFcPsWQK8fvjgGP5LZUZZsYGIoPeRjSF5PGwrelYgq7Q15/Ft9NGFp1zglwgIv//W0uG4BevRuSJRyylZPg== + dependencies: + "@babel/helper-compilation-targets" "^7.27.2" + "@babel/helper-plugin-utils" "^7.27.1" + debug "^4.4.1" + lodash.debounce "^4.0.8" + resolve "^1.22.10" + +"@babel/helper-globals@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/helper-globals/-/helper-globals-7.28.0.tgz#b9430df2aa4e17bc28665eadeae8aa1d985e6674" + integrity sha512-+W6cISkXFa1jXsDEdYA8HeevQT/FULhxzR99pxphltZcVaugps53THCeiWA8SguxxpSp3gKPiuYfSWopkLQ4hw== + +"@babel/helper-member-expression-to-functions@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.27.1.tgz#ea1211276be93e798ce19037da6f06fbb994fa44" + integrity sha512-E5chM8eWjTp/aNoVpcbfM7mLxu9XGLWYise2eBKGQomAk/Mb4XoxyqXTZbuTohbsl8EKqdlMhnDI2CCLfcs9wA== + dependencies: + "@babel/traverse" "^7.27.1" + "@babel/types" "^7.27.1" + +"@babel/helper-module-imports@^7.16.7", "@babel/helper-module-imports@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-module-imports/-/helper-module-imports-7.27.1.tgz#7ef769a323e2655e126673bb6d2d6913bbead204" + integrity sha512-0gSFWUPNXNopqtIPQvlD5WgXYI5GY2kP2cCvoT8kczjbfcfuIljTbcWrulD1CIPIX2gt1wghbDy08yE1p+/r3w== + dependencies: + "@babel/traverse" "^7.27.1" + "@babel/types" "^7.27.1" + +"@babel/helper-module-transforms@^7.27.1", "@babel/helper-module-transforms@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.28.3.tgz#a2b37d3da3b2344fe085dab234426f2b9a2fa5f6" + integrity sha512-gytXUbs8k2sXS9PnQptz5o0QnpLL51SwASIORY6XaBKF88nsOT0Zw9szLqlSGQDP/4TljBAD5y98p2U1fqkdsw== + dependencies: + "@babel/helper-module-imports" "^7.27.1" + "@babel/helper-validator-identifier" "^7.27.1" + "@babel/traverse" "^7.28.3" + +"@babel/helper-optimise-call-expression@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.27.1.tgz#c65221b61a643f3e62705e5dd2b5f115e35f9200" + integrity sha512-URMGH08NzYFhubNSGJrpUEphGKQwMQYBySzat5cAByY1/YgIRkULnIy3tAMeszlL/so2HbeilYloUmSpd7GdVw== + dependencies: + "@babel/types" "^7.27.1" + +"@babel/helper-plugin-utils@^7.0.0", "@babel/helper-plugin-utils@^7.18.6", "@babel/helper-plugin-utils@^7.27.1", "@babel/helper-plugin-utils@^7.8.0": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-plugin-utils/-/helper-plugin-utils-7.27.1.tgz#ddb2f876534ff8013e6c2b299bf4d39b3c51d44c" + integrity sha512-1gn1Up5YXka3YYAHGKpbideQ5Yjf1tDa9qYcgysz+cNCXukyLl6DjPXhD3VRwSb8c0J9tA4b2+rHEZtc6R0tlw== + +"@babel/helper-remap-async-to-generator@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.27.1.tgz#4601d5c7ce2eb2aea58328d43725523fcd362ce6" + integrity sha512-7fiA521aVw8lSPeI4ZOD3vRFkoqkJcS+z4hFo82bFSH/2tNd6eJ5qCVMS5OzDmZh/kaHQeBaeyxK6wljcPtveA== + dependencies: + "@babel/helper-annotate-as-pure" "^7.27.1" + "@babel/helper-wrap-function" "^7.27.1" + "@babel/traverse" "^7.27.1" + +"@babel/helper-replace-supers@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-replace-supers/-/helper-replace-supers-7.27.1.tgz#b1ed2d634ce3bdb730e4b52de30f8cccfd692bc0" + integrity sha512-7EHz6qDZc8RYS5ElPoShMheWvEgERonFCs7IAonWLLUTXW59DP14bCZt89/GKyreYn8g3S83m21FelHKbeDCKA== + dependencies: + "@babel/helper-member-expression-to-functions" "^7.27.1" + "@babel/helper-optimise-call-expression" "^7.27.1" + "@babel/traverse" "^7.27.1" + +"@babel/helper-skip-transparent-expression-wrappers@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.27.1.tgz#62bb91b3abba8c7f1fec0252d9dbea11b3ee7a56" + integrity sha512-Tub4ZKEXqbPjXgWLl2+3JpQAYBJ8+ikpQ2Ocj/q/r0LwE3UhENh7EUabyHjz2kCEsrRY83ew2DQdHluuiDQFzg== + dependencies: + "@babel/traverse" "^7.27.1" + "@babel/types" "^7.27.1" + +"@babel/helper-string-parser@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz#54da796097ab19ce67ed9f88b47bb2ec49367687" + integrity sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA== + +"@babel/helper-validator-identifier@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.27.1.tgz#a7054dcc145a967dd4dc8fee845a57c1316c9df8" + integrity sha512-D2hP9eA+Sqx1kBZgzxZh0y1trbuU+JoDkiEwqhQ36nodYqJwyEIhPSdMNd7lOm/4io72luTPWH20Yda0xOuUow== + +"@babel/helper-validator-option@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz#fa52f5b1e7db1ab049445b421c4471303897702f" + integrity sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg== + +"@babel/helper-wrap-function@^7.27.1": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/helper-wrap-function/-/helper-wrap-function-7.28.3.tgz#fe4872092bc1438ffd0ce579e6f699609f9d0a7a" + integrity sha512-zdf983tNfLZFletc0RRXYrHrucBEg95NIFMkn6K9dbeMYnsgHaSBGcQqdsCSStG2PYwRre0Qc2NNSCXbG+xc6g== + dependencies: + "@babel/template" "^7.27.2" + "@babel/traverse" "^7.28.3" + "@babel/types" "^7.28.2" + +"@babel/helpers@^7.28.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.28.4.tgz#fe07274742e95bdf7cf1443593eeb8926ab63827" + integrity sha512-HFN59MmQXGHVyYadKLVumYsA9dBFun/ldYxipEjzA4196jpLZd8UjEEBLkbEkvfYreDqJhZxYAWFPtrfhNpj4w== + dependencies: + "@babel/template" "^7.27.2" + "@babel/types" "^7.28.4" + +"@babel/parser@^7.27.2", "@babel/parser@^7.28.3", "@babel/parser@^7.28.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.28.4.tgz#da25d4643532890932cc03f7705fe19637e03fa8" + integrity sha512-yZbBqeM6TkpP9du/I2pUZnJsRMGGvOuIrhjzC1AwHwW+6he4mni6Bp/m8ijn0iOuZuPI2BfkCoSRunpyjnrQKg== + dependencies: + "@babel/types" "^7.28.4" + +"@babel/plugin-bugfix-firefox-class-in-computed-class-key@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-firefox-class-in-computed-class-key/-/plugin-bugfix-firefox-class-in-computed-class-key-7.27.1.tgz#61dd8a8e61f7eb568268d1b5f129da3eee364bf9" + integrity sha512-QPG3C9cCVRQLxAVwmefEmwdTanECuUBMQZ/ym5kiw3XKCGA7qkuQLcjWWHcrD/GKbn/WmJwaezfuuAOcyKlRPA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/traverse" "^7.27.1" + +"@babel/plugin-bugfix-safari-class-field-initializer-scope@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-safari-class-field-initializer-scope/-/plugin-bugfix-safari-class-field-initializer-scope-7.27.1.tgz#43f70a6d7efd52370eefbdf55ae03d91b293856d" + integrity sha512-qNeq3bCKnGgLkEXUuFry6dPlGfCdQNZbn7yUAPCInwAJHMU7THJfrBSozkcWq5sNM6RcF3S8XyQL2A52KNR9IA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression/-/plugin-bugfix-safari-id-destructuring-collision-in-function-expression-7.27.1.tgz#beb623bd573b8b6f3047bd04c32506adc3e58a72" + integrity sha512-g4L7OYun04N1WyqMNjldFwlfPCLVkgB54A/YCXICZYBsvJJE3kByKv9c9+R/nAfmIfjl2rKYLNyMHboYbZaWaA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining/-/plugin-bugfix-v8-spread-parameters-in-optional-chaining-7.27.1.tgz#e134a5479eb2ba9c02714e8c1ebf1ec9076124fd" + integrity sha512-oO02gcONcD5O1iTLi/6frMJBIwWEHceWGSGqrpCmEL8nogiS6J9PBlE48CaK20/Jx1LuRml9aDftLgdjXT8+Cw== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" + "@babel/plugin-transform-optional-chaining" "^7.27.1" + +"@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.28.3.tgz#373f6e2de0016f73caf8f27004f61d167743742a" + integrity sha512-b6YTX108evsvE4YgWyQ921ZAFFQm3Bn+CA3+ZXlNVnPhx+UfsVURoPjfGAPCjBgrqo30yX/C2nZGX96DxvR9Iw== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/traverse" "^7.28.3" + +"@babel/plugin-proposal-private-property-in-object@7.21.0-placeholder-for-preset-env.2": + version "7.21.0-placeholder-for-preset-env.2" + resolved "https://registry.yarnpkg.com/@babel/plugin-proposal-private-property-in-object/-/plugin-proposal-private-property-in-object-7.21.0-placeholder-for-preset-env.2.tgz#7844f9289546efa9febac2de4cfe358a050bd703" + integrity sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w== + +"@babel/plugin-syntax-dynamic-import@^7.8.3": + version "7.8.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-dynamic-import/-/plugin-syntax-dynamic-import-7.8.3.tgz#62bf98b2da3cd21d626154fc96ee5b3cb68eacb3" + integrity sha512-5gdGbFon+PszYzqs83S3E5mpi7/y/8M9eC90MRTZfduQOYW76ig6SOSPNe41IG5LoP3FGBn2N0RjVDSQiS94kQ== + dependencies: + "@babel/helper-plugin-utils" "^7.8.0" + +"@babel/plugin-syntax-import-assertions@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-import-assertions/-/plugin-syntax-import-assertions-7.27.1.tgz#88894aefd2b03b5ee6ad1562a7c8e1587496aecd" + integrity sha512-UT/Jrhw57xg4ILHLFnzFpPDlMbcdEicaAtjPQpbj9wa8T4r5KVWCimHcL/460g8Ht0DMxDyjsLgiWSkVjnwPFg== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-syntax-import-attributes@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.27.1.tgz#34c017d54496f9b11b61474e7ea3dfd5563ffe07" + integrity sha512-oFT0FrKHgF53f4vOsZGi2Hh3I35PfSmVs4IBFLFj4dnafP+hIWDLg3VyKmUHfLoLHlyxY4C7DGtmHuJgn+IGww== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-syntax-jsx@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.27.1.tgz#2f9beb5eff30fa507c5532d107daac7b888fa34c" + integrity sha512-y8YTNIeKoyhGd9O0Jiyzyyqk8gdjnumGTQPsz0xOZOQ2RmkVJeZ1vmmfIvFEKqucBG6axJGBZDE/7iI5suUI/w== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-syntax-typescript@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.27.1.tgz#5147d29066a793450f220c63fa3a9431b7e6dd18" + integrity sha512-xfYCBMxveHrRMnAWl1ZlPXOZjzkN82THFvLhQhFXFt81Z5HnN+EtUkZhv/zcKpmT3fzmWZB0ywiBrbC3vogbwQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-syntax-unicode-sets-regex@^7.18.6": + version "7.18.6" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-unicode-sets-regex/-/plugin-syntax-unicode-sets-regex-7.18.6.tgz#d49a3b3e6b52e5be6740022317580234a6a47357" + integrity sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg== + dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.18.6" + "@babel/helper-plugin-utils" "^7.18.6" + +"@babel/plugin-transform-arrow-functions@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.27.1.tgz#6e2061067ba3ab0266d834a9f94811196f2aba9a" + integrity sha512-8Z4TGic6xW70FKThA5HYEKKyBpOOsucTOD1DjU3fZxDg+K3zBJcXMFnt/4yQiZnf5+MiOMSXQ9PaEK/Ilh1DeA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-async-generator-functions@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.28.0.tgz#1276e6c7285ab2cd1eccb0bc7356b7a69ff842c2" + integrity sha512-BEOdvX4+M765icNPZeidyADIvQ1m1gmunXufXxvRESy/jNNyfovIqUyE7MVgGBjWktCoJlzvFA1To2O4ymIO3Q== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-remap-async-to-generator" "^7.27.1" + "@babel/traverse" "^7.28.0" + +"@babel/plugin-transform-async-to-generator@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.27.1.tgz#9a93893b9379b39466c74474f55af03de78c66e7" + integrity sha512-NREkZsZVJS4xmTr8qzE5y8AfIPqsdQfRuUiLRTEzb7Qii8iFWCyDKaUV2c0rCuh4ljDZ98ALHP/PetiBV2nddA== + dependencies: + "@babel/helper-module-imports" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-remap-async-to-generator" "^7.27.1" + +"@babel/plugin-transform-block-scoped-functions@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.27.1.tgz#558a9d6e24cf72802dd3b62a4b51e0d62c0f57f9" + integrity sha512-cnqkuOtZLapWYZUYM5rVIdv1nXYuFVIltZ6ZJ7nIj585QsjKM5dhL2Fu/lICXZ1OyIAFc7Qy+bvDAtTXqGrlhg== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-block-scoping@^7.28.0": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.28.4.tgz#e19ac4ddb8b7858bac1fd5c1be98a994d9726410" + integrity sha512-1yxmvN0MJHOhPVmAsmoW5liWwoILobu/d/ShymZmj867bAdxGbehIrew1DuLpw2Ukv+qDSSPQdYW1dLNE7t11A== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-class-properties@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-class-properties/-/plugin-transform-class-properties-7.27.1.tgz#dd40a6a370dfd49d32362ae206ddaf2bb082a925" + integrity sha512-D0VcalChDMtuRvJIu3U/fwWjf8ZMykz5iZsg77Nuj821vCKI3zCyRLwRdWbsuJ/uRwZhZ002QtCqIkwC/ZkvbA== + dependencies: + "@babel/helper-create-class-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-class-static-block@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.28.3.tgz#d1b8e69b54c9993bc558203e1f49bfc979bfd852" + integrity sha512-LtPXlBbRoc4Njl/oh1CeD/3jC+atytbnf/UqLoqTDcEYGUPj022+rvfkbDYieUrSj3CaV4yHDByPE+T2HwfsJg== + dependencies: + "@babel/helper-create-class-features-plugin" "^7.28.3" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-classes@^7.28.3": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-classes/-/plugin-transform-classes-7.28.4.tgz#75d66175486788c56728a73424d67cbc7473495c" + integrity sha512-cFOlhIYPBv/iBoc+KS3M6et2XPtbT2HiCRfBXWtfpc9OAyostldxIf9YAYB6ypURBBbx+Qv6nyrLzASfJe+hBA== + dependencies: + "@babel/helper-annotate-as-pure" "^7.27.3" + "@babel/helper-compilation-targets" "^7.27.2" + "@babel/helper-globals" "^7.28.0" + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-replace-supers" "^7.27.1" + "@babel/traverse" "^7.28.4" + +"@babel/plugin-transform-computed-properties@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.27.1.tgz#81662e78bf5e734a97982c2b7f0a793288ef3caa" + integrity sha512-lj9PGWvMTVksbWiDT2tW68zGS/cyo4AkZ/QTp0sQT0mjPopCmrSkzxeXkznjqBxzDI6TclZhOJbBmbBLjuOZUw== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/template" "^7.27.1" + +"@babel/plugin-transform-destructuring@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.28.0.tgz#0f156588f69c596089b7d5b06f5af83d9aa7f97a" + integrity sha512-v1nrSMBiKcodhsyJ4Gf+Z0U/yawmJDBOTpEB3mcQY52r9RIyPneGyAS/yM6seP/8I+mWI3elOMtT5dB8GJVs+A== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/traverse" "^7.28.0" + +"@babel/plugin-transform-dotall-regex@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.27.1.tgz#aa6821de864c528b1fecf286f0a174e38e826f4d" + integrity sha512-gEbkDVGRvjj7+T1ivxrfgygpT7GUd4vmODtYpbs0gZATdkX8/iSnOtZSxiZnsgm1YjTgjI6VKBGSJJevkrclzw== + dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-duplicate-keys@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.27.1.tgz#f1fbf628ece18e12e7b32b175940e68358f546d1" + integrity sha512-MTyJk98sHvSs+cvZ4nOauwTTG1JeonDjSGvGGUNHreGQns+Mpt6WX/dVzWBHgg+dYZhkC4X+zTDfkTU+Vy9y7Q== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-duplicate-named-capturing-groups-regex@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-duplicate-named-capturing-groups-regex/-/plugin-transform-duplicate-named-capturing-groups-regex-7.27.1.tgz#5043854ca620a94149372e69030ff8cb6a9eb0ec" + integrity sha512-hkGcueTEzuhB30B3eJCbCYeCaaEQOmQR0AdvzpD4LoN0GXMWzzGSuRrxR2xTnCrvNbVwK9N6/jQ92GSLfiZWoQ== + dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-dynamic-import@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-dynamic-import/-/plugin-transform-dynamic-import-7.27.1.tgz#4c78f35552ac0e06aa1f6e3c573d67695e8af5a4" + integrity sha512-MHzkWQcEmjzzVW9j2q8LGjwGWpG2mjwaaB0BNQwst3FIjqsg8Ct/mIZlvSPJvfi9y2AC8mi/ktxbFVL9pZ1I4A== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-explicit-resource-management@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-explicit-resource-management/-/plugin-transform-explicit-resource-management-7.28.0.tgz#45be6211b778dbf4b9d54c4e8a2b42fa72e09a1a" + integrity sha512-K8nhUcn3f6iB+P3gwCv/no7OdzOZQcKchW6N389V6PD8NUWKZHzndOd9sPDVbMoBsbmjMqlB4L9fm+fEFNVlwQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/plugin-transform-destructuring" "^7.28.0" + +"@babel/plugin-transform-exponentiation-operator@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.27.1.tgz#fc497b12d8277e559747f5a3ed868dd8064f83e1" + integrity sha512-uspvXnhHvGKf2r4VVtBpeFnuDWsJLQ6MF6lGJLC89jBR1uoVeqM416AZtTuhTezOfgHicpJQmoD5YUakO/YmXQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-export-namespace-from@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-export-namespace-from/-/plugin-transform-export-namespace-from-7.27.1.tgz#71ca69d3471edd6daa711cf4dfc3400415df9c23" + integrity sha512-tQvHWSZ3/jH2xuq/vZDy0jNn+ZdXJeM8gHvX4lnJmsc3+50yPlWdZXIc5ay+umX+2/tJIqHqiEqcJvxlmIvRvQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-for-of@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.27.1.tgz#bc24f7080e9ff721b63a70ac7b2564ca15b6c40a" + integrity sha512-BfbWFFEJFQzLCQ5N8VocnCtA8J1CLkNTe2Ms2wocj75dd6VpiqS5Z5quTYcUoo4Yq+DN0rtikODccuv7RU81sw== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" + +"@babel/plugin-transform-function-name@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.27.1.tgz#4d0bf307720e4dce6d7c30fcb1fd6ca77bdeb3a7" + integrity sha512-1bQeydJF9Nr1eBCMMbC+hdwmRlsv5XYOMu03YSWFwNs0HsAmtSxxF1fyuYPqemVldVyFmlCU7w8UE14LupUSZQ== + dependencies: + "@babel/helper-compilation-targets" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/traverse" "^7.27.1" + +"@babel/plugin-transform-json-strings@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-json-strings/-/plugin-transform-json-strings-7.27.1.tgz#a2e0ce6ef256376bd527f290da023983527a4f4c" + integrity sha512-6WVLVJiTjqcQauBhn1LkICsR2H+zm62I3h9faTDKt1qP4jn2o72tSvqMwtGFKGTpojce0gJs+76eZ2uCHRZh0Q== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-literals@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-literals/-/plugin-transform-literals-7.27.1.tgz#baaefa4d10a1d4206f9dcdda50d7d5827bb70b24" + integrity sha512-0HCFSepIpLTkLcsi86GG3mTUzxV5jpmbv97hTETW3yzrAij8aqlD36toB1D0daVFJM8NK6GvKO0gslVQmm+zZA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-logical-assignment-operators@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-logical-assignment-operators/-/plugin-transform-logical-assignment-operators-7.27.1.tgz#890cb20e0270e0e5bebe3f025b434841c32d5baa" + integrity sha512-SJvDs5dXxiae4FbSL1aBJlG4wvl594N6YEVVn9e3JGulwioy6z3oPjx/sQBO3Y4NwUu5HNix6KJ3wBZoewcdbw== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-member-expression-literals@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.27.1.tgz#37b88ba594d852418e99536f5612f795f23aeaf9" + integrity sha512-hqoBX4dcZ1I33jCSWcXrP+1Ku7kdqXf1oeah7ooKOIiAdKQ+uqftgCFNOSzA5AMS2XIHEYeGFg4cKRCdpxzVOQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-modules-amd@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.27.1.tgz#a4145f9d87c2291fe2d05f994b65dba4e3e7196f" + integrity sha512-iCsytMg/N9/oFq6n+gFTvUYDZQOMK5kEdeYxmxt91fcJGycfxVP9CnrxoliM0oumFERba2i8ZtwRUCMhvP1LnA== + dependencies: + "@babel/helper-module-transforms" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-modules-commonjs@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.27.1.tgz#8e44ed37c2787ecc23bdc367f49977476614e832" + integrity sha512-OJguuwlTYlN0gBZFRPqwOGNWssZjfIUdS7HMYtN8c1KmwpwHFBwTeFZrg9XZa+DFTitWOW5iTAG7tyCUPsCCyw== + dependencies: + "@babel/helper-module-transforms" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-modules-systemjs@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.27.1.tgz#00e05b61863070d0f3292a00126c16c0e024c4ed" + integrity sha512-w5N1XzsRbc0PQStASMksmUeqECuzKuTJer7kFagK8AXgpCMkeDMO5S+aaFb7A51ZYDF7XI34qsTX+fkHiIm5yA== + dependencies: + "@babel/helper-module-transforms" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-validator-identifier" "^7.27.1" + "@babel/traverse" "^7.27.1" + +"@babel/plugin-transform-modules-umd@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.27.1.tgz#63f2cf4f6dc15debc12f694e44714863d34cd334" + integrity sha512-iQBE/xC5BV1OxJbp6WG7jq9IWiD+xxlZhLrdwpPkTX3ydmXdvoCpyfJN7acaIBZaOqTfr76pgzqBJflNbeRK+w== + dependencies: + "@babel/helper-module-transforms" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-named-capturing-groups-regex@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.27.1.tgz#f32b8f7818d8fc0cc46ee20a8ef75f071af976e1" + integrity sha512-SstR5JYy8ddZvD6MhV0tM/j16Qds4mIpJTOd1Yu9J9pJjH93bxHECF7pgtc28XvkzTD6Pxcm/0Z73Hvk7kb3Ng== + dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-new-target@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.27.1.tgz#259c43939728cad1706ac17351b7e6a7bea1abeb" + integrity sha512-f6PiYeqXQ05lYq3TIfIDu/MtliKUbNwkGApPUvyo6+tc7uaR4cPjPe7DFPr15Uyycg2lZU6btZ575CuQoYh7MQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-nullish-coalescing-operator@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-nullish-coalescing-operator/-/plugin-transform-nullish-coalescing-operator-7.27.1.tgz#4f9d3153bf6782d73dd42785a9d22d03197bc91d" + integrity sha512-aGZh6xMo6q9vq1JGcw58lZ1Z0+i0xB2x0XaauNIUXd6O1xXc3RwoWEBlsTQrY4KQ9Jf0s5rgD6SiNkaUdJegTA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-numeric-separator@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-numeric-separator/-/plugin-transform-numeric-separator-7.27.1.tgz#614e0b15cc800e5997dadd9bd6ea524ed6c819c6" + integrity sha512-fdPKAcujuvEChxDBJ5c+0BTaS6revLV7CJL08e4m3de8qJfNIuCc2nc7XJYOjBoTMJeqSmwXJ0ypE14RCjLwaw== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-object-rest-spread@^7.28.0": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.28.4.tgz#9ee1ceca80b3e6c4bac9247b2149e36958f7f98d" + integrity sha512-373KA2HQzKhQCYiRVIRr+3MjpCObqzDlyrM6u4I201wL8Mp2wHf7uB8GhDwis03k2ti8Zr65Zyyqs1xOxUF/Ew== + dependencies: + "@babel/helper-compilation-targets" "^7.27.2" + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/plugin-transform-destructuring" "^7.28.0" + "@babel/plugin-transform-parameters" "^7.27.7" + "@babel/traverse" "^7.28.4" + +"@babel/plugin-transform-object-super@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.27.1.tgz#1c932cd27bf3874c43a5cac4f43ebf970c9871b5" + integrity sha512-SFy8S9plRPbIcxlJ8A6mT/CxFdJx/c04JEctz4jf8YZaVS2px34j7NXRrlGlHkN/M2gnpL37ZpGRGVFLd3l8Ng== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-replace-supers" "^7.27.1" + +"@babel/plugin-transform-optional-catch-binding@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-optional-catch-binding/-/plugin-transform-optional-catch-binding-7.27.1.tgz#84c7341ebde35ccd36b137e9e45866825072a30c" + integrity sha512-txEAEKzYrHEX4xSZN4kJ+OfKXFVSWKB2ZxM9dpcE3wT7smwkNmXo5ORRlVzMVdJbD+Q8ILTgSD7959uj+3Dm3Q== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-optional-chaining@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-optional-chaining/-/plugin-transform-optional-chaining-7.27.1.tgz#874ce3c4f06b7780592e946026eb76a32830454f" + integrity sha512-BQmKPPIuc8EkZgNKsv0X4bPmOoayeu4F1YCwx2/CfmDSXDbp7GnzlUH+/ul5VGfRg1AoFPsrIThlEBj2xb4CAg== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" + +"@babel/plugin-transform-parameters@^7.27.7": + version "7.27.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.27.7.tgz#1fd2febb7c74e7d21cf3b05f7aebc907940af53a" + integrity sha512-qBkYTYCb76RRxUM6CcZA5KRu8K4SM8ajzVeUgVdMVO9NN9uI/GaVmBg/WKJJGnNokV9SY8FxNOVWGXzqzUidBg== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-private-methods@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-private-methods/-/plugin-transform-private-methods-7.27.1.tgz#fdacbab1c5ed81ec70dfdbb8b213d65da148b6af" + integrity sha512-10FVt+X55AjRAYI9BrdISN9/AQWHqldOeZDUoLyif1Kn05a56xVBXb8ZouL8pZ9jem8QpXaOt8TS7RHUIS+GPA== + dependencies: + "@babel/helper-create-class-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-private-property-in-object@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-private-property-in-object/-/plugin-transform-private-property-in-object-7.27.1.tgz#4dbbef283b5b2f01a21e81e299f76e35f900fb11" + integrity sha512-5J+IhqTi1XPa0DXF83jYOaARrX+41gOewWbkPyjMNRDqgOCqdffGh8L3f/Ek5utaEBZExjSAzcyjmV9SSAWObQ== + dependencies: + "@babel/helper-annotate-as-pure" "^7.27.1" + "@babel/helper-create-class-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-property-literals@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.27.1.tgz#07eafd618800591e88073a0af1b940d9a42c6424" + integrity sha512-oThy3BCuCha8kDZ8ZkgOg2exvPYUlprMukKQXI1r1pJ47NCvxfkEy8vK+r/hT9nF0Aa4H1WUPZZjHTFtAhGfmQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-react-constant-elements@^7.21.3": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-constant-elements/-/plugin-transform-react-constant-elements-7.27.1.tgz#6c6b50424e749a6e48afd14cf7b92f98cb9383f9" + integrity sha512-edoidOjl/ZxvYo4lSBOQGDSyToYVkTAwyVoa2tkuYTSmjrB1+uAedoL5iROVLXkxH+vRgA7uP4tMg2pUJpZ3Ug== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-react-display-name@^7.27.1": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-display-name/-/plugin-transform-react-display-name-7.28.0.tgz#6f20a7295fea7df42eb42fed8f896813f5b934de" + integrity sha512-D6Eujc2zMxKjfa4Zxl4GHMsmhKKZ9VpcqIchJLvwTxad9zWIYulwYItBovpDOoNLISpcZSXoDJ5gaGbQUDqViA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-react-jsx-development@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-jsx-development/-/plugin-transform-react-jsx-development-7.27.1.tgz#47ff95940e20a3a70e68ad3d4fcb657b647f6c98" + integrity sha512-ykDdF5yI4f1WrAolLqeF3hmYU12j9ntLQl/AOG1HAS21jxyg1Q0/J/tpREuYLfatGdGmXp/3yS0ZA76kOlVq9Q== + dependencies: + "@babel/plugin-transform-react-jsx" "^7.27.1" + +"@babel/plugin-transform-react-jsx@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-jsx/-/plugin-transform-react-jsx-7.27.1.tgz#1023bc94b78b0a2d68c82b5e96aed573bcfb9db0" + integrity sha512-2KH4LWGSrJIkVf5tSiBFYuXDAoWRq2MMwgivCf+93dd0GQi8RXLjKA/0EvRnVV5G0hrHczsquXuD01L8s6dmBw== + dependencies: + "@babel/helper-annotate-as-pure" "^7.27.1" + "@babel/helper-module-imports" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/plugin-syntax-jsx" "^7.27.1" + "@babel/types" "^7.27.1" + +"@babel/plugin-transform-react-pure-annotations@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-pure-annotations/-/plugin-transform-react-pure-annotations-7.27.1.tgz#339f1ce355eae242e0649f232b1c68907c02e879" + integrity sha512-JfuinvDOsD9FVMTHpzA/pBLisxpv1aSf+OIV8lgH3MuWrks19R27e6a6DipIg4aX1Zm9Wpb04p8wljfKrVSnPA== + dependencies: + "@babel/helper-annotate-as-pure" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-regenerator@^7.28.3": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.28.4.tgz#9d3fa3bebb48ddd0091ce5729139cd99c67cea51" + integrity sha512-+ZEdQlBoRg9m2NnzvEeLgtvBMO4tkFBw5SQIUgLICgTrumLoU7lr+Oghi6km2PFj+dbUt2u1oby2w3BDO9YQnA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-regexp-modifiers@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-regexp-modifiers/-/plugin-transform-regexp-modifiers-7.27.1.tgz#df9ba5577c974e3f1449888b70b76169998a6d09" + integrity sha512-TtEciroaiODtXvLZv4rmfMhkCv8jx3wgKpL68PuiPh2M4fvz5jhsA7697N1gMvkvr/JTF13DrFYyEbY9U7cVPA== + dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-reserved-words@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.27.1.tgz#40fba4878ccbd1c56605a4479a3a891ac0274bb4" + integrity sha512-V2ABPHIJX4kC7HegLkYoDpfg9PVmuWy/i6vUM5eGK22bx4YVFD3M5F0QQnWQoDs6AGsUWTVOopBiMFQgHaSkVw== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-runtime@^7.25.9": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.28.3.tgz#f5990a1b2d2bde950ed493915e0719841c8d0eaa" + integrity sha512-Y6ab1kGqZ0u42Zv/4a7l0l72n9DKP/MKoKWaUSBylrhNZO2prYuqFOLbn5aW5SIFXwSH93yfjbgllL8lxuGKLg== + dependencies: + "@babel/helper-module-imports" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + babel-plugin-polyfill-corejs2 "^0.4.14" + babel-plugin-polyfill-corejs3 "^0.13.0" + babel-plugin-polyfill-regenerator "^0.6.5" + semver "^6.3.1" + +"@babel/plugin-transform-shorthand-properties@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.27.1.tgz#532abdacdec87bfee1e0ef8e2fcdee543fe32b90" + integrity sha512-N/wH1vcn4oYawbJ13Y/FxcQrWk63jhfNa7jef0ih7PHSIHX2LB7GWE1rkPrOnka9kwMxb6hMl19p7lidA+EHmQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-spread@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-spread/-/plugin-transform-spread-7.27.1.tgz#1a264d5fc12750918f50e3fe3e24e437178abb08" + integrity sha512-kpb3HUqaILBJcRFVhFUs6Trdd4mkrzcGXss+6/mxUd273PfbWqSDHRzMT2234gIg2QYfAjvXLSquP1xECSg09Q== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" + +"@babel/plugin-transform-sticky-regex@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.27.1.tgz#18984935d9d2296843a491d78a014939f7dcd280" + integrity sha512-lhInBO5bi/Kowe2/aLdBAawijx+q1pQzicSgnkB6dUPc1+RC8QmJHKf2OjvU+NZWitguJHEaEmbV6VWEouT58g== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-template-literals@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.27.1.tgz#1a0eb35d8bb3e6efc06c9fd40eb0bcef548328b8" + integrity sha512-fBJKiV7F2DxZUkg5EtHKXQdbsbURW3DZKQUWphDum0uRP6eHGGa/He9mc0mypL680pb+e/lDIthRohlv8NCHkg== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-typeof-symbol@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.27.1.tgz#70e966bb492e03509cf37eafa6dcc3051f844369" + integrity sha512-RiSILC+nRJM7FY5srIyc4/fGIwUhyDuuBSdWn4y6yT6gm652DpCHZjIipgn6B7MQ1ITOUnAKWixEUjQRIBIcLw== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-typescript@^7.27.1": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.28.0.tgz#796cbd249ab56c18168b49e3e1d341b72af04a6b" + integrity sha512-4AEiDEBPIZvLQaWlc9liCavE0xRM0dNca41WtBeM3jgFptfUOSG9z0uteLhq6+3rq+WB6jIvUwKDTpXEHPJ2Vg== + dependencies: + "@babel/helper-annotate-as-pure" "^7.27.3" + "@babel/helper-create-class-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" + "@babel/plugin-syntax-typescript" "^7.27.1" + +"@babel/plugin-transform-unicode-escapes@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.27.1.tgz#3e3143f8438aef842de28816ece58780190cf806" + integrity sha512-Ysg4v6AmF26k9vpfFuTZg8HRfVWzsh1kVfowA23y9j/Gu6dOuahdUVhkLqpObp3JIv27MLSii6noRnuKN8H0Mg== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-unicode-property-regex@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-unicode-property-regex/-/plugin-transform-unicode-property-regex-7.27.1.tgz#bdfe2d3170c78c5691a3c3be934c8c0087525956" + integrity sha512-uW20S39PnaTImxp39O5qFlHLS9LJEmANjMG7SxIhap8rCHqu0Ik+tLEPX5DKmHn6CsWQ7j3lix2tFOa5YtL12Q== + dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-unicode-regex@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.27.1.tgz#25948f5c395db15f609028e370667ed8bae9af97" + integrity sha512-xvINq24TRojDuyt6JGtHmkVkrfVV3FPT16uytxImLeBZqW3/H52yN+kM1MGuyPkIQxrzKwPHs5U/MP3qKyzkGw== + dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-unicode-sets-regex@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-unicode-sets-regex/-/plugin-transform-unicode-sets-regex-7.27.1.tgz#6ab706d10f801b5c72da8bb2548561fa04193cd1" + integrity sha512-EtkOujbc4cgvb0mlpQefi4NTPBzhSIevblFevACNLUspmrALgmEBdL/XfnyyITfd8fKBZrZys92zOWcik7j9Tw== + dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/preset-env@^7.20.2", "@babel/preset-env@^7.25.9": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/preset-env/-/preset-env-7.28.3.tgz#2b18d9aff9e69643789057ae4b942b1654f88187" + integrity sha512-ROiDcM+GbYVPYBOeCR6uBXKkQpBExLl8k9HO1ygXEyds39j+vCCsjmj7S8GOniZQlEs81QlkdJZe76IpLSiqpg== + dependencies: + "@babel/compat-data" "^7.28.0" + "@babel/helper-compilation-targets" "^7.27.2" + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-validator-option" "^7.27.1" + "@babel/plugin-bugfix-firefox-class-in-computed-class-key" "^7.27.1" + "@babel/plugin-bugfix-safari-class-field-initializer-scope" "^7.27.1" + "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression" "^7.27.1" + "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining" "^7.27.1" + "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly" "^7.28.3" + "@babel/plugin-proposal-private-property-in-object" "7.21.0-placeholder-for-preset-env.2" + "@babel/plugin-syntax-import-assertions" "^7.27.1" + "@babel/plugin-syntax-import-attributes" "^7.27.1" + "@babel/plugin-syntax-unicode-sets-regex" "^7.18.6" + "@babel/plugin-transform-arrow-functions" "^7.27.1" + "@babel/plugin-transform-async-generator-functions" "^7.28.0" + "@babel/plugin-transform-async-to-generator" "^7.27.1" + "@babel/plugin-transform-block-scoped-functions" "^7.27.1" + "@babel/plugin-transform-block-scoping" "^7.28.0" + "@babel/plugin-transform-class-properties" "^7.27.1" + "@babel/plugin-transform-class-static-block" "^7.28.3" + "@babel/plugin-transform-classes" "^7.28.3" + "@babel/plugin-transform-computed-properties" "^7.27.1" + "@babel/plugin-transform-destructuring" "^7.28.0" + "@babel/plugin-transform-dotall-regex" "^7.27.1" + "@babel/plugin-transform-duplicate-keys" "^7.27.1" + "@babel/plugin-transform-duplicate-named-capturing-groups-regex" "^7.27.1" + "@babel/plugin-transform-dynamic-import" "^7.27.1" + "@babel/plugin-transform-explicit-resource-management" "^7.28.0" + "@babel/plugin-transform-exponentiation-operator" "^7.27.1" + "@babel/plugin-transform-export-namespace-from" "^7.27.1" + "@babel/plugin-transform-for-of" "^7.27.1" + "@babel/plugin-transform-function-name" "^7.27.1" + "@babel/plugin-transform-json-strings" "^7.27.1" + "@babel/plugin-transform-literals" "^7.27.1" + "@babel/plugin-transform-logical-assignment-operators" "^7.27.1" + "@babel/plugin-transform-member-expression-literals" "^7.27.1" + "@babel/plugin-transform-modules-amd" "^7.27.1" + "@babel/plugin-transform-modules-commonjs" "^7.27.1" + "@babel/plugin-transform-modules-systemjs" "^7.27.1" + "@babel/plugin-transform-modules-umd" "^7.27.1" + "@babel/plugin-transform-named-capturing-groups-regex" "^7.27.1" + "@babel/plugin-transform-new-target" "^7.27.1" + "@babel/plugin-transform-nullish-coalescing-operator" "^7.27.1" + "@babel/plugin-transform-numeric-separator" "^7.27.1" + "@babel/plugin-transform-object-rest-spread" "^7.28.0" + "@babel/plugin-transform-object-super" "^7.27.1" + "@babel/plugin-transform-optional-catch-binding" "^7.27.1" + "@babel/plugin-transform-optional-chaining" "^7.27.1" + "@babel/plugin-transform-parameters" "^7.27.7" + "@babel/plugin-transform-private-methods" "^7.27.1" + "@babel/plugin-transform-private-property-in-object" "^7.27.1" + "@babel/plugin-transform-property-literals" "^7.27.1" + "@babel/plugin-transform-regenerator" "^7.28.3" + "@babel/plugin-transform-regexp-modifiers" "^7.27.1" + "@babel/plugin-transform-reserved-words" "^7.27.1" + "@babel/plugin-transform-shorthand-properties" "^7.27.1" + "@babel/plugin-transform-spread" "^7.27.1" + "@babel/plugin-transform-sticky-regex" "^7.27.1" + "@babel/plugin-transform-template-literals" "^7.27.1" + "@babel/plugin-transform-typeof-symbol" "^7.27.1" + "@babel/plugin-transform-unicode-escapes" "^7.27.1" + "@babel/plugin-transform-unicode-property-regex" "^7.27.1" + "@babel/plugin-transform-unicode-regex" "^7.27.1" + "@babel/plugin-transform-unicode-sets-regex" "^7.27.1" + "@babel/preset-modules" "0.1.6-no-external-plugins" + babel-plugin-polyfill-corejs2 "^0.4.14" + babel-plugin-polyfill-corejs3 "^0.13.0" + babel-plugin-polyfill-regenerator "^0.6.5" + core-js-compat "^3.43.0" + semver "^6.3.1" + +"@babel/preset-modules@0.1.6-no-external-plugins": + version "0.1.6-no-external-plugins" + resolved "https://registry.yarnpkg.com/@babel/preset-modules/-/preset-modules-0.1.6-no-external-plugins.tgz#ccb88a2c49c817236861fee7826080573b8a923a" + integrity sha512-HrcgcIESLm9aIR842yhJ5RWan/gebQUJ6E/E5+rf0y9o6oj7w0Br+sWuL6kEQ/o/AdfvR1Je9jG18/gnpwjEyA== + dependencies: + "@babel/helper-plugin-utils" "^7.0.0" + "@babel/types" "^7.4.4" + esutils "^2.0.2" + +"@babel/preset-react@^7.18.6", "@babel/preset-react@^7.25.9": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/preset-react/-/preset-react-7.27.1.tgz#86ea0a5ca3984663f744be2fd26cb6747c3fd0ec" + integrity sha512-oJHWh2gLhU9dW9HHr42q0cI0/iHHXTLGe39qvpAZZzagHy0MzYLCnCVV0symeRvzmjHyVU7mw2K06E6u/JwbhA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-validator-option" "^7.27.1" + "@babel/plugin-transform-react-display-name" "^7.27.1" + "@babel/plugin-transform-react-jsx" "^7.27.1" + "@babel/plugin-transform-react-jsx-development" "^7.27.1" + "@babel/plugin-transform-react-pure-annotations" "^7.27.1" + +"@babel/preset-typescript@^7.21.0", "@babel/preset-typescript@^7.25.9": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/preset-typescript/-/preset-typescript-7.27.1.tgz#190742a6428d282306648a55b0529b561484f912" + integrity sha512-l7WfQfX0WK4M0v2RudjuQK4u99BS6yLHYEmdtVPP7lKV013zr9DygFuWNlnbvQ9LR+LS0Egz/XAvGx5U9MX0fQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-validator-option" "^7.27.1" + "@babel/plugin-syntax-jsx" "^7.27.1" + "@babel/plugin-transform-modules-commonjs" "^7.27.1" + "@babel/plugin-transform-typescript" "^7.27.1" + +"@babel/runtime-corejs3@^7.25.9": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/runtime-corejs3/-/runtime-corejs3-7.28.4.tgz#c25be39c7997ce2f130d70b9baecb8ed94df93fa" + integrity sha512-h7iEYiW4HebClDEhtvFObtPmIvrd1SSfpI9EhOeKk4CtIK/ngBWFpuhCzhdmRKtg71ylcue+9I6dv54XYO1epQ== + dependencies: + core-js-pure "^3.43.0" + +"@babel/runtime@^7.1.2", "@babel/runtime@^7.10.3", "@babel/runtime@^7.12.13", "@babel/runtime@^7.12.5", "@babel/runtime@^7.18.3", "@babel/runtime@^7.25.9", "@babel/runtime@^7.28.3", "@babel/runtime@^7.5.5", "@babel/runtime@^7.8.7": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.28.4.tgz#a70226016fabe25c5783b2f22d3e1c9bc5ca3326" + integrity sha512-Q/N6JNWvIvPnLDvjlE1OUBLPQHH6l3CltCEsHIujp45zQUSSh8K+gHnaEX45yAT1nyngnINhvWtzN+Nb9D8RAQ== + +"@babel/template@^7.27.1", "@babel/template@^7.27.2": + version "7.27.2" + resolved "https://registry.yarnpkg.com/@babel/template/-/template-7.27.2.tgz#fa78ceed3c4e7b63ebf6cb39e5852fca45f6809d" + integrity sha512-LPDZ85aEJyYSd18/DkjNh4/y1ntkE5KwUHWTiqgRxruuZL2F1yuHligVHLvcHY2vMHXttKFpJn6LwfI7cw7ODw== + dependencies: + "@babel/code-frame" "^7.27.1" + "@babel/parser" "^7.27.2" + "@babel/types" "^7.27.1" + +"@babel/traverse@^7.25.9", "@babel/traverse@^7.27.1", "@babel/traverse@^7.28.0", "@babel/traverse@^7.28.3", "@babel/traverse@^7.28.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.28.4.tgz#8d456101b96ab175d487249f60680221692b958b" + integrity sha512-YEzuboP2qvQavAcjgQNVgsvHIDv6ZpwXvcvjmyySP2DIMuByS/6ioU5G9pYrWHM6T2YDfc7xga9iNzYOs12CFQ== + dependencies: + "@babel/code-frame" "^7.27.1" + "@babel/generator" "^7.28.3" + "@babel/helper-globals" "^7.28.0" + "@babel/parser" "^7.28.4" + "@babel/template" "^7.27.2" + "@babel/types" "^7.28.4" + debug "^4.3.1" + +"@babel/types@^7.21.3", "@babel/types@^7.27.1", "@babel/types@^7.27.3", "@babel/types@^7.28.2", "@babel/types@^7.28.4", "@babel/types@^7.4.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.28.4.tgz#0a4e618f4c60a7cd6c11cb2d48060e4dbe38ac3a" + integrity sha512-bkFqkLhh3pMBUQQkpVgWDWq/lqzc2678eUyDlTBhRqhCHFguYYGM0Efga7tYk4TogG/3x0EEl66/OQ+WGbWB/Q== + dependencies: + "@babel/helper-string-parser" "^7.27.1" + "@babel/helper-validator-identifier" "^7.27.1" + +"@colors/colors@1.5.0": + version "1.5.0" + resolved "https://registry.yarnpkg.com/@colors/colors/-/colors-1.5.0.tgz#bb504579c1cae923e6576a4f5da43d25f97bdbd9" + integrity sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ== + +"@csstools/cascade-layer-name-parser@^2.0.5": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-2.0.5.tgz#43f962bebead0052a9fed1a2deeb11f85efcbc72" + integrity sha512-p1ko5eHgV+MgXFVa4STPKpvPxr6ReS8oS2jzTukjR74i5zJNyWO1ZM1m8YKBXnzDKWfBN1ztLYlHxbVemDD88A== + +"@csstools/color-helpers@^5.1.0": + version "5.1.0" + resolved "https://registry.yarnpkg.com/@csstools/color-helpers/-/color-helpers-5.1.0.tgz#106c54c808cabfd1ab4c602d8505ee584c2996ef" + integrity sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA== + +"@csstools/css-calc@^2.1.4": + version "2.1.4" + resolved "https://registry.yarnpkg.com/@csstools/css-calc/-/css-calc-2.1.4.tgz#8473f63e2fcd6e459838dd412401d5948f224c65" + integrity sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ== + +"@csstools/css-color-parser@^3.1.0": + version "3.1.0" + resolved "https://registry.yarnpkg.com/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz#4e386af3a99dd36c46fef013cfe4c1c341eed6f0" + integrity sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA== + dependencies: + "@csstools/color-helpers" "^5.1.0" + "@csstools/css-calc" "^2.1.4" + +"@csstools/css-parser-algorithms@^3.0.5": + version "3.0.5" + resolved "https://registry.yarnpkg.com/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz#5755370a9a29abaec5515b43c8b3f2cf9c2e3076" + integrity sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ== + +"@csstools/css-tokenizer@^3.0.4": + version "3.0.4" + resolved "https://registry.yarnpkg.com/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz#333fedabc3fd1a8e5d0100013731cf19e6a8c5d3" + integrity sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw== + +"@csstools/media-query-list-parser@^4.0.3": + version "4.0.3" + resolved "https://registry.yarnpkg.com/@csstools/media-query-list-parser/-/media-query-list-parser-4.0.3.tgz#7aec77bcb89c2da80ef207e73f474ef9e1b3cdf1" + integrity sha512-HAYH7d3TLRHDOUQK4mZKf9k9Ph/m8Akstg66ywKR4SFAigjs3yBiUeZtFxywiTm5moZMAp/5W/ZuFnNXXYLuuQ== + +"@csstools/postcss-alpha-function@^1.0.0": + version "1.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-alpha-function/-/postcss-alpha-function-1.0.0.tgz#8764fbbf25a5f1e106fb623ae632e01a220a6fc2" + integrity sha512-r2L8KNg5Wriq5n8IUQcjzy2Rh37J5YjzP9iOyHZL5fxdWYHB08vqykHQa4wAzN/tXwDuCHnhQDGCtxfS76xn7g== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-cascade-layers@^5.0.2": + version "5.0.2" + resolved "https://registry.yarnpkg.com/@csstools/postcss-cascade-layers/-/postcss-cascade-layers-5.0.2.tgz#dd2c70db3867b88975f2922da3bfbae7d7a2cae7" + integrity sha512-nWBE08nhO8uWl6kSAeCx4im7QfVko3zLrtgWZY4/bP87zrSPpSyN/3W3TDqz1jJuH+kbKOHXg5rJnK+ZVYcFFg== + dependencies: + "@csstools/selector-specificity" "^5.0.0" + postcss-selector-parser "^7.0.0" + +"@csstools/postcss-color-function-display-p3-linear@^1.0.0": + version "1.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-color-function-display-p3-linear/-/postcss-color-function-display-p3-linear-1.0.0.tgz#27395b62a5d9a108eefcc0eb463247a15f4269a1" + integrity sha512-7q+OuUqfowRrP84m/Jl0wv3pfCQyUTCW5MxDIux+/yty5IkUUHOTigCjrC0Fjy3OT0ncGLudHbfLWmP7E1arNA== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-color-function@^4.0.11": + version "4.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-color-function/-/postcss-color-function-4.0.11.tgz#03c34a51dc00943a6674294fb1163e7af9e87ffd" + integrity sha512-AtH22zLHTLm64HLdpv5EedT/zmYTm1MtdQbQhRZXxEB6iYtS6SrS1jLX3TcmUWMFzpumK/OVylCm3HcLms4slw== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-color-mix-function@^3.0.11": + version "3.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-color-mix-function/-/postcss-color-mix-function-3.0.11.tgz#6db0a1c749fabaf2bf978b37044700d1c1b09fc2" + integrity sha512-cQpXBelpTx0YhScZM5Ve0jDCA4RzwFc7oNafzZOGgCHt/GQVYiU8Vevz9QJcwy/W0Pyi/BneY+KMjz23lI9r+Q== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-color-mix-variadic-function-arguments@^1.0.1": + version "1.0.1" + resolved "https://registry.yarnpkg.com/@csstools/postcss-color-mix-variadic-function-arguments/-/postcss-color-mix-variadic-function-arguments-1.0.1.tgz#2dd9d66ded0d41cd7b2c13a1188f03e894c17d7e" + integrity sha512-c7hyBtbF+jlHIcUGVdWY06bHICgguV9ypfcELU3eU3W/9fiz2dxM8PqxQk2ndXYTzLnwPvNNqu1yCmQ++N6Dcg== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-content-alt-text@^2.0.7": + version "2.0.7" + resolved "https://registry.yarnpkg.com/@csstools/postcss-content-alt-text/-/postcss-content-alt-text-2.0.7.tgz#ac0a263e8acb0be99cdcfc0b1792c62141825747" + integrity sha512-cq/zWaEkpcg3RttJ5+GdNwk26NwxY5KgqgtNL777Fdd28AVGHxuBvqmK4Jq4oKhW1NX4M2LbgYAVVN0NZ+/XYQ== + dependencies: + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-exponential-functions@^2.0.9": + version "2.0.9" + resolved "https://registry.yarnpkg.com/@csstools/postcss-exponential-functions/-/postcss-exponential-functions-2.0.9.tgz#fc03d1272888cb77e64cc1a7d8a33016e4f05c69" + integrity sha512-abg2W/PI3HXwS/CZshSa79kNWNZHdJPMBXeZNyPQFbbj8sKO3jXxOt/wF7juJVjyDTc6JrvaUZYFcSBZBhaxjw== + dependencies: + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + +"@csstools/postcss-font-format-keywords@^4.0.0": + version "4.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-font-format-keywords/-/postcss-font-format-keywords-4.0.0.tgz#6730836eb0153ff4f3840416cc2322f129c086e6" + integrity sha512-usBzw9aCRDvchpok6C+4TXC57btc4bJtmKQWOHQxOVKen1ZfVqBUuCZ/wuqdX5GHsD0NRSr9XTP+5ID1ZZQBXw== + dependencies: + "@csstools/utilities" "^2.0.0" + postcss-value-parser "^4.2.0" + +"@csstools/postcss-gamut-mapping@^2.0.11": + version "2.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-gamut-mapping/-/postcss-gamut-mapping-2.0.11.tgz#be0e34c9f0142852cccfc02b917511f0d677db8b" + integrity sha512-fCpCUgZNE2piVJKC76zFsgVW1apF6dpYsqGyH8SIeCcM4pTEsRTWTLCaJIMKFEundsCKwY1rwfhtrio04RJ4Dw== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + +"@csstools/postcss-gradients-interpolation-method@^5.0.11": + version "5.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-gradients-interpolation-method/-/postcss-gradients-interpolation-method-5.0.11.tgz#f1c5c431a44ed9655cb408aea8666ed2c5250490" + integrity sha512-8M3mcNTL3cGIJXDnvrJ2oWEcKi3zyw7NeYheFKePUlBmLYm1gkw9Rr/BA7lFONrOPeQA3yeMPldrrws6lqHrug== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-hwb-function@^4.0.11": + version "4.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-hwb-function/-/postcss-hwb-function-4.0.11.tgz#4bb173f1c8c2361bf46a842a948ee687471ae4ea" + integrity sha512-9meZbsVWTZkWsSBazQips3cHUOT29a/UAwFz0AMEXukvpIGGDR9+GMl3nIckWO5sPImsadu4F5Zy+zjt8QgCdA== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-ic-unit@^4.0.3": + version "4.0.3" + resolved "https://registry.yarnpkg.com/@csstools/postcss-ic-unit/-/postcss-ic-unit-4.0.3.tgz#ba0375e9d346e6e5a42dc8c2cb1133b2262f9ffa" + integrity sha512-RtYYm2qUIu9vAaHB0cC8rQGlOCQAUgEc2tMr7ewlGXYipBQKjoWmyVArqsk7SEr8N3tErq6P6UOJT3amaVof5Q== + dependencies: + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + postcss-value-parser "^4.2.0" + +"@csstools/postcss-initial@^2.0.1": + version "2.0.1" + resolved "https://registry.yarnpkg.com/@csstools/postcss-initial/-/postcss-initial-2.0.1.tgz#c385bd9d8ad31ad159edd7992069e97ceea4d09a" + integrity sha512-L1wLVMSAZ4wovznquK0xmC7QSctzO4D0Is590bxpGqhqjboLXYA16dWZpfwImkdOgACdQ9PqXsuRroW6qPlEsg== + +"@csstools/postcss-is-pseudo-class@^5.0.3": + version "5.0.3" + resolved "https://registry.yarnpkg.com/@csstools/postcss-is-pseudo-class/-/postcss-is-pseudo-class-5.0.3.tgz#d34e850bcad4013c2ed7abe948bfa0448aa8eb74" + integrity sha512-jS/TY4SpG4gszAtIg7Qnf3AS2pjcUM5SzxpApOrlndMeGhIbaTzWBzzP/IApXoNWEW7OhcjkRT48jnAUIFXhAQ== + dependencies: + "@csstools/selector-specificity" "^5.0.0" + postcss-selector-parser "^7.0.0" + +"@csstools/postcss-light-dark-function@^2.0.10": + version "2.0.10" + resolved "https://registry.yarnpkg.com/@csstools/postcss-light-dark-function/-/postcss-light-dark-function-2.0.10.tgz#b606f13d1f81efd297763c6ad1ac515c3ca4165b" + integrity sha512-g7Lwb294lSoNnyrwcqoooh9fTAp47rRNo+ILg7SLRSMU3K9ePIwRt566sNx+pehiCelv4E1ICaU1EwLQuyF2qw== + dependencies: + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-logical-float-and-clear@^3.0.0": + version "3.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-logical-float-and-clear/-/postcss-logical-float-and-clear-3.0.0.tgz#62617564182cf86ab5d4e7485433ad91e4c58571" + integrity sha512-SEmaHMszwakI2rqKRJgE+8rpotFfne1ZS6bZqBoQIicFyV+xT1UF42eORPxJkVJVrH9C0ctUgwMSn3BLOIZldQ== + +"@csstools/postcss-logical-overflow@^2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-logical-overflow/-/postcss-logical-overflow-2.0.0.tgz#c6de7c5f04e3d4233731a847f6c62819bcbcfa1d" + integrity sha512-spzR1MInxPuXKEX2csMamshR4LRaSZ3UXVaRGjeQxl70ySxOhMpP2252RAFsg8QyyBXBzuVOOdx1+bVO5bPIzA== + +"@csstools/postcss-logical-overscroll-behavior@^2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-logical-overscroll-behavior/-/postcss-logical-overscroll-behavior-2.0.0.tgz#43c03eaecdf34055ef53bfab691db6dc97a53d37" + integrity sha512-e/webMjoGOSYfqLunyzByZj5KKe5oyVg/YSbie99VEaSDE2kimFm0q1f6t/6Jo+VVCQ/jbe2Xy+uX+C4xzWs4w== + +"@csstools/postcss-logical-resize@^3.0.0": + version "3.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-logical-resize/-/postcss-logical-resize-3.0.0.tgz#4df0eeb1a61d7bd85395e56a5cce350b5dbfdca6" + integrity sha512-DFbHQOFW/+I+MY4Ycd/QN6Dg4Hcbb50elIJCfnwkRTCX05G11SwViI5BbBlg9iHRl4ytB7pmY5ieAFk3ws7yyg== + dependencies: + postcss-value-parser "^4.2.0" + +"@csstools/postcss-logical-viewport-units@^3.0.4": + version "3.0.4" + resolved "https://registry.yarnpkg.com/@csstools/postcss-logical-viewport-units/-/postcss-logical-viewport-units-3.0.4.tgz#016d98a8b7b5f969e58eb8413447eb801add16fc" + integrity sha512-q+eHV1haXA4w9xBwZLKjVKAWn3W2CMqmpNpZUk5kRprvSiBEGMgrNH3/sJZ8UA3JgyHaOt3jwT9uFa4wLX4EqQ== + dependencies: + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-media-minmax@^2.0.9": + version "2.0.9" + resolved "https://registry.yarnpkg.com/@csstools/postcss-media-minmax/-/postcss-media-minmax-2.0.9.tgz#184252d5b93155ae526689328af6bdf3fc113987" + integrity sha512-af9Qw3uS3JhYLnCbqtZ9crTvvkR+0Se+bBqSr7ykAnl9yKhk6895z9rf+2F4dClIDJWxgn0iZZ1PSdkhrbs2ig== + dependencies: + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/media-query-list-parser" "^4.0.3" + +"@csstools/postcss-media-queries-aspect-ratio-number-values@^3.0.5": + version "3.0.5" + resolved "https://registry.yarnpkg.com/@csstools/postcss-media-queries-aspect-ratio-number-values/-/postcss-media-queries-aspect-ratio-number-values-3.0.5.tgz#f485c31ec13d6b0fb5c528a3474334a40eff5f11" + integrity sha512-zhAe31xaaXOY2Px8IYfoVTB3wglbJUVigGphFLj6exb7cjZRH9A6adyE22XfFK3P2PzwRk0VDeTJmaxpluyrDg== + dependencies: + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/media-query-list-parser" "^4.0.3" + +"@csstools/postcss-nested-calc@^4.0.0": + version "4.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-nested-calc/-/postcss-nested-calc-4.0.0.tgz#754e10edc6958d664c11cde917f44ba144141c62" + integrity sha512-jMYDdqrQQxE7k9+KjstC3NbsmC063n1FTPLCgCRS2/qHUbHM0mNy9pIn4QIiQGs9I/Bg98vMqw7mJXBxa0N88A== + dependencies: + "@csstools/utilities" "^2.0.0" + postcss-value-parser "^4.2.0" + +"@csstools/postcss-normalize-display-values@^4.0.0": + version "4.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-normalize-display-values/-/postcss-normalize-display-values-4.0.0.tgz#ecdde2daf4e192e5da0c6fd933b6d8aff32f2a36" + integrity sha512-HlEoG0IDRoHXzXnkV4in47dzsxdsjdz6+j7MLjaACABX2NfvjFS6XVAnpaDyGesz9gK2SC7MbNwdCHusObKJ9Q== + dependencies: + postcss-value-parser "^4.2.0" + +"@csstools/postcss-oklab-function@^4.0.11": + version "4.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-oklab-function/-/postcss-oklab-function-4.0.11.tgz#d69242a9b027dda731bd79db7293bc938bb6df97" + integrity sha512-9f03ZGxZ2VmSCrM4SDXlAYP+Xpu4VFzemfQUQFL9OYxAbpvDy0FjDipZ0i8So1pgs8VIbQI0bNjFWgfdpGw8ig== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-progressive-custom-properties@^4.2.0": + version "4.2.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-progressive-custom-properties/-/postcss-progressive-custom-properties-4.2.0.tgz#7f15349c2cd108478d28e1503c660d4037925030" + integrity sha512-fWCXRasX17N1NCPTCuwC3FJDV+Wc031f16cFuuMEfIsYJ1q5ABCa59W0C6VeMGqjNv6ldf37vvwXXAeaZjD9PA== + dependencies: + postcss-value-parser "^4.2.0" + +"@csstools/postcss-random-function@^2.0.1": + version "2.0.1" + resolved "https://registry.yarnpkg.com/@csstools/postcss-random-function/-/postcss-random-function-2.0.1.tgz#3191f32fe72936e361dadf7dbfb55a0209e2691e" + integrity sha512-q+FQaNiRBhnoSNo+GzqGOIBKoHQ43lYz0ICrV+UudfWnEF6ksS6DsBIJSISKQT2Bvu3g4k6r7t0zYrk5pDlo8w== + dependencies: + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + +"@csstools/postcss-relative-color-syntax@^3.0.11": + version "3.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-relative-color-syntax/-/postcss-relative-color-syntax-3.0.11.tgz#d81d59ff123fa5f3e4a0493b1e2b0585353bb541" + integrity sha512-oQ5fZvkcBrWR+k6arHXk0F8FlkmD4IxM+rcGDLWrF2f31tWyEM3lSraeWAV0f7BGH6LIrqmyU3+Qo/1acfoJng== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-scope-pseudo-class@^4.0.1": + version "4.0.1" + resolved "https://registry.yarnpkg.com/@csstools/postcss-scope-pseudo-class/-/postcss-scope-pseudo-class-4.0.1.tgz#9fe60e9d6d91d58fb5fc6c768a40f6e47e89a235" + integrity sha512-IMi9FwtH6LMNuLea1bjVMQAsUhFxJnyLSgOp/cpv5hrzWmrUYU5fm0EguNDIIOHUqzXode8F/1qkC/tEo/qN8Q== + dependencies: + postcss-selector-parser "^7.0.0" + +"@csstools/postcss-sign-functions@^1.1.4": + version "1.1.4" + resolved "https://registry.yarnpkg.com/@csstools/postcss-sign-functions/-/postcss-sign-functions-1.1.4.tgz#a9ac56954014ae4c513475b3f1b3e3424a1e0c12" + integrity sha512-P97h1XqRPcfcJndFdG95Gv/6ZzxUBBISem0IDqPZ7WMvc/wlO+yU0c5D/OCpZ5TJoTt63Ok3knGk64N+o6L2Pg== + dependencies: + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + +"@csstools/postcss-stepped-value-functions@^4.0.9": + version "4.0.9" + resolved "https://registry.yarnpkg.com/@csstools/postcss-stepped-value-functions/-/postcss-stepped-value-functions-4.0.9.tgz#36036f1a0e5e5ee2308e72f3c9cb433567c387b9" + integrity sha512-h9btycWrsex4dNLeQfyU3y3w40LMQooJWFMm/SK9lrKguHDcFl4VMkncKKoXi2z5rM9YGWbUQABI8BT2UydIcA== + dependencies: + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + +"@csstools/postcss-text-decoration-shorthand@^4.0.3": + version "4.0.3" + resolved "https://registry.yarnpkg.com/@csstools/postcss-text-decoration-shorthand/-/postcss-text-decoration-shorthand-4.0.3.tgz#fae1b70f07d1b7beb4c841c86d69e41ecc6f743c" + integrity sha512-KSkGgZfx0kQjRIYnpsD7X2Om9BUXX/Kii77VBifQW9Ih929hK0KNjVngHDH0bFB9GmfWcR9vJYJJRvw/NQjkrA== + dependencies: + "@csstools/color-helpers" "^5.1.0" + postcss-value-parser "^4.2.0" + +"@csstools/postcss-trigonometric-functions@^4.0.9": + version "4.0.9" + resolved "https://registry.yarnpkg.com/@csstools/postcss-trigonometric-functions/-/postcss-trigonometric-functions-4.0.9.tgz#3f94ed2e319b57f2c59720b64e4d0a8a6fb8c3b2" + integrity sha512-Hnh5zJUdpNrJqK9v1/E3BbrQhaDTj5YiX7P61TOvUhoDHnUmsNNxcDAgkQ32RrcWx9GVUvfUNPcUkn8R3vIX6A== + dependencies: + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + +"@csstools/postcss-unset-value@^4.0.0": + version "4.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-unset-value/-/postcss-unset-value-4.0.0.tgz#7caa981a34196d06a737754864baf77d64de4bba" + integrity sha512-cBz3tOCI5Fw6NIFEwU3RiwK6mn3nKegjpJuzCndoGq3BZPkUjnsq7uQmIeMNeMbMk7YD2MfKcgCpZwX5jyXqCA== + +"@csstools/selector-resolve-nested@^3.1.0": + version "3.1.0" + resolved "https://registry.yarnpkg.com/@csstools/selector-resolve-nested/-/selector-resolve-nested-3.1.0.tgz#848c6f44cb65e3733e478319b9342b7aa436fac7" + integrity sha512-mf1LEW0tJLKfWyvn5KdDrhpxHyuxpbNwTIwOYLIvsTffeyOf85j5oIzfG0yosxDgx/sswlqBnESYUcQH0vgZ0g== + +"@csstools/selector-specificity@^5.0.0": + version "5.0.0" + resolved "https://registry.yarnpkg.com/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz#037817b574262134cabd68fc4ec1a454f168407b" + integrity sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw== + +"@csstools/utilities@^2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@csstools/utilities/-/utilities-2.0.0.tgz#f7ff0fee38c9ffb5646d47b6906e0bc8868bde60" + integrity sha512-5VdOr0Z71u+Yp3ozOx8T11N703wIFGVRgOWbOZMKgglPJsWA54MRIoMNVMa7shUToIhx5J8vX4sOZgD2XiihiQ== + +"@discoveryjs/json-ext@0.5.7": + version "0.5.7" + resolved "https://registry.yarnpkg.com/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz#1d572bfbbe14b7704e0ba0f39b74815b84870d70" + integrity sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw== + +"@docsearch/css@3.9.0": + version "3.9.0" + resolved "https://registry.yarnpkg.com/@docsearch/css/-/css-3.9.0.tgz#3bc29c96bf024350d73b0cfb7c2a7b71bf251cd5" + integrity sha512-cQbnVbq0rrBwNAKegIac/t6a8nWoUAn8frnkLFW6YARaRmAQr5/Eoe6Ln2fqkUCZ40KpdrKbpSAmgrkviOxuWA== + +"@docsearch/react@^3.9.0": + version "3.9.0" + resolved "https://registry.yarnpkg.com/@docsearch/react/-/react-3.9.0.tgz#d0842b700c3ee26696786f3c8ae9f10c1a3f0db3" + integrity sha512-mb5FOZYZIkRQ6s/NWnM98k879vu5pscWqTLubLFBO87igYYT4VzVazh4h5o/zCvTIZgEt3PvsCOMOswOUo9yHQ== + dependencies: + "@algolia/autocomplete-core" "1.17.9" + "@algolia/autocomplete-preset-algolia" "1.17.9" + "@docsearch/css" "3.9.0" + algoliasearch "^5.14.2" + +"@docusaurus/babel@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/babel/-/babel-3.8.1.tgz#db329ac047184214e08e2dbc809832c696c18506" + integrity sha512-3brkJrml8vUbn9aeoZUlJfsI/GqyFcDgQJwQkmBtclJgWDEQBKKeagZfOgx0WfUQhagL1sQLNW0iBdxnI863Uw== + dependencies: + "@babel/core" "^7.25.9" + "@babel/generator" "^7.25.9" + "@babel/plugin-syntax-dynamic-import" "^7.8.3" + "@babel/plugin-transform-runtime" "^7.25.9" + "@babel/preset-env" "^7.25.9" + "@babel/preset-react" "^7.25.9" + "@babel/preset-typescript" "^7.25.9" + "@babel/runtime" "^7.25.9" + "@babel/runtime-corejs3" "^7.25.9" + "@babel/traverse" "^7.25.9" + "@docusaurus/logger" "3.8.1" + "@docusaurus/utils" "3.8.1" + babel-plugin-dynamic-import-node "^2.3.3" + fs-extra "^11.1.1" + tslib "^2.6.0" + +"@docusaurus/bundler@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/bundler/-/bundler-3.8.1.tgz#e2b11d615f09a6e470774bb36441b8d06736b94c" + integrity sha512-/z4V0FRoQ0GuSLToNjOSGsk6m2lQUG4FRn8goOVoZSRsTrU8YR2aJacX5K3RG18EaX9b+52pN4m1sL3MQZVsQA== + dependencies: + "@babel/core" "^7.25.9" + "@docusaurus/babel" "3.8.1" + "@docusaurus/cssnano-preset" "3.8.1" + "@docusaurus/logger" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + babel-loader "^9.2.1" + clean-css "^5.3.3" + copy-webpack-plugin "^11.0.0" + css-loader "^6.11.0" + css-minimizer-webpack-plugin "^5.0.1" + cssnano "^6.1.2" + file-loader "^6.2.0" + html-minifier-terser "^7.2.0" + mini-css-extract-plugin "^2.9.2" + null-loader "^4.0.1" + postcss "^8.5.4" + postcss-loader "^7.3.4" + postcss-preset-env "^10.2.1" + terser-webpack-plugin "^5.3.9" + tslib "^2.6.0" + url-loader "^4.1.1" + webpack "^5.95.0" + webpackbar "^6.0.1" + +"@docusaurus/core@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/core/-/core-3.8.1.tgz#c22e47c16a22cb7d245306c64bc54083838ff3db" + integrity sha512-ENB01IyQSqI2FLtOzqSI3qxG2B/jP4gQPahl2C3XReiLebcVh5B5cB9KYFvdoOqOWPyr5gXK4sjgTKv7peXCrA== + dependencies: + "@docusaurus/babel" "3.8.1" + "@docusaurus/bundler" "3.8.1" + "@docusaurus/logger" "3.8.1" + "@docusaurus/mdx-loader" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + boxen "^6.2.1" + chalk "^4.1.2" + chokidar "^3.5.3" + cli-table3 "^0.6.3" + combine-promises "^1.1.0" + commander "^5.1.0" + core-js "^3.31.1" + detect-port "^1.5.1" + escape-html "^1.0.3" + eta "^2.2.0" + eval "^0.1.8" + execa "5.1.1" + fs-extra "^11.1.1" + html-tags "^3.3.1" + html-webpack-plugin "^5.6.0" + leven "^3.1.0" + lodash "^4.17.21" + open "^8.4.0" + p-map "^4.0.0" + prompts "^2.4.2" + react-helmet-async "npm:@slorber/react-helmet-async@1.3.0" + react-loadable "npm:@docusaurus/react-loadable@6.0.0" + react-loadable-ssr-addon-v5-slorber "^1.0.1" + react-router "^5.3.4" + react-router-config "^5.1.1" + react-router-dom "^5.3.4" + semver "^7.5.4" + serve-handler "^6.1.6" + tinypool "^1.0.2" + tslib "^2.6.0" + update-notifier "^6.0.2" + webpack "^5.95.0" + webpack-bundle-analyzer "^4.10.2" + webpack-dev-server "^4.15.2" + webpack-merge "^6.0.1" + +"@docusaurus/cssnano-preset@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/cssnano-preset/-/cssnano-preset-3.8.1.tgz#bd55026251a6ab8e2194839a2042458ef9880c44" + integrity sha512-G7WyR2N6SpyUotqhGznERBK+x84uyhfMQM2MmDLs88bw4Flom6TY46HzkRkSEzaP9j80MbTN8naiL1fR17WQug== + dependencies: + cssnano-preset-advanced "^6.1.2" + postcss "^8.5.4" + postcss-sort-media-queries "^5.2.0" + tslib "^2.6.0" + +"@docusaurus/logger@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/logger/-/logger-3.8.1.tgz#45321b2e2e14695d0dbd8b4104ea7b0fbaa98700" + integrity sha512-2wjeGDhKcExEmjX8k1N/MRDiPKXGF2Pg+df/bDDPnnJWHXnVEZxXj80d6jcxp1Gpnksl0hF8t/ZQw9elqj2+ww== + dependencies: + chalk "^4.1.2" + tslib "^2.6.0" + +"@docusaurus/mdx-loader@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/mdx-loader/-/mdx-loader-3.8.1.tgz#74309b3614bbcef1d55fb13e6cc339b7fb000b5f" + integrity sha512-DZRhagSFRcEq1cUtBMo4TKxSNo/W6/s44yhr8X+eoXqCLycFQUylebOMPseHi5tc4fkGJqwqpWJLz6JStU9L4w== + dependencies: + "@docusaurus/logger" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + "@mdx-js/mdx" "^3.0.0" + "@slorber/remark-comment" "^1.0.0" + escape-html "^1.0.3" + estree-util-value-to-estree "^3.0.1" + file-loader "^6.2.0" + fs-extra "^11.1.1" + image-size "^2.0.2" + mdast-util-mdx "^3.0.0" + mdast-util-to-string "^4.0.0" + rehype-raw "^7.0.0" + remark-directive "^3.0.0" + remark-emoji "^4.0.0" + remark-frontmatter "^5.0.0" + remark-gfm "^4.0.0" + stringify-object "^3.3.0" + tslib "^2.6.0" + unified "^11.0.3" + unist-util-visit "^5.0.0" + url-loader "^4.1.1" + vfile "^6.0.1" + webpack "^5.88.1" + +"@docusaurus/module-type-aliases@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/module-type-aliases/-/module-type-aliases-3.8.1.tgz#454de577bd7f50b5eae16db0f76b49ca5e4e281a" + integrity sha512-6xhvAJiXzsaq3JdosS7wbRt/PwEPWHr9eM4YNYqVlbgG1hSK3uQDXTVvQktasp3VO6BmfYWPozueLWuj4gB+vg== + dependencies: + "@docusaurus/types" "3.8.1" + "@types/history" "^4.7.11" + "@types/react" "*" + "@types/react-router-config" "*" + "@types/react-router-dom" "*" + react-helmet-async "npm:@slorber/react-helmet-async@1.3.0" + react-loadable "npm:@docusaurus/react-loadable@6.0.0" + +"@docusaurus/plugin-content-blog@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.8.1.tgz#88d842b562b04cf59df900d9f6984b086f821525" + integrity sha512-vNTpMmlvNP9n3hGEcgPaXyvTljanAKIUkuG9URQ1DeuDup0OR7Ltvoc8yrmH+iMZJbcQGhUJF+WjHLwuk8HSdw== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/logger" "3.8.1" + "@docusaurus/mdx-loader" "3.8.1" + "@docusaurus/theme-common" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + cheerio "1.0.0-rc.12" + feed "^4.2.2" + fs-extra "^11.1.1" + lodash "^4.17.21" + schema-dts "^1.1.2" + srcset "^4.0.0" + tslib "^2.6.0" + unist-util-visit "^5.0.0" + utility-types "^3.10.0" + webpack "^5.88.1" + +"@docusaurus/plugin-content-docs@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.8.1.tgz#40686a206abb6373bee5638de100a2c312f112a4" + integrity sha512-oByRkSZzeGNQByCMaX+kif5Nl2vmtj2IHQI2fWjCfCootsdKZDPFLonhIp5s3IGJO7PLUfe0POyw0Xh/RrGXJA== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/logger" "3.8.1" + "@docusaurus/mdx-loader" "3.8.1" + "@docusaurus/module-type-aliases" "3.8.1" + "@docusaurus/theme-common" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + "@types/react-router-config" "^5.0.7" + combine-promises "^1.1.0" + fs-extra "^11.1.1" + js-yaml "^4.1.0" + lodash "^4.17.21" + schema-dts "^1.1.2" + tslib "^2.6.0" + utility-types "^3.10.0" + webpack "^5.88.1" + +"@docusaurus/plugin-content-pages@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-pages/-/plugin-content-pages-3.8.1.tgz#41b684dbd15390b7bb6a627f78bf81b6324511ac" + integrity sha512-a+V6MS2cIu37E/m7nDJn3dcxpvXb6TvgdNI22vJX8iUTp8eoMoPa0VArEbWvCxMY/xdC26WzNv4wZ6y0iIni/w== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/mdx-loader" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + fs-extra "^11.1.1" + tslib "^2.6.0" + webpack "^5.88.1" + +"@docusaurus/plugin-css-cascade-layers@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-css-cascade-layers/-/plugin-css-cascade-layers-3.8.1.tgz#cb414b4a82aa60fc64ef2a435ad0105e142a6c71" + integrity sha512-VQ47xRxfNKjHS5ItzaVXpxeTm7/wJLFMOPo1BkmoMG4Cuz4nuI+Hs62+RMk1OqVog68Swz66xVPK8g9XTrBKRw== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + tslib "^2.6.0" + +"@docusaurus/plugin-debug@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-debug/-/plugin-debug-3.8.1.tgz#45b107e46b627caaae66995f53197ace78af3491" + integrity sha512-nT3lN7TV5bi5hKMB7FK8gCffFTBSsBsAfV84/v293qAmnHOyg1nr9okEw8AiwcO3bl9vije5nsUvP0aRl2lpaw== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + fs-extra "^11.1.1" + react-json-view-lite "^2.3.0" + tslib "^2.6.0" + +"@docusaurus/plugin-google-analytics@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-analytics/-/plugin-google-analytics-3.8.1.tgz#64a302e62fe5cb6e007367c964feeef7b056764a" + integrity sha512-Hrb/PurOJsmwHAsfMDH6oVpahkEGsx7F8CWMjyP/dw1qjqmdS9rcV1nYCGlM8nOtD3Wk/eaThzUB5TSZsGz+7Q== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + tslib "^2.6.0" + +"@docusaurus/plugin-google-gtag@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-gtag/-/plugin-google-gtag-3.8.1.tgz#8c76f8a1d96448f2f0f7b10e6bde451c40672b95" + integrity sha512-tKE8j1cEZCh8KZa4aa80zpSTxsC2/ZYqjx6AAfd8uA8VHZVw79+7OTEP2PoWi0uL5/1Is0LF5Vwxd+1fz5HlKg== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + "@types/gtag.js" "^0.0.12" + tslib "^2.6.0" + +"@docusaurus/plugin-google-tag-manager@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-tag-manager/-/plugin-google-tag-manager-3.8.1.tgz#88241ffd06369f4a4d5fb982ff3ac2777561ae37" + integrity sha512-iqe3XKITBquZq+6UAXdb1vI0fPY5iIOitVjPQ581R1ZKpHr0qe+V6gVOrrcOHixPDD/BUKdYwkxFjpNiEN+vBw== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + tslib "^2.6.0" + +"@docusaurus/plugin-sitemap@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-sitemap/-/plugin-sitemap-3.8.1.tgz#3aebd39186dc30e53023f1aab44625bc0bdac892" + integrity sha512-+9YV/7VLbGTq8qNkjiugIelmfUEVkTyLe6X8bWq7K5qPvGXAjno27QAfFq63mYfFFbJc7z+pudL63acprbqGzw== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/logger" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + fs-extra "^11.1.1" + sitemap "^7.1.1" + tslib "^2.6.0" + +"@docusaurus/plugin-svgr@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-svgr/-/plugin-svgr-3.8.1.tgz#6f340be8eae418a2cce540d8ece096ffd9c9b6ab" + integrity sha512-rW0LWMDsdlsgowVwqiMb/7tANDodpy1wWPwCcamvhY7OECReN3feoFwLjd/U4tKjNY3encj0AJSTxJA+Fpe+Gw== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + "@svgr/core" "8.1.0" + "@svgr/webpack" "^8.1.0" + tslib "^2.6.0" + webpack "^5.88.1" + +"@docusaurus/preset-classic@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/preset-classic/-/preset-classic-3.8.1.tgz#bb79fd12f3211363720c569a526c7e24d3aa966b" + integrity sha512-yJSjYNHXD8POMGc2mKQuj3ApPrN+eG0rO1UPgSx7jySpYU+n4WjBikbrA2ue5ad9A7aouEtMWUoiSRXTH/g7KQ== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/plugin-content-blog" "3.8.1" + "@docusaurus/plugin-content-docs" "3.8.1" + "@docusaurus/plugin-content-pages" "3.8.1" + "@docusaurus/plugin-css-cascade-layers" "3.8.1" + "@docusaurus/plugin-debug" "3.8.1" + "@docusaurus/plugin-google-analytics" "3.8.1" + "@docusaurus/plugin-google-gtag" "3.8.1" + "@docusaurus/plugin-google-tag-manager" "3.8.1" + "@docusaurus/plugin-sitemap" "3.8.1" + "@docusaurus/plugin-svgr" "3.8.1" + "@docusaurus/theme-classic" "3.8.1" + "@docusaurus/theme-common" "3.8.1" + "@docusaurus/theme-search-algolia" "3.8.1" + "@docusaurus/types" "3.8.1" + +"@docusaurus/theme-classic@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-classic/-/theme-classic-3.8.1.tgz#1e45c66d89ded359225fcd29bf3258d9205765c1" + integrity sha512-bqDUCNqXeYypMCsE1VcTXSI1QuO4KXfx8Cvl6rYfY0bhhqN6d2WZlRkyLg/p6pm+DzvanqHOyYlqdPyP0iz+iw== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/logger" "3.8.1" + "@docusaurus/mdx-loader" "3.8.1" + "@docusaurus/module-type-aliases" "3.8.1" + "@docusaurus/plugin-content-blog" "3.8.1" + "@docusaurus/plugin-content-docs" "3.8.1" + "@docusaurus/plugin-content-pages" "3.8.1" + "@docusaurus/theme-common" "3.8.1" + "@docusaurus/theme-translations" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + "@mdx-js/react" "^3.0.0" + clsx "^2.0.0" + copy-text-to-clipboard "^3.2.0" + infima "0.2.0-alpha.45" + lodash "^4.17.21" + nprogress "^0.2.0" + postcss "^8.5.4" + prism-react-renderer "^2.3.0" + prismjs "^1.29.0" + react-router-dom "^5.3.4" + rtlcss "^4.1.0" + tslib "^2.6.0" + utility-types "^3.10.0" + +"@docusaurus/theme-common@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-common/-/theme-common-3.8.1.tgz#17c23316fbe3ee3f7e707c7298cb59a0fff38b4b" + integrity sha512-UswMOyTnPEVRvN5Qzbo+l8k4xrd5fTFu2VPPfD6FcW/6qUtVLmJTQCktbAL3KJ0BVXGm5aJXz/ZrzqFuZERGPw== + dependencies: + "@docusaurus/mdx-loader" "3.8.1" + "@docusaurus/module-type-aliases" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + "@types/history" "^4.7.11" + "@types/react" "*" + "@types/react-router-config" "*" + clsx "^2.0.0" + parse-numeric-range "^1.3.0" + prism-react-renderer "^2.3.0" + tslib "^2.6.0" + utility-types "^3.10.0" + +"@docusaurus/theme-search-algolia@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-search-algolia/-/theme-search-algolia-3.8.1.tgz#3aa3d99c35cc2d4b709fcddd4df875a9b536e29b" + integrity sha512-NBFH5rZVQRAQM087aYSRKQ9yGEK9eHd+xOxQjqNpxMiV85OhJDD4ZGz6YJIod26Fbooy54UWVdzNU0TFeUUUzQ== + dependencies: + "@docsearch/react" "^3.9.0" + "@docusaurus/core" "3.8.1" + "@docusaurus/logger" "3.8.1" + "@docusaurus/plugin-content-docs" "3.8.1" + "@docusaurus/theme-common" "3.8.1" + "@docusaurus/theme-translations" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + algoliasearch "^5.17.1" + algoliasearch-helper "^3.22.6" + clsx "^2.0.0" + eta "^2.2.0" + fs-extra "^11.1.1" + lodash "^4.17.21" + tslib "^2.6.0" + utility-types "^3.10.0" + +"@docusaurus/theme-translations@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-translations/-/theme-translations-3.8.1.tgz#4b1d76973eb53861e167c7723485e059ba4ffd0a" + integrity sha512-OTp6eebuMcf2rJt4bqnvuwmm3NVXfzfYejL+u/Y1qwKhZPrjPoKWfk1CbOP5xH5ZOPkiAsx4dHdQBRJszK3z2g== + dependencies: + fs-extra "^11.1.1" + tslib "^2.6.0" + +"@docusaurus/types@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/types/-/types-3.8.1.tgz#83ab66c345464e003b576a49f78897482061fc26" + integrity sha512-ZPdW5AB+pBjiVrcLuw3dOS6BFlrG0XkS2lDGsj8TizcnREQg3J8cjsgfDviszOk4CweNfwo1AEELJkYaMUuOPg== + dependencies: + "@mdx-js/mdx" "^3.0.0" + "@types/history" "^4.7.11" + "@types/react" "*" + commander "^5.1.0" + joi "^17.9.2" + react-helmet-async "npm:@slorber/react-helmet-async@1.3.0" + utility-types "^3.10.0" + webpack "^5.95.0" + webpack-merge "^5.9.0" + +"@docusaurus/utils-common@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/utils-common/-/utils-common-3.8.1.tgz#c369b8c3041afb7dcd595d4172beb1cc1015c85f" + integrity sha512-zTZiDlvpvoJIrQEEd71c154DkcriBecm4z94OzEE9kz7ikS3J+iSlABhFXM45mZ0eN5pVqqr7cs60+ZlYLewtg== + dependencies: + "@docusaurus/types" "3.8.1" + tslib "^2.6.0" + +"@docusaurus/utils-validation@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/utils-validation/-/utils-validation-3.8.1.tgz#0499c0d151a4098a0963237057993282cfbd538e" + integrity sha512-gs5bXIccxzEbyVecvxg6upTwaUbfa0KMmTj7HhHzc016AGyxH2o73k1/aOD0IFrdCsfJNt37MqNI47s2MgRZMA== + dependencies: + "@docusaurus/logger" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + fs-extra "^11.2.0" + joi "^17.9.2" + js-yaml "^4.1.0" + lodash "^4.17.21" + tslib "^2.6.0" + +"@docusaurus/utils@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/utils/-/utils-3.8.1.tgz#2ac1e734106e2f73dbd0f6a8824d525f9064e9f0" + integrity sha512-P1ml0nvOmEFdmu0smSXOqTS1sxU5tqvnc0dA4MTKV39kye+bhQnjkIKEE18fNOvxjyB86k8esoCIFM3x4RykOQ== + dependencies: + "@docusaurus/logger" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + escape-string-regexp "^4.0.0" + execa "5.1.1" + file-loader "^6.2.0" + fs-extra "^11.1.1" + github-slugger "^1.5.0" + globby "^11.1.0" + gray-matter "^4.0.3" + jiti "^1.20.0" + js-yaml "^4.1.0" + lodash "^4.17.21" + micromatch "^4.0.5" + p-queue "^6.6.2" + prompts "^2.4.2" + resolve-pathname "^3.0.0" + tslib "^2.6.0" + url-loader "^4.1.1" + utility-types "^3.10.0" + webpack "^5.88.1" + +"@emotion/babel-plugin@^11.13.5": + version "11.13.5" + resolved "https://registry.yarnpkg.com/@emotion/babel-plugin/-/babel-plugin-11.13.5.tgz#eab8d65dbded74e0ecfd28dc218e75607c4e7bc0" + integrity sha512-pxHCpT2ex+0q+HH91/zsdHkw/lXd468DIN2zvfvLtPKLLMo6gQj7oLObq8PhkrxOZb/gGCq03S3Z7PDhS8pduQ== + dependencies: + "@babel/helper-module-imports" "^7.16.7" + "@babel/runtime" "^7.18.3" + "@emotion/hash" "^0.9.2" + "@emotion/memoize" "^0.9.0" + "@emotion/serialize" "^1.3.3" + babel-plugin-macros "^3.1.0" + convert-source-map "^1.5.0" + escape-string-regexp "^4.0.0" + find-root "^1.1.0" + source-map "^0.5.7" + stylis "4.2.0" + +"@emotion/cache@^11.14.0": + version "11.14.0" + resolved "https://registry.yarnpkg.com/@emotion/cache/-/cache-11.14.0.tgz#ee44b26986eeb93c8be82bb92f1f7a9b21b2ed76" + integrity sha512-L/B1lc/TViYk4DcpGxtAVbx0ZyiKM5ktoIyafGkH6zg/tj+mA+NE//aPYKG0k8kCHSHVJrpLpcAlOBEXQ3SavA== + dependencies: + "@emotion/memoize" "^0.9.0" + "@emotion/sheet" "^1.4.0" + "@emotion/utils" "^1.4.2" + "@emotion/weak-memoize" "^0.4.0" + stylis "4.2.0" + +"@emotion/hash@^0.9.2": + version "0.9.2" + resolved "https://registry.yarnpkg.com/@emotion/hash/-/hash-0.9.2.tgz#ff9221b9f58b4dfe61e619a7788734bd63f6898b" + integrity sha512-MyqliTZGuOm3+5ZRSaaBGP3USLw6+EGykkwZns2EPC5g8jJ4z9OrdZY9apkl3+UP9+sdz76YYkwCKP5gh8iY3g== + +"@emotion/is-prop-valid@^1.3.0": + version "1.4.0" + resolved "https://registry.yarnpkg.com/@emotion/is-prop-valid/-/is-prop-valid-1.4.0.tgz#e9ad47adff0b5c94c72db3669ce46de33edf28c0" + integrity sha512-QgD4fyscGcbbKwJmqNvUMSE02OsHUa+lAWKdEUIJKgqe5IwRSKd7+KhibEWdaKwgjLj0DRSHA9biAIqGBk05lw== + dependencies: + "@emotion/memoize" "^0.9.0" + +"@emotion/memoize@^0.9.0": + version "0.9.0" + resolved "https://registry.yarnpkg.com/@emotion/memoize/-/memoize-0.9.0.tgz#745969d649977776b43fc7648c556aaa462b4102" + integrity sha512-30FAj7/EoJ5mwVPOWhAyCX+FPfMDrVecJAM+Iw9NRoSl4BBAQeqj4cApHHUXOVvIPgLVDsCFoz/hGD+5QQD1GQ== + +"@emotion/react@^11.14.0": + version "11.14.0" + resolved "https://registry.yarnpkg.com/@emotion/react/-/react-11.14.0.tgz#cfaae35ebc67dd9ef4ea2e9acc6cd29e157dd05d" + integrity sha512-O000MLDBDdk/EohJPFUqvnp4qnHeYkVP5B0xEG0D/L7cOKP9kefu2DXn8dj74cQfsEzUqh+sr1RzFqiL1o+PpA== + dependencies: + "@babel/runtime" "^7.18.3" + "@emotion/babel-plugin" "^11.13.5" + "@emotion/cache" "^11.14.0" + "@emotion/serialize" "^1.3.3" + "@emotion/use-insertion-effect-with-fallbacks" "^1.2.0" + "@emotion/utils" "^1.4.2" + "@emotion/weak-memoize" "^0.4.0" + hoist-non-react-statics "^3.3.1" + +"@emotion/serialize@^1.3.3": + version "1.3.3" + resolved "https://registry.yarnpkg.com/@emotion/serialize/-/serialize-1.3.3.tgz#d291531005f17d704d0463a032fe679f376509e8" + integrity sha512-EISGqt7sSNWHGI76hC7x1CksiXPahbxEOrC5RjmFRJTqLyEK9/9hZvBbiYn70dw4wuwMKiEMCUlR6ZXTSWQqxA== + dependencies: + "@emotion/hash" "^0.9.2" + "@emotion/memoize" "^0.9.0" + "@emotion/unitless" "^0.10.0" + "@emotion/utils" "^1.4.2" + csstype "^3.0.2" + +"@emotion/sheet@^1.4.0": + version "1.4.0" + resolved "https://registry.yarnpkg.com/@emotion/sheet/-/sheet-1.4.0.tgz#c9299c34d248bc26e82563735f78953d2efca83c" + integrity sha512-fTBW9/8r2w3dXWYM4HCB1Rdp8NLibOw2+XELH5m5+AkWiL/KqYX6dc0kKYlaYyKjrQ6ds33MCdMPEwgs2z1rqg== + +"@emotion/styled@^11.14.1": + version "11.14.1" + resolved "https://registry.yarnpkg.com/@emotion/styled/-/styled-11.14.1.tgz#8c34bed2948e83e1980370305614c20955aacd1c" + integrity sha512-qEEJt42DuToa3gurlH4Qqc1kVpNq8wO8cJtDzU46TjlzWjDlsVyevtYCRijVq3SrHsROS+gVQ8Fnea108GnKzw== + dependencies: + "@babel/runtime" "^7.18.3" + "@emotion/babel-plugin" "^11.13.5" + "@emotion/is-prop-valid" "^1.3.0" + "@emotion/serialize" "^1.3.3" + "@emotion/use-insertion-effect-with-fallbacks" "^1.2.0" + "@emotion/utils" "^1.4.2" + +"@emotion/unitless@^0.10.0": + version "0.10.0" + resolved "https://registry.yarnpkg.com/@emotion/unitless/-/unitless-0.10.0.tgz#2af2f7c7e5150f497bdabd848ce7b218a27cf745" + integrity sha512-dFoMUuQA20zvtVTuxZww6OHoJYgrzfKM1t52mVySDJnMSEa08ruEvdYQbhvyu6soU+NeLVd3yKfTfT0NeV6qGg== + +"@emotion/use-insertion-effect-with-fallbacks@^1.2.0": + version "1.2.0" + resolved "https://registry.yarnpkg.com/@emotion/use-insertion-effect-with-fallbacks/-/use-insertion-effect-with-fallbacks-1.2.0.tgz#8a8cb77b590e09affb960f4ff1e9a89e532738bf" + integrity sha512-yJMtVdH59sxi/aVJBpk9FQq+OR8ll5GT8oWd57UpeaKEVGab41JWaCFA7FRLoMLloOZF/c/wsPoe+bfGmRKgDg== + +"@emotion/utils@^1.4.2": + version "1.4.2" + resolved "https://registry.yarnpkg.com/@emotion/utils/-/utils-1.4.2.tgz#6df6c45881fcb1c412d6688a311a98b7f59c1b52" + integrity sha512-3vLclRofFziIa3J2wDh9jjbkUz9qk5Vi3IZ/FSTKViB0k+ef0fPV7dYrUIugbgupYDx7v9ud/SjrtEP8Y4xLoA== + +"@emotion/weak-memoize@^0.4.0": + version "0.4.0" + resolved "https://registry.yarnpkg.com/@emotion/weak-memoize/-/weak-memoize-0.4.0.tgz#5e13fac887f08c44f76b0ccaf3370eb00fec9bb6" + integrity sha512-snKqtPW01tN0ui7yu9rGv69aJXr/a/Ywvl11sUjNtEcRc+ng/mQriFL0wLXMef74iHa/EkftbDzU9F8iFbH+zg== + +"@hapi/hoek@^9.0.0", "@hapi/hoek@^9.3.0": + version "9.3.0" + resolved "https://registry.yarnpkg.com/@hapi/hoek/-/hoek-9.3.0.tgz#8368869dcb735be2e7f5cb7647de78e167a251fb" + integrity sha512-/c6rf4UJlmHlC9b5BaNvzAcFv7HZ2QHaV0D4/HNlBdvFnvQq8RI4kYdhyPCl7Xj+oWvTWQ8ujhqS53LIgAe6KQ== + +"@hapi/topo@^5.1.0": + version "5.1.0" + resolved "https://registry.yarnpkg.com/@hapi/topo/-/topo-5.1.0.tgz#dc448e332c6c6e37a4dc02fd84ba8d44b9afb012" + integrity sha512-foQZKJig7Ob0BMAYBfcJk8d77QtOe7Wo4ox7ff1lQYoNNAb6jwcY1ncdoy2e9wQZzvNy7ODZCYJkK8kzmcAnAg== + dependencies: + "@hapi/hoek" "^9.0.0" + +"@iconify/react@^6.0.0": + version "6.0.2" + resolved "https://registry.yarnpkg.com/@iconify/react/-/react-6.0.2.tgz#b6d9bd0e13f9cb85b3a7fddbc70bbf71f5da1d33" + integrity sha512-SMmC2sactfpJD427WJEDN6PMyznTFMhByK9yLW0gOTtnjzzbsi/Ke/XqsumsavFPwNiXs8jSiYeZTmLCLwO+Fg== + dependencies: + "@iconify/types" "^2.0.0" + +"@iconify/types@^2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@iconify/types/-/types-2.0.0.tgz#ab0e9ea681d6c8a1214f30cd741fe3a20cc57f57" + integrity sha512-+wluvCrRhXrhyOmRDJ3q8mux9JkKy5SJ/v8ol2tu4FVjyYvtEzkc/3pK15ET6RKg4b4w4BmTk1+gsCUhf21Ykg== + +"@jest/schemas@^29.6.3": + version "29.6.3" + resolved "https://registry.yarnpkg.com/@jest/schemas/-/schemas-29.6.3.tgz#430b5ce8a4e0044a7e3819663305a7b3091c8e03" + integrity sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA== + dependencies: + "@sinclair/typebox" "^0.27.8" + +"@jest/types@^29.6.3": + version "29.6.3" + resolved "https://registry.yarnpkg.com/@jest/types/-/types-29.6.3.tgz#1131f8cf634e7e84c5e77bab12f052af585fba59" + integrity sha512-u3UPsIilWKOM3F9CXtrG8LEJmNxwoCQC/XVj4IKYXvvpx7QIi/Kg1LI5uDmDpKlac62NUtX7eLjRh+jVZcLOzw== + dependencies: + "@jest/schemas" "^29.6.3" + "@types/istanbul-lib-coverage" "^2.0.0" + "@types/istanbul-reports" "^3.0.0" + "@types/node" "*" + "@types/yargs" "^17.0.8" + chalk "^4.0.0" + +"@jridgewell/gen-mapping@^0.3.12", "@jridgewell/gen-mapping@^0.3.5": + version "0.3.13" + resolved "https://registry.yarnpkg.com/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz#6342a19f44347518c93e43b1ac69deb3c4656a1f" + integrity sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA== + dependencies: + "@jridgewell/sourcemap-codec" "^1.5.0" + "@jridgewell/trace-mapping" "^0.3.24" + +"@jridgewell/remapping@^2.3.5": + version "2.3.5" + resolved "https://registry.yarnpkg.com/@jridgewell/remapping/-/remapping-2.3.5.tgz#375c476d1972947851ba1e15ae8f123047445aa1" + integrity sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ== + dependencies: + "@jridgewell/gen-mapping" "^0.3.5" + "@jridgewell/trace-mapping" "^0.3.24" + +"@jridgewell/resolve-uri@^3.1.0": + version "3.1.2" + resolved "https://registry.yarnpkg.com/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz#7a0ee601f60f99a20c7c7c5ff0c80388c1189bd6" + integrity sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw== + +"@jridgewell/source-map@^0.3.3": + version "0.3.11" + resolved "https://registry.yarnpkg.com/@jridgewell/source-map/-/source-map-0.3.11.tgz#b21835cbd36db656b857c2ad02ebd413cc13a9ba" + integrity sha512-ZMp1V8ZFcPG5dIWnQLr3NSI1MiCU7UETdS/A0G8V/XWHvJv3ZsFqutJn1Y5RPmAPX6F3BiE397OqveU/9NCuIA== + dependencies: + "@jridgewell/gen-mapping" "^0.3.5" + "@jridgewell/trace-mapping" "^0.3.25" + +"@jridgewell/sourcemap-codec@^1.4.14", "@jridgewell/sourcemap-codec@^1.5.0": + version "1.5.5" + resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz#6912b00d2c631c0d15ce1a7ab57cd657f2a8f8ba" + integrity sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og== + +"@jridgewell/trace-mapping@^0.3.18", "@jridgewell/trace-mapping@^0.3.24", "@jridgewell/trace-mapping@^0.3.25", "@jridgewell/trace-mapping@^0.3.28": + version "0.3.31" + resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz#db15d6781c931f3a251a3dac39501c98a6082fd0" + integrity sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw== + dependencies: + "@jridgewell/resolve-uri" "^3.1.0" + "@jridgewell/sourcemap-codec" "^1.4.14" + +"@leichtgewicht/ip-codec@^2.0.1": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@leichtgewicht/ip-codec/-/ip-codec-2.0.5.tgz#4fc56c15c580b9adb7dc3c333a134e540b44bfb1" + integrity sha512-Vo+PSpZG2/fmgmiNzYK9qWRh8h/CHrwD0mo1h1DzL4yzHNSfWYujGTYsWGreD000gcgmZ7K4Ys6Tx9TxtsKdDw== + +"@mdx-js/mdx@^3.0.0": + version "3.1.1" + resolved "https://registry.yarnpkg.com/@mdx-js/mdx/-/mdx-3.1.1.tgz#c5ffd991a7536b149e17175eee57a1a2a511c6d1" + integrity sha512-f6ZO2ifpwAQIpzGWaBQT2TXxPv6z3RBzQKpVftEWN78Vl/YweF1uwussDx8ECAXVtr3Rs89fKyG9YlzUs9DyGQ== + dependencies: + "@types/estree" "^1.0.0" + "@types/estree-jsx" "^1.0.0" + "@types/hast" "^3.0.0" + "@types/mdx" "^2.0.0" + acorn "^8.0.0" + collapse-white-space "^2.0.0" + devlop "^1.0.0" + estree-util-is-identifier-name "^3.0.0" + estree-util-scope "^1.0.0" + estree-walker "^3.0.0" + hast-util-to-jsx-runtime "^2.0.0" + markdown-extensions "^2.0.0" + recma-build-jsx "^1.0.0" + recma-jsx "^1.0.0" + recma-stringify "^1.0.0" + rehype-recma "^1.0.0" + remark-mdx "^3.0.0" + remark-parse "^11.0.0" + remark-rehype "^11.0.0" + source-map "^0.7.0" + unified "^11.0.0" + unist-util-position-from-estree "^2.0.0" + unist-util-stringify-position "^4.0.0" + unist-util-visit "^5.0.0" + vfile "^6.0.0" + +"@mdx-js/react@^3.0.0": + version "3.1.1" + resolved "https://registry.yarnpkg.com/@mdx-js/react/-/react-3.1.1.tgz#24bda7fffceb2fe256f954482123cda1be5f5fef" + integrity sha512-f++rKLQgUVYDAtECQ6fn/is15GkEH9+nZPM3MS0RcxVqoTfawHvDlSCH7JbMhAM6uJ32v3eXLvLmLvjGu7PTQw== + dependencies: + "@types/mdx" "^2.0.0" + +"@mui/core-downloads-tracker@^7.3.2": + version "7.3.2" + resolved "https://registry.yarnpkg.com/@mui/core-downloads-tracker/-/core-downloads-tracker-7.3.2.tgz#896a7890864d619093dc79541ec1ecfa3b507ad2" + integrity sha512-AOyfHjyDKVPGJJFtxOlept3EYEdLoar/RvssBTWVAvDJGIE676dLi2oT/Kx+FoVXFoA/JdV7DEMq/BVWV3KHRw== + +"@mui/icons-material@^7.3.1": + version "7.3.2" + resolved "https://registry.yarnpkg.com/@mui/icons-material/-/icons-material-7.3.2.tgz#050049cd6195b815e85888aaebd436e8e95084b8" + integrity sha512-TZWazBjWXBjR6iGcNkbKklnwodcwj0SrChCNHc9BhD9rBgET22J1eFhHsEmvSvru9+opDy3umqAimQjokhfJlQ== + dependencies: + "@babel/runtime" "^7.28.3" + +"@mui/material@^7.3.1": + version "7.3.2" + resolved "https://registry.yarnpkg.com/@mui/material/-/material-7.3.2.tgz#21ad66bba695e2cd36e4a93e2e4ff5e04d8636a1" + integrity sha512-qXvbnawQhqUVfH1LMgMaiytP+ZpGoYhnGl7yYq2x57GYzcFL/iPzSZ3L30tlbwEjSVKNYcbiKO8tANR1tadjUg== + dependencies: + "@babel/runtime" "^7.28.3" + "@mui/core-downloads-tracker" "^7.3.2" + "@mui/system" "^7.3.2" + "@mui/types" "^7.4.6" + "@mui/utils" "^7.3.2" + "@popperjs/core" "^2.11.8" + "@types/react-transition-group" "^4.4.12" + clsx "^2.1.1" + csstype "^3.1.3" + prop-types "^15.8.1" + react-is "^19.1.1" + react-transition-group "^4.4.5" + +"@mui/private-theming@^7.3.2": + version "7.3.2" + resolved "https://registry.yarnpkg.com/@mui/private-theming/-/private-theming-7.3.2.tgz#9b883ac9ec9288327de038da6ddf8ffa179be831" + integrity sha512-ha7mFoOyZGJr75xeiO9lugS3joRROjc8tG1u4P50dH0KR7bwhHznVMcYg7MouochUy0OxooJm/OOSpJ7gKcMvg== + dependencies: + "@babel/runtime" "^7.28.3" + "@mui/utils" "^7.3.2" + prop-types "^15.8.1" + +"@mui/styled-engine@^7.3.2": + version "7.3.2" + resolved "https://registry.yarnpkg.com/@mui/styled-engine/-/styled-engine-7.3.2.tgz#cac6acb9480d6eaf60d9c99a7d24503e53236b32" + integrity sha512-PkJzW+mTaek4e0nPYZ6qLnW5RGa0KN+eRTf5FA2nc7cFZTeM+qebmGibaTLrgQBy3UpcpemaqfzToBNkzuxqew== + dependencies: + "@babel/runtime" "^7.28.3" + "@emotion/cache" "^11.14.0" + "@emotion/serialize" "^1.3.3" + "@emotion/sheet" "^1.4.0" + csstype "^3.1.3" + prop-types "^15.8.1" + +"@mui/system@^7.3.2": + version "7.3.2" + resolved "https://registry.yarnpkg.com/@mui/system/-/system-7.3.2.tgz#e838097fc6cb0a2e4c1822478950db89affb116a" + integrity sha512-9d8JEvZW+H6cVkaZ+FK56R53vkJe3HsTpcjMUtH8v1xK6Y1TjzHdZ7Jck02mGXJsE6MQGWVs3ogRHTQmS9Q/rA== + dependencies: + "@babel/runtime" "^7.28.3" + "@mui/private-theming" "^7.3.2" + "@mui/styled-engine" "^7.3.2" + "@mui/types" "^7.4.6" + "@mui/utils" "^7.3.2" + clsx "^2.1.1" + csstype "^3.1.3" + prop-types "^15.8.1" + +"@mui/types@^7.4.6": + version "7.4.6" + resolved "https://registry.yarnpkg.com/@mui/types/-/types-7.4.6.tgz#1432e0814cf155287283f6bbd1e95976a148ef07" + integrity sha512-NVBbIw+4CDMMppNamVxyTccNv0WxtDb7motWDlMeSC8Oy95saj1TIZMGynPpFLePt3yOD8TskzumeqORCgRGWw== + dependencies: + "@babel/runtime" "^7.28.3" + +"@mui/utils@^7.3.2": + version "7.3.2" + resolved "https://registry.yarnpkg.com/@mui/utils/-/utils-7.3.2.tgz#361775d72c557a03115150e8aec4329c7ef14563" + integrity sha512-4DMWQGenOdLnM3y/SdFQFwKsCLM+mqxzvoWp9+x2XdEzXapkznauHLiXtSohHs/mc0+5/9UACt1GdugCX2te5g== + dependencies: + "@babel/runtime" "^7.28.3" + "@mui/types" "^7.4.6" + "@types/prop-types" "^15.7.15" + clsx "^2.1.1" + prop-types "^15.8.1" + react-is "^19.1.1" + +"@nodelib/fs.scandir@2.1.5": + version "2.1.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz#7619c2eb21b25483f6d167548b4cfd5a7488c3d5" + integrity sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g== + dependencies: + "@nodelib/fs.stat" "2.0.5" + run-parallel "^1.1.9" + +"@nodelib/fs.stat@2.0.5", "@nodelib/fs.stat@^2.0.2": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz#5bd262af94e9d25bd1e71b05deed44876a222e8b" + integrity sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A== + +"@nodelib/fs.walk@^1.2.3": + version "1.2.8" + resolved "https://registry.yarnpkg.com/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz#e95737e8bb6746ddedf69c556953494f196fe69a" + integrity sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg== + dependencies: + "@nodelib/fs.scandir" "2.1.5" + fastq "^1.6.0" + +"@pnpm/config.env-replace@^1.1.0": + version "1.1.0" + resolved "https://registry.yarnpkg.com/@pnpm/config.env-replace/-/config.env-replace-1.1.0.tgz#ab29da53df41e8948a00f2433f085f54de8b3a4c" + integrity sha512-htyl8TWnKL7K/ESFa1oW2UB5lVDxuF5DpM7tBi6Hu2LNL3mWkIzNLG6N4zoCUP1lCKNxWy/3iu8mS8MvToGd6w== + +"@pnpm/network.ca-file@^1.0.1": + version "1.0.2" + resolved "https://registry.yarnpkg.com/@pnpm/network.ca-file/-/network.ca-file-1.0.2.tgz#2ab05e09c1af0cdf2fcf5035bea1484e222f7983" + integrity sha512-YcPQ8a0jwYU9bTdJDpXjMi7Brhkr1mXsXrUJvjqM2mQDgkRiz8jFaQGOdaLxgjtUfQgZhKy/O3cG/YwmgKaxLA== + dependencies: + graceful-fs "4.2.10" + +"@pnpm/npm-conf@^2.1.0": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@pnpm/npm-conf/-/npm-conf-2.3.1.tgz#bb375a571a0bd63ab0a23bece33033c683e9b6b0" + integrity sha512-c83qWb22rNRuB0UaVCI0uRPNRr8Z0FWnEIvT47jiHAmOIUHbBOg5XvV7pM5x+rKn9HRpjxquDbXYSXr3fAKFcw== + dependencies: + "@pnpm/config.env-replace" "^1.1.0" + "@pnpm/network.ca-file" "^1.0.1" + config-chain "^1.1.11" + +"@polka/url@^1.0.0-next.24": + version "1.0.0-next.29" + resolved "https://registry.yarnpkg.com/@polka/url/-/url-1.0.0-next.29.tgz#5a40109a1ab5f84d6fd8fc928b19f367cbe7e7b1" + integrity sha512-wwQAWhWSuHaag8c4q/KN/vCoeOJYshAIvMQwD4GpSb3OiZklFfvAgmj0VCBBImRpuF/aFgIRzllXlVX93Jevww== + +"@popperjs/core@^2.11.8": + version "2.11.8" + resolved "https://registry.yarnpkg.com/@popperjs/core/-/core-2.11.8.tgz#6b79032e760a0899cd4204710beede972a3a185f" + integrity sha512-P1st0aksCrn9sGZhp8GMYwBnQsbvAWsZAX44oXNNvLHGqAOcoVxmjZiohstwQ7SqKnbR47akdNi+uleWD8+g6A== + +"@sideway/address@^4.1.5": + version "4.1.5" + resolved "https://registry.yarnpkg.com/@sideway/address/-/address-4.1.5.tgz#4bc149a0076623ced99ca8208ba780d65a99b9d5" + integrity sha512-IqO/DUQHUkPeixNQ8n0JA6102hT9CmaljNTPmQ1u8MEhBo/R4Q8eKLN/vGZxuebwOroDB4cbpjheD4+/sKFK4Q== + dependencies: + "@hapi/hoek" "^9.0.0" + +"@sideway/formula@^3.0.1": + version "3.0.1" + resolved "https://registry.yarnpkg.com/@sideway/formula/-/formula-3.0.1.tgz#80fcbcbaf7ce031e0ef2dd29b1bfc7c3f583611f" + integrity sha512-/poHZJJVjx3L+zVD6g9KgHfYnb443oi7wLu/XKojDviHy6HOEOA6z1Trk5aR1dGcmPenJEgb2sK2I80LeS3MIg== + +"@sideway/pinpoint@^2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@sideway/pinpoint/-/pinpoint-2.0.0.tgz#cff8ffadc372ad29fd3f78277aeb29e632cc70df" + integrity sha512-RNiOoTPkptFtSVzQevY/yWtZwf/RxyVnPy/OcA9HBM3MlGDnBEYL5B41H0MTn0Uec8Hi+2qUtTfG2WWZBmMejQ== + +"@sinclair/typebox@^0.27.8": + version "0.27.8" + resolved "https://registry.yarnpkg.com/@sinclair/typebox/-/typebox-0.27.8.tgz#6667fac16c436b5434a387a34dedb013198f6e6e" + integrity sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA== + +"@sindresorhus/is@^4.6.0": + version "4.6.0" + resolved "https://registry.yarnpkg.com/@sindresorhus/is/-/is-4.6.0.tgz#3c7c9c46e678feefe7a2e5bb609d3dbd665ffb3f" + integrity sha512-t09vSN3MdfsyCHoFcTRCH/iUtG7OJ0CsjzB8cjAmKc/va/kIgeDI/TxsigdncE/4be734m0cvIYwNaV4i2XqAw== + +"@sindresorhus/is@^5.2.0": + version "5.6.0" + resolved "https://registry.yarnpkg.com/@sindresorhus/is/-/is-5.6.0.tgz#41dd6093d34652cddb5d5bdeee04eafc33826668" + integrity sha512-TV7t8GKYaJWsn00tFDqBw8+Uqmr8A0fRU1tvTQhyZzGv0sJCGRQL3JGMI3ucuKo3XIZdUP+Lx7/gh2t3lewy7g== + +"@slorber/remark-comment@^1.0.0": + version "1.0.0" + resolved "https://registry.yarnpkg.com/@slorber/remark-comment/-/remark-comment-1.0.0.tgz#2a020b3f4579c89dec0361673206c28d67e08f5a" + integrity sha512-RCE24n7jsOj1M0UPvIQCHTe7fI0sFL4S2nwKVWwHyVr/wI/H8GosgsJGyhnsZoGFnD/P2hLf1mSbrrgSLN93NA== + dependencies: + micromark-factory-space "^1.0.0" + micromark-util-character "^1.1.0" + micromark-util-symbol "^1.0.1" + +"@svgr/babel-plugin-add-jsx-attribute@8.0.0": + version "8.0.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-add-jsx-attribute/-/babel-plugin-add-jsx-attribute-8.0.0.tgz#4001f5d5dd87fa13303e36ee106e3ff3a7eb8b22" + integrity sha512-b9MIk7yhdS1pMCZM8VeNfUlSKVRhsHZNMl5O9SfaX0l0t5wjdgu4IDzGB8bpnGBBOjGST3rRFVsaaEtI4W6f7g== + +"@svgr/babel-plugin-remove-jsx-attribute@8.0.0": + version "8.0.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-remove-jsx-attribute/-/babel-plugin-remove-jsx-attribute-8.0.0.tgz#69177f7937233caca3a1afb051906698f2f59186" + integrity sha512-BcCkm/STipKvbCl6b7QFrMh/vx00vIP63k2eM66MfHJzPr6O2U0jYEViXkHJWqXqQYjdeA9cuCl5KWmlwjDvbA== + +"@svgr/babel-plugin-remove-jsx-empty-expression@8.0.0": + version "8.0.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-remove-jsx-empty-expression/-/babel-plugin-remove-jsx-empty-expression-8.0.0.tgz#c2c48104cfd7dcd557f373b70a56e9e3bdae1d44" + integrity sha512-5BcGCBfBxB5+XSDSWnhTThfI9jcO5f0Ai2V24gZpG+wXF14BzwxxdDb4g6trdOux0rhibGs385BeFMSmxtS3uA== + +"@svgr/babel-plugin-replace-jsx-attribute-value@8.0.0": + version "8.0.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-replace-jsx-attribute-value/-/babel-plugin-replace-jsx-attribute-value-8.0.0.tgz#8fbb6b2e91fa26ac5d4aa25c6b6e4f20f9c0ae27" + integrity sha512-KVQ+PtIjb1BuYT3ht8M5KbzWBhdAjjUPdlMtpuw/VjT8coTrItWX6Qafl9+ji831JaJcu6PJNKCV0bp01lBNzQ== + +"@svgr/babel-plugin-svg-dynamic-title@8.0.0": + version "8.0.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-svg-dynamic-title/-/babel-plugin-svg-dynamic-title-8.0.0.tgz#1d5ba1d281363fc0f2f29a60d6d936f9bbc657b0" + integrity sha512-omNiKqwjNmOQJ2v6ge4SErBbkooV2aAWwaPFs2vUY7p7GhVkzRkJ00kILXQvRhA6miHnNpXv7MRnnSjdRjK8og== + +"@svgr/babel-plugin-svg-em-dimensions@8.0.0": + version "8.0.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-svg-em-dimensions/-/babel-plugin-svg-em-dimensions-8.0.0.tgz#35e08df300ea8b1d41cb8f62309c241b0369e501" + integrity sha512-mURHYnu6Iw3UBTbhGwE/vsngtCIbHE43xCRK7kCw4t01xyGqb2Pd+WXekRRoFOBIY29ZoOhUCTEweDMdrjfi9g== + +"@svgr/babel-plugin-transform-react-native-svg@8.1.0": + version "8.1.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-transform-react-native-svg/-/babel-plugin-transform-react-native-svg-8.1.0.tgz#90a8b63998b688b284f255c6a5248abd5b28d754" + integrity sha512-Tx8T58CHo+7nwJ+EhUwx3LfdNSG9R2OKfaIXXs5soiy5HtgoAEkDay9LIimLOcG8dJQH1wPZp/cnAv6S9CrR1Q== + +"@svgr/babel-plugin-transform-svg-component@8.0.0": + version "8.0.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-transform-svg-component/-/babel-plugin-transform-svg-component-8.0.0.tgz#013b4bfca88779711f0ed2739f3f7efcefcf4f7e" + integrity sha512-DFx8xa3cZXTdb/k3kfPeaixecQLgKh5NVBMwD0AQxOzcZawK4oo1Jh9LbrcACUivsCA7TLG8eeWgrDXjTMhRmw== + +"@svgr/babel-preset@8.1.0": + version "8.1.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-preset/-/babel-preset-8.1.0.tgz#0e87119aecdf1c424840b9d4565b7137cabf9ece" + integrity sha512-7EYDbHE7MxHpv4sxvnVPngw5fuR6pw79SkcrILHJ/iMpuKySNCl5W1qcwPEpU+LgyRXOaAFgH0KhwD18wwg6ug== + dependencies: + "@svgr/babel-plugin-add-jsx-attribute" "8.0.0" + "@svgr/babel-plugin-remove-jsx-attribute" "8.0.0" + "@svgr/babel-plugin-remove-jsx-empty-expression" "8.0.0" + "@svgr/babel-plugin-replace-jsx-attribute-value" "8.0.0" + "@svgr/babel-plugin-svg-dynamic-title" "8.0.0" + "@svgr/babel-plugin-svg-em-dimensions" "8.0.0" + "@svgr/babel-plugin-transform-react-native-svg" "8.1.0" + "@svgr/babel-plugin-transform-svg-component" "8.0.0" + +"@svgr/core@8.1.0": + version "8.1.0" + resolved "https://registry.yarnpkg.com/@svgr/core/-/core-8.1.0.tgz#41146f9b40b1a10beaf5cc4f361a16a3c1885e88" + integrity sha512-8QqtOQT5ACVlmsvKOJNEaWmRPmcojMOzCz4Hs2BGG/toAp/K38LcsMRyLp349glq5AzJbCEeimEoxaX6v/fLrA== + dependencies: + "@babel/core" "^7.21.3" + "@svgr/babel-preset" "8.1.0" + camelcase "^6.2.0" + cosmiconfig "^8.1.3" + snake-case "^3.0.4" + +"@svgr/hast-util-to-babel-ast@8.0.0": + version "8.0.0" + resolved "https://registry.yarnpkg.com/@svgr/hast-util-to-babel-ast/-/hast-util-to-babel-ast-8.0.0.tgz#6952fd9ce0f470e1aded293b792a2705faf4ffd4" + integrity sha512-EbDKwO9GpfWP4jN9sGdYwPBU0kdomaPIL2Eu4YwmgP+sJeXT+L7bMwJUBnhzfH8Q2qMBqZ4fJwpCyYsAN3mt2Q== + dependencies: + "@babel/types" "^7.21.3" + entities "^4.4.0" + +"@svgr/plugin-jsx@8.1.0": + version "8.1.0" + resolved "https://registry.yarnpkg.com/@svgr/plugin-jsx/-/plugin-jsx-8.1.0.tgz#96969f04a24b58b174ee4cd974c60475acbd6928" + integrity sha512-0xiIyBsLlr8quN+WyuxooNW9RJ0Dpr8uOnH/xrCVO8GLUcwHISwj1AG0k+LFzteTkAA0GbX0kj9q6Dk70PTiPA== + dependencies: + "@babel/core" "^7.21.3" + "@svgr/babel-preset" "8.1.0" + "@svgr/hast-util-to-babel-ast" "8.0.0" + svg-parser "^2.0.4" + +"@svgr/plugin-svgo@8.1.0": + version "8.1.0" + resolved "https://registry.yarnpkg.com/@svgr/plugin-svgo/-/plugin-svgo-8.1.0.tgz#b115b7b967b564f89ac58feae89b88c3decd0f00" + integrity sha512-Ywtl837OGO9pTLIN/onoWLmDQ4zFUycI1g76vuKGEz6evR/ZTJlJuz3G/fIkb6OVBJ2g0o6CGJzaEjfmEo3AHA== + dependencies: + cosmiconfig "^8.1.3" + deepmerge "^4.3.1" + svgo "^3.0.2" + +"@svgr/webpack@^8.1.0": + version "8.1.0" + resolved "https://registry.yarnpkg.com/@svgr/webpack/-/webpack-8.1.0.tgz#16f1b5346f102f89fda6ec7338b96a701d8be0c2" + integrity sha512-LnhVjMWyMQV9ZmeEy26maJk+8HTIbd59cH4F2MJ439k9DqejRisfFNGAPvRYlKETuh9LrImlS8aKsBgKjMA8WA== + dependencies: + "@babel/core" "^7.21.3" + "@babel/plugin-transform-react-constant-elements" "^7.21.3" + "@babel/preset-env" "^7.20.2" + "@babel/preset-react" "^7.18.6" + "@babel/preset-typescript" "^7.21.0" + "@svgr/core" "8.1.0" + "@svgr/plugin-jsx" "8.1.0" + "@svgr/plugin-svgo" "8.1.0" + +"@szmarczak/http-timer@^5.0.1": + version "5.0.1" + resolved "https://registry.yarnpkg.com/@szmarczak/http-timer/-/http-timer-5.0.1.tgz#c7c1bf1141cdd4751b0399c8fc7b8b664cd5be3a" + integrity sha512-+PmQX0PiAYPMeVYe237LJAYvOMYW1j2rH5YROyS3b4CTVJum34HfRvKvAzozHAQG0TnHNdUfY9nCeUyRAs//cw== + dependencies: + defer-to-connect "^2.0.1" + +"@trysound/sax@0.2.0": + version "0.2.0" + resolved "https://registry.yarnpkg.com/@trysound/sax/-/sax-0.2.0.tgz#cccaab758af56761eb7bf37af6f03f326dd798ad" + integrity sha512-L7z9BgrNEcYyUYtF+HaEfiS5ebkh9jXqbszz7pC0hRBPaatV0XjSD3+eHrpqFemQfgwiFF0QPIarnIihIDn7OA== + +"@types/body-parser@*": + version "1.19.6" + resolved "https://registry.yarnpkg.com/@types/body-parser/-/body-parser-1.19.6.tgz#1859bebb8fd7dac9918a45d54c1971ab8b5af474" + integrity sha512-HLFeCYgz89uk22N5Qg3dvGvsv46B8GLvKKo1zKG4NybA8U2DiEO3w9lqGg29t/tfLRJpJ6iQxnVw4OnB7MoM9g== + dependencies: + "@types/connect" "*" + "@types/node" "*" + +"@types/bonjour@^3.5.9": + version "3.5.13" + resolved "https://registry.yarnpkg.com/@types/bonjour/-/bonjour-3.5.13.tgz#adf90ce1a105e81dd1f9c61fdc5afda1bfb92956" + integrity sha512-z9fJ5Im06zvUL548KvYNecEVlA7cVDkGUi6kZusb04mpyEFKCIZJvloCcmpmLaIahDpOQGHaHmG6imtPMmPXGQ== + dependencies: + "@types/node" "*" + +"@types/connect-history-api-fallback@^1.3.5": + version "1.5.4" + resolved "https://registry.yarnpkg.com/@types/connect-history-api-fallback/-/connect-history-api-fallback-1.5.4.tgz#7de71645a103056b48ac3ce07b3520b819c1d5b3" + integrity sha512-n6Cr2xS1h4uAulPRdlw6Jl6s1oG8KrVilPN2yUITEs+K48EzMJJ3W1xy8K5eWuFvjp3R74AOIGSmp2UfBJ8HFw== + dependencies: + "@types/express-serve-static-core" "*" + "@types/node" "*" + +"@types/connect@*": + version "3.4.38" + resolved "https://registry.yarnpkg.com/@types/connect/-/connect-3.4.38.tgz#5ba7f3bc4fbbdeaff8dded952e5ff2cc53f8d858" + integrity sha512-K6uROf1LD88uDQqJCktA4yzL1YYAK6NgfsI0v/mTgyPKWsX1CnJ0XPSDhViejru1GcRkLWb8RlzFYJRqGUbaug== + dependencies: + "@types/node" "*" + +"@types/debug@^4.0.0": + version "4.1.12" + resolved "https://registry.yarnpkg.com/@types/debug/-/debug-4.1.12.tgz#a155f21690871953410df4b6b6f53187f0500917" + integrity sha512-vIChWdVG3LG1SMxEvI/AK+FWJthlrqlTu7fbrlywTkkaONwk/UAGaULXRlf8vkzFBLVm0zkMdCquhL5aOjhXPQ== + dependencies: + "@types/ms" "*" + +"@types/eslint-scope@^3.7.7": + version "3.7.7" + resolved "https://registry.yarnpkg.com/@types/eslint-scope/-/eslint-scope-3.7.7.tgz#3108bd5f18b0cdb277c867b3dd449c9ed7079ac5" + integrity sha512-MzMFlSLBqNF2gcHWO0G1vP/YQyfvrxZ0bF+u7mzUdZ1/xK4A4sru+nraZz5i3iEIk1l1uyicaDVTB4QbbEkAYg== + dependencies: + "@types/eslint" "*" + "@types/estree" "*" + +"@types/eslint@*": + version "9.6.1" + resolved "https://registry.yarnpkg.com/@types/eslint/-/eslint-9.6.1.tgz#d5795ad732ce81715f27f75da913004a56751584" + integrity sha512-FXx2pKgId/WyYo2jXw63kk7/+TY7u7AziEJxJAnSFzHlqTAS3Ync6SvgYAN/k4/PQpnnVuzoMuVnByKK2qp0ag== + dependencies: + "@types/estree" "*" + "@types/json-schema" "*" + +"@types/estree-jsx@^1.0.0": + version "1.0.5" + resolved "https://registry.yarnpkg.com/@types/estree-jsx/-/estree-jsx-1.0.5.tgz#858a88ea20f34fe65111f005a689fa1ebf70dc18" + integrity sha512-52CcUVNFyfb1A2ALocQw/Dd1BQFNmSdkuC3BkZ6iqhdMfQz7JWOFRuJFloOzjk+6WijU56m9oKXFAXc7o3Towg== + dependencies: + "@types/estree" "*" + +"@types/estree@*", "@types/estree@^1.0.0", "@types/estree@^1.0.8": + version "1.0.8" + resolved "https://registry.yarnpkg.com/@types/estree/-/estree-1.0.8.tgz#958b91c991b1867ced318bedea0e215ee050726e" + integrity sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w== + +"@types/express-serve-static-core@*", "@types/express-serve-static-core@^5.0.0": + version "5.0.7" + resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-5.0.7.tgz#2fa94879c9d46b11a5df4c74ac75befd6b283de6" + integrity sha512-R+33OsgWw7rOhD1emjU7dzCDHucJrgJXMA5PYCzJxVil0dsyx5iBEPHqpPfiKNJQb7lZ1vxwoLR4Z87bBUpeGQ== + dependencies: + "@types/node" "*" + "@types/qs" "*" + "@types/range-parser" "*" + "@types/send" "*" + +"@types/express-serve-static-core@^4.17.33": + version "4.19.6" + resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-4.19.6.tgz#e01324c2a024ff367d92c66f48553ced0ab50267" + integrity sha512-N4LZ2xG7DatVqhCZzOGb1Yi5lMbXSZcmdLDe9EzSndPV2HpWYWzRbaerl2n27irrm94EPpprqa8KpskPT085+A== + dependencies: + "@types/node" "*" + "@types/qs" "*" + "@types/range-parser" "*" + "@types/send" "*" + +"@types/express@*": + version "5.0.3" + resolved "https://registry.yarnpkg.com/@types/express/-/express-5.0.3.tgz#6c4bc6acddc2e2a587142e1d8be0bce20757e956" + integrity sha512-wGA0NX93b19/dZC1J18tKWVIYWyyF2ZjT9vin/NRu0qzzvfVzWjs04iq2rQ3H65vCTQYlRqs3YHfY7zjdV+9Kw== + dependencies: + "@types/body-parser" "*" + "@types/express-serve-static-core" "^5.0.0" + "@types/serve-static" "*" + +"@types/express@^4.17.13": + version "4.17.23" + resolved "https://registry.yarnpkg.com/@types/express/-/express-4.17.23.tgz#35af3193c640bfd4d7fe77191cd0ed411a433bef" + integrity sha512-Crp6WY9aTYP3qPi2wGDo9iUe/rceX01UMhnF1jmwDcKCFM6cx7YhGP/Mpr3y9AASpfHixIG0E6azCcL5OcDHsQ== + dependencies: + "@types/body-parser" "*" + "@types/express-serve-static-core" "^4.17.33" + "@types/qs" "*" + "@types/serve-static" "*" + +"@types/gtag.js@^0.0.12": + version "0.0.12" + resolved "https://registry.yarnpkg.com/@types/gtag.js/-/gtag.js-0.0.12.tgz#095122edca896689bdfcdd73b057e23064d23572" + integrity sha512-YQV9bUsemkzG81Ea295/nF/5GijnD2Af7QhEofh7xu+kvCN6RdodgNwwGWXB5GMI3NoyvQo0odNctoH/qLMIpg== + +"@types/hast@^3.0.0": + version "3.0.4" + resolved "https://registry.yarnpkg.com/@types/hast/-/hast-3.0.4.tgz#1d6b39993b82cea6ad783945b0508c25903e15aa" + integrity sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ== + dependencies: + "@types/unist" "*" + +"@types/history@^4.7.11": + version "4.7.11" + resolved "https://registry.yarnpkg.com/@types/history/-/history-4.7.11.tgz#56588b17ae8f50c53983a524fc3cc47437969d64" + integrity sha512-qjDJRrmvBMiTx+jyLxvLfJU7UznFuokDv4f3WRuriHKERccVpFU+8XMQUAbDzoiJCsmexxRExQeMwwCdamSKDA== + +"@types/html-minifier-terser@^6.0.0": + version "6.1.0" + resolved "https://registry.yarnpkg.com/@types/html-minifier-terser/-/html-minifier-terser-6.1.0.tgz#4fc33a00c1d0c16987b1a20cf92d20614c55ac35" + integrity sha512-oh/6byDPnL1zeNXFrDXFLyZjkr1MsBG667IM792caf1L2UPOOMf65NFzjUH/ltyfwjAGfs1rsX1eftK0jC/KIg== + +"@types/http-cache-semantics@^4.0.2": + version "4.0.4" + resolved "https://registry.yarnpkg.com/@types/http-cache-semantics/-/http-cache-semantics-4.0.4.tgz#b979ebad3919799c979b17c72621c0bc0a31c6c4" + integrity sha512-1m0bIFVc7eJWyve9S0RnuRgcQqF/Xd5QsUZAZeQFr1Q3/p9JWoQQEqmVy+DPTNpGXwhgIetAoYF8JSc33q29QA== + +"@types/http-errors@*": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@types/http-errors/-/http-errors-2.0.5.tgz#5b749ab2b16ba113423feb1a64a95dcd30398472" + integrity sha512-r8Tayk8HJnX0FztbZN7oVqGccWgw98T/0neJphO91KkmOzug1KkofZURD4UaD5uH8AqcFLfdPErnBod0u71/qg== + +"@types/http-proxy@^1.17.8": + version "1.17.16" + resolved "https://registry.yarnpkg.com/@types/http-proxy/-/http-proxy-1.17.16.tgz#dee360707b35b3cc85afcde89ffeebff7d7f9240" + integrity sha512-sdWoUajOB1cd0A8cRRQ1cfyWNbmFKLAqBB89Y8x5iYyG/mkJHc0YUH8pdWBy2omi9qtCpiIgGjuwO0dQST2l5w== + dependencies: + "@types/node" "*" + +"@types/istanbul-lib-coverage@*", "@types/istanbul-lib-coverage@^2.0.0": + version "2.0.6" + resolved "https://registry.yarnpkg.com/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz#7739c232a1fee9b4d3ce8985f314c0c6d33549d7" + integrity sha512-2QF/t/auWm0lsy8XtKVPG19v3sSOQlJe/YHZgfjb/KBBHOGSV+J2q/S671rcq9uTBrLAXmZpqJiaQbMT+zNU1w== + +"@types/istanbul-lib-report@*": + version "3.0.3" + resolved "https://registry.yarnpkg.com/@types/istanbul-lib-report/-/istanbul-lib-report-3.0.3.tgz#53047614ae72e19fc0401d872de3ae2b4ce350bf" + integrity sha512-NQn7AHQnk/RSLOxrBbGyJM/aVQ+pjj5HCgasFxc0K/KhoATfQ/47AyUl15I2yBUpihjmas+a+VJBOqecrFH+uA== + dependencies: + "@types/istanbul-lib-coverage" "*" + +"@types/istanbul-reports@^3.0.0": + version "3.0.4" + resolved "https://registry.yarnpkg.com/@types/istanbul-reports/-/istanbul-reports-3.0.4.tgz#0f03e3d2f670fbdac586e34b433783070cc16f54" + integrity sha512-pk2B1NWalF9toCRu6gjBzR69syFjP4Od8WRAX+0mmf9lAjCRicLOWc+ZrxZHx/0XRjotgkF9t6iaMJ+aXcOdZQ== + dependencies: + "@types/istanbul-lib-report" "*" + +"@types/json-schema@*", "@types/json-schema@^7.0.15", "@types/json-schema@^7.0.8", "@types/json-schema@^7.0.9": + version "7.0.15" + resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.15.tgz#596a1747233694d50f6ad8a7869fcb6f56cf5841" + integrity sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA== + +"@types/mdast@^4.0.0", "@types/mdast@^4.0.2": + version "4.0.4" + resolved "https://registry.yarnpkg.com/@types/mdast/-/mdast-4.0.4.tgz#7ccf72edd2f1aa7dd3437e180c64373585804dd6" + integrity sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA== + dependencies: + "@types/unist" "*" + +"@types/mdx@^2.0.0": + version "2.0.13" + resolved "https://registry.yarnpkg.com/@types/mdx/-/mdx-2.0.13.tgz#68f6877043d377092890ff5b298152b0a21671bd" + integrity sha512-+OWZQfAYyio6YkJb3HLxDrvnx6SWWDbC0zVPfBRzUk0/nqoDyf6dNxQi3eArPe8rJ473nobTMQ/8Zk+LxJ+Yuw== + +"@types/mime@^1": + version "1.3.5" + resolved "https://registry.yarnpkg.com/@types/mime/-/mime-1.3.5.tgz#1ef302e01cf7d2b5a0fa526790c9123bf1d06690" + integrity sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w== + +"@types/ms@*": + version "2.1.0" + resolved "https://registry.yarnpkg.com/@types/ms/-/ms-2.1.0.tgz#052aa67a48eccc4309d7f0191b7e41434b90bb78" + integrity sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA== + +"@types/node-forge@^1.3.0": + version "1.3.14" + resolved "https://registry.yarnpkg.com/@types/node-forge/-/node-forge-1.3.14.tgz#006c2616ccd65550560c2757d8472eb6d3ecea0b" + integrity sha512-mhVF2BnD4BO+jtOp7z1CdzaK4mbuK0LLQYAvdOLqHTavxFNq4zA1EmYkpnFjP8HOUzedfQkRnp0E2ulSAYSzAw== + dependencies: + "@types/node" "*" + +"@types/node@*": + version "24.5.0" + resolved "https://registry.yarnpkg.com/@types/node/-/node-24.5.0.tgz#70a482e6b1d50e603729d74e62a9a43705ddc9d7" + integrity sha512-y1dMvuvJspJiPSDZUQ+WMBvF7dpnEqN4x9DDC9ie5Fs/HUZJA3wFp7EhHoVaKX/iI0cRoECV8X2jL8zi0xrHCg== + dependencies: + undici-types "~7.12.0" + +"@types/node@^17.0.5": + version "17.0.45" + resolved "https://registry.yarnpkg.com/@types/node/-/node-17.0.45.tgz#2c0fafd78705e7a18b7906b5201a522719dc5190" + integrity sha512-w+tIMs3rq2afQdsPJlODhoUEKzFP1ayaoyl1CcnwtIlsVe7K7bA1NGm4s3PraqTLlXnbIN84zuBlxBWo1u9BLw== + +"@types/parse-json@^4.0.0": + version "4.0.2" + resolved "https://registry.yarnpkg.com/@types/parse-json/-/parse-json-4.0.2.tgz#5950e50960793055845e956c427fc2b0d70c5239" + integrity sha512-dISoDXWWQwUquiKsyZ4Ng+HX2KsPL7LyHKHQwgGFEA3IaKac4Obd+h2a/a6waisAoepJlBcx9paWqjA8/HVjCw== + +"@types/prismjs@^1.26.0": + version "1.26.5" + resolved "https://registry.yarnpkg.com/@types/prismjs/-/prismjs-1.26.5.tgz#72499abbb4c4ec9982446509d2f14fb8483869d6" + integrity sha512-AUZTa7hQ2KY5L7AmtSiqxlhWxb4ina0yd8hNbl4TWuqnv/pFP0nDMb3YrfSBf4hJVGLh2YEIBfKaBW/9UEl6IQ== + +"@types/prop-types@^15.7.15": + version "15.7.15" + resolved "https://registry.yarnpkg.com/@types/prop-types/-/prop-types-15.7.15.tgz#e6e5a86d602beaca71ce5163fadf5f95d70931c7" + integrity sha512-F6bEyamV9jKGAFBEmlQnesRPGOQqS2+Uwi0Em15xenOxHaf2hv6L8YCVn3rPdPJOiJfPiCnLIRyvwVaqMY3MIw== + +"@types/qs@*": + version "6.14.0" + resolved "https://registry.yarnpkg.com/@types/qs/-/qs-6.14.0.tgz#d8b60cecf62f2db0fb68e5e006077b9178b85de5" + integrity sha512-eOunJqu0K1923aExK6y8p6fsihYEn/BYuQ4g0CxAAgFc4b/ZLN4CrsRZ55srTdqoiLzU2B2evC+apEIxprEzkQ== + +"@types/range-parser@*": + version "1.2.7" + resolved "https://registry.yarnpkg.com/@types/range-parser/-/range-parser-1.2.7.tgz#50ae4353eaaddc04044279812f52c8c65857dbcb" + integrity sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ== + +"@types/react-router-config@*", "@types/react-router-config@^5.0.7": + version "5.0.11" + resolved "https://registry.yarnpkg.com/@types/react-router-config/-/react-router-config-5.0.11.tgz#2761a23acc7905a66a94419ee40294a65aaa483a" + integrity sha512-WmSAg7WgqW7m4x8Mt4N6ZyKz0BubSj/2tVUMsAHp+Yd2AMwcSbeFq9WympT19p5heCFmF97R9eD5uUR/t4HEqw== + dependencies: + "@types/history" "^4.7.11" + "@types/react" "*" + "@types/react-router" "^5.1.0" + +"@types/react-router-dom@*": + version "5.3.3" + resolved "https://registry.yarnpkg.com/@types/react-router-dom/-/react-router-dom-5.3.3.tgz#e9d6b4a66fcdbd651a5f106c2656a30088cc1e83" + integrity sha512-kpqnYK4wcdm5UaWI3fLcELopqLrHgLqNsdpHauzlQktfkHL3npOSwtj1Uz9oKBAzs7lFtVkV8j83voAz2D8fhw== + dependencies: + "@types/history" "^4.7.11" + "@types/react" "*" + "@types/react-router" "*" + +"@types/react-router@*", "@types/react-router@^5.1.0": + version "5.1.20" + resolved "https://registry.yarnpkg.com/@types/react-router/-/react-router-5.1.20.tgz#88eccaa122a82405ef3efbcaaa5dcdd9f021387c" + integrity sha512-jGjmu/ZqS7FjSH6owMcD5qpq19+1RS9DeVRqfl1FeBMxTDQAGwlMWOcs52NDoXaNKyG3d1cYQFMs9rCrb88o9Q== + dependencies: + "@types/history" "^4.7.11" + "@types/react" "*" + +"@types/react-transition-group@^4.4.12": + version "4.4.12" + resolved "https://registry.yarnpkg.com/@types/react-transition-group/-/react-transition-group-4.4.12.tgz#b5d76568485b02a307238270bfe96cb51ee2a044" + integrity sha512-8TV6R3h2j7a91c+1DXdJi3Syo69zzIZbz7Lg5tORM5LEJG7X/E6a1V3drRyBRZq7/utz7A+c4OgYLiLcYGHG6w== + +"@types/react@*": + version "19.1.13" + resolved "https://registry.yarnpkg.com/@types/react/-/react-19.1.13.tgz#fc650ffa680d739a25a530f5d7ebe00cdd771883" + integrity sha512-hHkbU/eoO3EG5/MZkuFSKmYqPbSVk5byPFa3e7y/8TybHiLMACgI8seVYlicwk7H5K/rI2px9xrQp/C+AUDTiQ== + dependencies: + csstype "^3.0.2" + +"@types/retry@0.12.0": + version "0.12.0" + resolved "https://registry.yarnpkg.com/@types/retry/-/retry-0.12.0.tgz#2b35eccfcee7d38cd72ad99232fbd58bffb3c84d" + integrity sha512-wWKOClTTiizcZhXnPY4wikVAwmdYHp8q6DmC+EJUzAMsycb7HB32Kh9RN4+0gExjmPmZSAQjgURXIGATPegAvA== + +"@types/sax@^1.2.1": + version "1.2.7" + resolved "https://registry.yarnpkg.com/@types/sax/-/sax-1.2.7.tgz#ba5fe7df9aa9c89b6dff7688a19023dd2963091d" + integrity sha512-rO73L89PJxeYM3s3pPPjiPgVVcymqU490g0YO5n5By0k2Erzj6tay/4lr1CHAAU4JyOWd1rpQ8bCf6cZfHU96A== + dependencies: + "@types/node" "*" + +"@types/send@*": + version "0.17.5" + resolved "https://registry.yarnpkg.com/@types/send/-/send-0.17.5.tgz#d991d4f2b16f2b1ef497131f00a9114290791e74" + integrity sha512-z6F2D3cOStZvuk2SaP6YrwkNO65iTZcwA2ZkSABegdkAh/lf+Aa/YQndZVfmEXT5vgAp6zv06VQ3ejSVjAny4w== + dependencies: + "@types/mime" "^1" + "@types/node" "*" + +"@types/serve-index@^1.9.1": + version "1.9.4" + resolved "https://registry.yarnpkg.com/@types/serve-index/-/serve-index-1.9.4.tgz#e6ae13d5053cb06ed36392110b4f9a49ac4ec898" + integrity sha512-qLpGZ/c2fhSs5gnYsQxtDEq3Oy8SXPClIXkW5ghvAvsNuVSA8k+gCONcUCS/UjLEYvYps+e8uBtfgXgvhwfNug== + dependencies: + "@types/express" "*" + +"@types/serve-static@*", "@types/serve-static@^1.13.10": + version "1.15.8" + resolved "https://registry.yarnpkg.com/@types/serve-static/-/serve-static-1.15.8.tgz#8180c3fbe4a70e8f00b9f70b9ba7f08f35987877" + integrity sha512-roei0UY3LhpOJvjbIP6ZZFngyLKl5dskOtDhxY5THRSpO+ZI+nzJ+m5yUMzGrp89YRa7lvknKkMYjqQFGwA7Sg== + dependencies: + "@types/http-errors" "*" + "@types/node" "*" + "@types/send" "*" + +"@types/sockjs@^0.3.33": + version "0.3.36" + resolved "https://registry.yarnpkg.com/@types/sockjs/-/sockjs-0.3.36.tgz#ce322cf07bcc119d4cbf7f88954f3a3bd0f67535" + integrity sha512-MK9V6NzAS1+Ud7JV9lJLFqW85VbC9dq3LmwZCuBe4wBDgKC0Kj/jd8Xl+nSviU+Qc3+m7umHHyHg//2KSa0a0Q== + dependencies: + "@types/node" "*" + +"@types/unist@*", "@types/unist@^3.0.0": + version "3.0.3" + resolved "https://registry.yarnpkg.com/@types/unist/-/unist-3.0.3.tgz#acaab0f919ce69cce629c2d4ed2eb4adc1b6c20c" + integrity sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q== + +"@types/unist@^2.0.0": + version "2.0.11" + resolved "https://registry.yarnpkg.com/@types/unist/-/unist-2.0.11.tgz#11af57b127e32487774841f7a4e54eab166d03c4" + integrity sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA== + +"@types/ws@^8.5.5": + version "8.18.1" + resolved "https://registry.yarnpkg.com/@types/ws/-/ws-8.18.1.tgz#48464e4bf2ddfd17db13d845467f6070ffea4aa9" + integrity sha512-ThVF6DCVhA8kUGy+aazFQ4kXQ7E1Ty7A3ypFOe0IcJV8O/M511G99AW24irKrW56Wt44yG9+ij8FaqoBGkuBXg== + dependencies: + "@types/node" "*" + +"@types/yargs-parser@*": + version "21.0.3" + resolved "https://registry.yarnpkg.com/@types/yargs-parser/-/yargs-parser-21.0.3.tgz#815e30b786d2e8f0dcd85fd5bcf5e1a04d008f15" + integrity sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ== + +"@types/yargs@^17.0.8": + version "17.0.33" + resolved "https://registry.yarnpkg.com/@types/yargs/-/yargs-17.0.33.tgz#8c32303da83eec050a84b3c7ae7b9f922d13e32d" + integrity sha512-WpxBCKWPLr4xSsHgz511rFJAM+wS28w2zEO1QDNY5zM/S8ok70NNfztH0xwhqKyaK0OHCbN98LDAZuy1ctxDkA== + dependencies: + "@types/yargs-parser" "*" + +"@ungap/structured-clone@^1.0.0": + version "1.3.0" + resolved "https://registry.yarnpkg.com/@ungap/structured-clone/-/structured-clone-1.3.0.tgz#d06bbb384ebcf6c505fde1c3d0ed4ddffe0aaff8" + integrity sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g== + +"@webassemblyjs/ast@1.14.1", "@webassemblyjs/ast@^1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/ast/-/ast-1.14.1.tgz#a9f6a07f2b03c95c8d38c4536a1fdfb521ff55b6" + integrity sha512-nuBEDgQfm1ccRp/8bCQrx1frohyufl4JlbMMZ4P1wpeOfDhF6FQkxZJ1b/e+PLwr6X1Nhw6OLme5usuBWYBvuQ== + dependencies: + "@webassemblyjs/helper-numbers" "1.13.2" + "@webassemblyjs/helper-wasm-bytecode" "1.13.2" + +"@webassemblyjs/floating-point-hex-parser@1.13.2": + version "1.13.2" + resolved "https://registry.yarnpkg.com/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.13.2.tgz#fcca1eeddb1cc4e7b6eed4fc7956d6813b21b9fb" + integrity sha512-6oXyTOzbKxGH4steLbLNOu71Oj+C8Lg34n6CqRvqfS2O71BxY6ByfMDRhBytzknj9yGUPVJ1qIKhRlAwO1AovA== + +"@webassemblyjs/helper-api-error@1.13.2": + version "1.13.2" + resolved "https://registry.yarnpkg.com/@webassemblyjs/helper-api-error/-/helper-api-error-1.13.2.tgz#e0a16152248bc38daee76dd7e21f15c5ef3ab1e7" + integrity sha512-U56GMYxy4ZQCbDZd6JuvvNV/WFildOjsaWD3Tzzvmw/mas3cXzRJPMjP83JqEsgSbyrmaGjBfDtV7KDXV9UzFQ== + +"@webassemblyjs/helper-buffer@1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/helper-buffer/-/helper-buffer-1.14.1.tgz#822a9bc603166531f7d5df84e67b5bf99b72b96b" + integrity sha512-jyH7wtcHiKssDtFPRB+iQdxlDf96m0E39yb0k5uJVhFGleZFoNw1c4aeIcVUPPbXUVJ94wwnMOAqUHyzoEPVMA== + +"@webassemblyjs/helper-numbers@1.13.2": + version "1.13.2" + resolved "https://registry.yarnpkg.com/@webassemblyjs/helper-numbers/-/helper-numbers-1.13.2.tgz#dbd932548e7119f4b8a7877fd5a8d20e63490b2d" + integrity sha512-FE8aCmS5Q6eQYcV3gI35O4J789wlQA+7JrqTTpJqn5emA4U2hvwJmvFRC0HODS+3Ye6WioDklgd6scJ3+PLnEA== + dependencies: + "@webassemblyjs/floating-point-hex-parser" "1.13.2" + "@webassemblyjs/helper-api-error" "1.13.2" + "@xtuc/long" "4.2.2" + +"@webassemblyjs/helper-wasm-bytecode@1.13.2": + version "1.13.2" + resolved "https://registry.yarnpkg.com/@webassemblyjs/helper-wasm-bytecode/-/helper-wasm-bytecode-1.13.2.tgz#e556108758f448aae84c850e593ce18a0eb31e0b" + integrity sha512-3QbLKy93F0EAIXLh0ogEVR6rOubA9AoZ+WRYhNbFyuB70j3dRdwH9g+qXhLAO0kiYGlg3TxDV+I4rQTr/YNXkA== + +"@webassemblyjs/helper-wasm-section@1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/helper-wasm-section/-/helper-wasm-section-1.14.1.tgz#9629dda9c4430eab54b591053d6dc6f3ba050348" + integrity sha512-ds5mXEqTJ6oxRoqjhWDU83OgzAYjwsCV8Lo/N+oRsNDmx/ZDpqalmrtgOMkHwxsG0iI//3BwWAErYRHtgn0dZw== + dependencies: + "@webassemblyjs/ast" "1.14.1" + "@webassemblyjs/helper-buffer" "1.14.1" + "@webassemblyjs/helper-wasm-bytecode" "1.13.2" + "@webassemblyjs/wasm-gen" "1.14.1" + +"@webassemblyjs/ieee754@1.13.2": + version "1.13.2" + resolved "https://registry.yarnpkg.com/@webassemblyjs/ieee754/-/ieee754-1.13.2.tgz#1c5eaace1d606ada2c7fd7045ea9356c59ee0dba" + integrity sha512-4LtOzh58S/5lX4ITKxnAK2USuNEvpdVV9AlgGQb8rJDHaLeHciwG4zlGr0j/SNWlr7x3vO1lDEsuePvtcDNCkw== + dependencies: + "@xtuc/ieee754" "^1.2.0" + +"@webassemblyjs/leb128@1.13.2": + version "1.13.2" + resolved "https://registry.yarnpkg.com/@webassemblyjs/leb128/-/leb128-1.13.2.tgz#57c5c3deb0105d02ce25fa3fd74f4ebc9fd0bbb0" + integrity sha512-Lde1oNoIdzVzdkNEAWZ1dZ5orIbff80YPdHx20mrHwHrVNNTjNr8E3xz9BdpcGqRQbAEa+fkrCb+fRFTl/6sQw== + dependencies: + "@xtuc/long" "4.2.2" + +"@webassemblyjs/utf8@1.13.2": + version "1.13.2" + resolved "https://registry.yarnpkg.com/@webassemblyjs/utf8/-/utf8-1.13.2.tgz#917a20e93f71ad5602966c2d685ae0c6c21f60f1" + integrity sha512-3NQWGjKTASY1xV5m7Hr0iPeXD9+RDobLll3T9d2AO+g3my8xy5peVyjSag4I50mR1bBSN/Ct12lo+R9tJk0NZQ== + +"@webassemblyjs/wasm-edit@^1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/wasm-edit/-/wasm-edit-1.14.1.tgz#ac6689f502219b59198ddec42dcd496b1004d597" + integrity sha512-RNJUIQH/J8iA/1NzlE4N7KtyZNHi3w7at7hDjvRNm5rcUXa00z1vRz3glZoULfJ5mpvYhLybmVcwcjGrC1pRrQ== + dependencies: + "@webassemblyjs/ast" "1.14.1" + "@webassemblyjs/helper-buffer" "1.14.1" + "@webassemblyjs/helper-wasm-bytecode" "1.13.2" + "@webassemblyjs/helper-wasm-section" "1.14.1" + "@webassemblyjs/wasm-gen" "1.14.1" + "@webassemblyjs/wasm-opt" "1.14.1" + "@webassemblyjs/wasm-parser" "1.14.1" + "@webassemblyjs/wast-printer" "1.14.1" + +"@webassemblyjs/wasm-gen@1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/wasm-gen/-/wasm-gen-1.14.1.tgz#991e7f0c090cb0bb62bbac882076e3d219da9570" + integrity sha512-AmomSIjP8ZbfGQhumkNvgC33AY7qtMCXnN6bL2u2Js4gVCg8fp735aEiMSBbDR7UQIj90n4wKAFUSEd0QN2Ukg== + dependencies: + "@webassemblyjs/ast" "1.14.1" + "@webassemblyjs/helper-wasm-bytecode" "1.13.2" + "@webassemblyjs/ieee754" "1.13.2" + "@webassemblyjs/leb128" "1.13.2" + "@webassemblyjs/utf8" "1.13.2" + +"@webassemblyjs/wasm-opt@1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/wasm-opt/-/wasm-opt-1.14.1.tgz#e6f71ed7ccae46781c206017d3c14c50efa8106b" + integrity sha512-PTcKLUNvBqnY2U6E5bdOQcSM+oVP/PmrDY9NzowJjislEjwP/C4an2303MCVS2Mg9d3AJpIGdUFIQQWbPds0Sw== + dependencies: + "@webassemblyjs/ast" "1.14.1" + "@webassemblyjs/helper-buffer" "1.14.1" + "@webassemblyjs/wasm-gen" "1.14.1" + "@webassemblyjs/wasm-parser" "1.14.1" + +"@webassemblyjs/wasm-parser@1.14.1", "@webassemblyjs/wasm-parser@^1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/wasm-parser/-/wasm-parser-1.14.1.tgz#b3e13f1893605ca78b52c68e54cf6a865f90b9fb" + integrity sha512-JLBl+KZ0R5qB7mCnud/yyX08jWFw5MsoalJ1pQ4EdFlgj9VdXKGuENGsiCIjegI1W7p91rUlcB/LB5yRJKNTcQ== + dependencies: + "@webassemblyjs/ast" "1.14.1" + "@webassemblyjs/helper-api-error" "1.13.2" + "@webassemblyjs/helper-wasm-bytecode" "1.13.2" + "@webassemblyjs/ieee754" "1.13.2" + "@webassemblyjs/leb128" "1.13.2" + "@webassemblyjs/utf8" "1.13.2" + +"@webassemblyjs/wast-printer@1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/wast-printer/-/wast-printer-1.14.1.tgz#3bb3e9638a8ae5fdaf9610e7a06b4d9f9aa6fe07" + integrity sha512-kPSSXE6De1XOR820C90RIo2ogvZG+c3KiHzqUoO/F34Y2shGzesfqv7o57xrxovZJH/MetF5UjroJ/R/3isoiw== + dependencies: + "@webassemblyjs/ast" "1.14.1" + "@xtuc/long" "4.2.2" + +"@xtuc/ieee754@^1.2.0": + version "1.2.0" + resolved "https://registry.yarnpkg.com/@xtuc/ieee754/-/ieee754-1.2.0.tgz#eef014a3145ae477a1cbc00cd1e552336dceb790" + integrity sha512-DX8nKgqcGwsc0eJSqYt5lwP4DH5FlHnmuWWBRy7X0NcaGR0ZtuyeESgMwTYVEtxmsNGY+qit4QYT/MIYTOTPeA== + +"@xtuc/long@4.2.2": + version "4.2.2" + resolved "https://registry.yarnpkg.com/@xtuc/long/-/long-4.2.2.tgz#d291c6a4e97989b5c61d9acf396ae4fe133a718d" + integrity sha512-NuHqBY1PB/D8xU6s/thBgOAiAP7HOYDQ32+BFZILJ8ivkUkAHQnWfn6WhL79Owj1qmUnoN/YPhktdIoucipkAQ== + +accepts@~1.3.4, accepts@~1.3.8: + version "1.3.8" + resolved "https://registry.yarnpkg.com/accepts/-/accepts-1.3.8.tgz#0bf0be125b67014adcb0b0921e62db7bffe16b2e" + integrity sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw== + dependencies: + mime-types "~2.1.34" + negotiator "0.6.3" + +acorn-import-phases@^1.0.3: + version "1.0.4" + resolved "https://registry.yarnpkg.com/acorn-import-phases/-/acorn-import-phases-1.0.4.tgz#16eb850ba99a056cb7cbfe872ffb8972e18c8bd7" + integrity sha512-wKmbr/DDiIXzEOiWrTTUcDm24kQ2vGfZQvM2fwg2vXqR5uW6aapr7ObPtj1th32b9u90/Pf4AItvdTh42fBmVQ== + +acorn-jsx@^5.0.0: + version "5.3.2" + resolved "https://registry.yarnpkg.com/acorn-jsx/-/acorn-jsx-5.3.2.tgz#7ed5bb55908b3b2f1bc55c6af1653bada7f07937" + integrity sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ== + +acorn-walk@^8.0.0: + version "8.3.4" + resolved "https://registry.yarnpkg.com/acorn-walk/-/acorn-walk-8.3.4.tgz#794dd169c3977edf4ba4ea47583587c5866236b7" + integrity sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g== + dependencies: + acorn "^8.11.0" + +acorn@^8.0.0, acorn@^8.0.4, acorn@^8.11.0, acorn@^8.15.0: + version "8.15.0" + resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.15.0.tgz#a360898bc415edaac46c8241f6383975b930b816" + integrity sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg== + +address@^1.0.1: + version "1.2.2" + resolved "https://registry.yarnpkg.com/address/-/address-1.2.2.tgz#2b5248dac5485a6390532c6a517fda2e3faac89e" + integrity sha512-4B/qKCfeE/ODUaAUpSwfzazo5x29WD4r3vXiWsB7I2mSDAihwEqKO+g8GELZUQSSAo5e1XTYh3ZVfLyxBc12nA== + +aggregate-error@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/aggregate-error/-/aggregate-error-3.1.0.tgz#92670ff50f5359bdb7a3e0d40d0ec30c5737687a" + integrity sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA== + dependencies: + clean-stack "^2.0.0" + indent-string "^4.0.0" + +ajv-formats@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/ajv-formats/-/ajv-formats-2.1.1.tgz#6e669400659eb74973bbf2e33327180a0996b520" + integrity sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA== + dependencies: + ajv "^8.0.0" + +ajv-keywords@^3.5.2: + version "3.5.2" + resolved "https://registry.yarnpkg.com/ajv-keywords/-/ajv-keywords-3.5.2.tgz#31f29da5ab6e00d1c2d329acf7b5929614d5014d" + integrity sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ== + +ajv-keywords@^5.1.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/ajv-keywords/-/ajv-keywords-5.1.0.tgz#69d4d385a4733cdbeab44964a1170a88f87f0e16" + integrity sha512-YCS/JNFAUyr5vAuhk1DWm1CBxRHW9LbJ2ozWeemrIqpbsqKjHVxYPyi5GC0rjZIT5JxJ3virVTS8wk4i/Z+krw== + dependencies: + fast-deep-equal "^3.1.3" + +ajv@^6.12.5: + version "6.12.6" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-6.12.6.tgz#baf5a62e802b07d977034586f8c3baf5adf26df4" + integrity sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g== + dependencies: + fast-deep-equal "^3.1.1" + fast-json-stable-stringify "^2.0.0" + json-schema-traverse "^0.4.1" + uri-js "^4.2.2" + +ajv@^8.0.0, ajv@^8.9.0: + version "8.17.1" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-8.17.1.tgz#37d9a5c776af6bc92d7f4f9510eba4c0a60d11a6" + integrity sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g== + dependencies: + fast-deep-equal "^3.1.3" + fast-uri "^3.0.1" + json-schema-traverse "^1.0.0" + require-from-string "^2.0.2" + +algoliasearch-helper@^3.22.6: + version "3.26.0" + resolved "https://registry.yarnpkg.com/algoliasearch-helper/-/algoliasearch-helper-3.26.0.tgz#d6e283396a9fc5bf944f365dc3b712570314363f" + integrity sha512-Rv2x3GXleQ3ygwhkhJubhhYGsICmShLAiqtUuJTUkr9uOCOXyF2E71LVT4XDnVffbknv8XgScP4U0Oxtgm+hIw== + dependencies: + "@algolia/events" "^4.0.1" + +algoliasearch@^5.14.2, algoliasearch@^5.17.1: + version "5.37.0" + resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-5.37.0.tgz#73dc4a09654e6e02b529300018d639706b95b47b" + integrity sha512-y7gau/ZOQDqoInTQp0IwTOjkrHc4Aq4R8JgpmCleFwiLl+PbN2DMWoDUWZnrK8AhNJwT++dn28Bt4NZYNLAmuA== + dependencies: + "@algolia/abtesting" "1.3.0" + "@algolia/client-abtesting" "5.37.0" + "@algolia/client-analytics" "5.37.0" + "@algolia/client-common" "5.37.0" + "@algolia/client-insights" "5.37.0" + "@algolia/client-personalization" "5.37.0" + "@algolia/client-query-suggestions" "5.37.0" + "@algolia/client-search" "5.37.0" + "@algolia/ingestion" "1.37.0" + "@algolia/monitoring" "1.37.0" + "@algolia/recommend" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +ansi-align@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/ansi-align/-/ansi-align-3.0.1.tgz#0cdf12e111ace773a86e9a1fad1225c43cb19a59" + integrity sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w== + dependencies: + string-width "^4.1.0" + +ansi-escapes@^4.3.2: + version "4.3.2" + resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-4.3.2.tgz#6b2291d1db7d98b6521d5f1efa42d0f3a9feb65e" + integrity sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ== + dependencies: + type-fest "^0.21.3" + +ansi-html-community@^0.0.8: + version "0.0.8" + resolved "https://registry.yarnpkg.com/ansi-html-community/-/ansi-html-community-0.0.8.tgz#69fbc4d6ccbe383f9736934ae34c3f8290f1bf41" + integrity sha512-1APHAyr3+PCamwNw3bXCPp4HFLONZt/yIH0sZp0/469KWNTEy+qN5jQ3GVX6DMZ1UXAi34yVwtTeaG/HpBuuzw== + +ansi-regex@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304" + integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ== + +ansi-regex@^6.0.1: + version "6.2.2" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.2.2.tgz#60216eea464d864597ce2832000738a0589650c1" + integrity sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg== + +ansi-styles@^4.0.0, ansi-styles@^4.1.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-4.3.0.tgz#edd803628ae71c04c85ae7a0906edad34b648937" + integrity sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg== + dependencies: + color-convert "^2.0.1" + +ansi-styles@^6.1.0: + version "6.2.3" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-6.2.3.tgz#c044d5dcc521a076413472597a1acb1f103c4041" + integrity sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg== + +anymatch@~3.1.2: + version "3.1.3" + resolved "https://registry.yarnpkg.com/anymatch/-/anymatch-3.1.3.tgz#790c58b19ba1720a84205b57c618d5ad8524973e" + integrity sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw== + dependencies: + normalize-path "^3.0.0" + picomatch "^2.0.4" + +arg@^5.0.0: + version "5.0.2" + resolved "https://registry.yarnpkg.com/arg/-/arg-5.0.2.tgz#c81433cc427c92c4dcf4865142dbca6f15acd59c" + integrity sha512-PYjyFOLKQ9y57JvQ6QLo8dAgNqswh8M1RMJYdQduT6xbWSgK36P/Z/v+p888pM69jMMfS8Xd8F6I1kQ/I9HUGg== + +argparse@^1.0.7: + version "1.0.10" + resolved "https://registry.yarnpkg.com/argparse/-/argparse-1.0.10.tgz#bcd6791ea5ae09725e17e5ad988134cd40b3d911" + integrity sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg== + dependencies: + sprintf-js "~1.0.2" + +argparse@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38" + integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q== + +array-flatten@1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/array-flatten/-/array-flatten-1.1.1.tgz#9a5f699051b1e7073328f2a008968b64ea2955d2" + integrity sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg== + +array-union@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/array-union/-/array-union-2.1.0.tgz#b798420adbeb1de828d84acd8a2e23d3efe85e8d" + integrity sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw== + +astring@^1.8.0: + version "1.9.0" + resolved "https://registry.yarnpkg.com/astring/-/astring-1.9.0.tgz#cc73e6062a7eb03e7d19c22d8b0b3451fd9bfeef" + integrity sha512-LElXdjswlqjWrPpJFg1Fx4wpkOCxj1TDHlSV4PlaRxHGWko024xICaa97ZkMfs6DRKlCguiAI+rbXv5GWwXIkg== + +autoprefixer@^10.4.19, autoprefixer@^10.4.21: + version "10.4.21" + resolved "https://registry.yarnpkg.com/autoprefixer/-/autoprefixer-10.4.21.tgz#77189468e7a8ad1d9a37fbc08efc9f480cf0a95d" + integrity sha512-O+A6LWV5LDHSJD3LjHYoNi4VLsj/Whi7k6zG12xTYaU4cQ8oxQGckXNX8cRHK5yOZ/ppVHe0ZBXGzSV9jXdVbQ== + dependencies: + browserslist "^4.24.4" + caniuse-lite "^1.0.30001702" + fraction.js "^4.3.7" + normalize-range "^0.1.2" + picocolors "^1.1.1" + postcss-value-parser "^4.2.0" + +babel-loader@^9.2.1: + version "9.2.1" + resolved "https://registry.yarnpkg.com/babel-loader/-/babel-loader-9.2.1.tgz#04c7835db16c246dd19ba0914418f3937797587b" + integrity sha512-fqe8naHt46e0yIdkjUZYqddSXfej3AHajX+CSO5X7oy0EmPc6o5Xh+RClNoHjnieWz9AW4kZxW9yyFMhVB1QLA== + dependencies: + find-cache-dir "^4.0.0" + schema-utils "^4.0.0" + +babel-plugin-dynamic-import-node@^2.3.3: + version "2.3.3" + resolved "https://registry.yarnpkg.com/babel-plugin-dynamic-import-node/-/babel-plugin-dynamic-import-node-2.3.3.tgz#84fda19c976ec5c6defef57f9427b3def66e17a3" + integrity sha512-jZVI+s9Zg3IqA/kdi0i6UDCybUI3aSBLnglhYbSSjKlV7yF1F/5LWv8MakQmvYpnbJDS6fcBL2KzHSxNCMtWSQ== + dependencies: + object.assign "^4.1.0" + +babel-plugin-macros@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/babel-plugin-macros/-/babel-plugin-macros-3.1.0.tgz#9ef6dc74deb934b4db344dc973ee851d148c50c1" + integrity sha512-Cg7TFGpIr01vOQNODXOOaGz2NpCU5gl8x1qJFbb6hbZxR7XrcE2vtbAsTAbJ7/xwJtUuJEw8K8Zr/AE0LHlesg== + dependencies: + "@babel/runtime" "^7.12.5" + cosmiconfig "^7.0.0" + resolve "^1.19.0" + +babel-plugin-polyfill-corejs2@^0.4.14: + version "0.4.14" + resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.14.tgz#8101b82b769c568835611542488d463395c2ef8f" + integrity sha512-Co2Y9wX854ts6U8gAAPXfn0GmAyctHuK8n0Yhfjd6t30g7yvKjspvvOo9yG+z52PZRgFErt7Ka2pYnXCjLKEpg== + dependencies: + "@babel/compat-data" "^7.27.7" + "@babel/helper-define-polyfill-provider" "^0.6.5" + semver "^6.3.1" + +babel-plugin-polyfill-corejs3@^0.13.0: + version "0.13.0" + resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.13.0.tgz#bb7f6aeef7addff17f7602a08a6d19a128c30164" + integrity sha512-U+GNwMdSFgzVmfhNm8GJUX88AadB3uo9KpJqS3FaqNIPKgySuvMb+bHPsOmmuWyIcuqZj/pzt1RUIUZns4y2+A== + dependencies: + "@babel/helper-define-polyfill-provider" "^0.6.5" + core-js-compat "^3.43.0" + +babel-plugin-polyfill-regenerator@^0.6.5: + version "0.6.5" + resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.5.tgz#32752e38ab6f6767b92650347bf26a31b16ae8c5" + integrity sha512-ISqQ2frbiNU9vIJkzg7dlPpznPZ4jOiUQ1uSmB0fEHeowtN3COYRsXr/xexn64NpU13P06jc/L5TgiJXOgrbEg== + dependencies: + "@babel/helper-define-polyfill-provider" "^0.6.5" + +bail@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/bail/-/bail-2.0.2.tgz#d26f5cd8fe5d6f832a31517b9f7c356040ba6d5d" + integrity sha512-0xO6mYd7JB2YesxDKplafRpsiOzPt9V02ddPCLbY1xYGPOX24NTyN50qnUxgCPcSoYMhKpAuBTjQoRZCAkUDRw== + +balanced-match@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" + integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== + +baseline-browser-mapping@^2.8.2: + version "2.8.4" + resolved "https://registry.yarnpkg.com/baseline-browser-mapping/-/baseline-browser-mapping-2.8.4.tgz#e553e12272c4965682743705efd8b4b4cf0d709b" + integrity sha512-L+YvJwGAgwJBV1p6ffpSTa2KRc69EeeYGYjRVWKs0GKrK+LON0GC0gV+rKSNtALEDvMDqkvCFq9r1r94/Gjwxw== + +batch@0.6.1: + version "0.6.1" + resolved "https://registry.yarnpkg.com/batch/-/batch-0.6.1.tgz#dc34314f4e679318093fc760272525f94bf25c16" + integrity sha512-x+VAiMRL6UPkx+kudNvxTl6hB2XNNCG2r+7wixVfIYwu/2HKRXimwQyaumLjMveWvT2Hkd/cAJw+QBMfJ/EKVw== + +big.js@^5.2.2: + version "5.2.2" + resolved "https://registry.yarnpkg.com/big.js/-/big.js-5.2.2.tgz#65f0af382f578bcdc742bd9c281e9cb2d7768328" + integrity sha512-vyL2OymJxmarO8gxMr0mhChsO9QGwhynfuu4+MHTAW6czfq9humCB7rKpUjDd9YUiDPU4mzpyupFSvOClAwbmQ== + +binary-extensions@^2.0.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/binary-extensions/-/binary-extensions-2.3.0.tgz#f6e14a97858d327252200242d4ccfe522c445522" + integrity sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw== + +body-parser@1.20.3: + version "1.20.3" + resolved "https://registry.yarnpkg.com/body-parser/-/body-parser-1.20.3.tgz#1953431221c6fb5cd63c4b36d53fab0928e548c6" + integrity sha512-7rAxByjUMqQ3/bHJy7D6OGXvx/MMc4IqBn/X0fcM1QUcAItpZrBEYhWGem+tzXH90c+G01ypMcYJBO9Y30203g== + dependencies: + bytes "3.1.2" + content-type "~1.0.5" + debug "2.6.9" + depd "2.0.0" + destroy "1.2.0" + http-errors "2.0.0" + iconv-lite "0.4.24" + on-finished "2.4.1" + qs "6.13.0" + raw-body "2.5.2" + type-is "~1.6.18" + unpipe "1.0.0" + +bonjour-service@^1.0.11: + version "1.3.0" + resolved "https://registry.yarnpkg.com/bonjour-service/-/bonjour-service-1.3.0.tgz#80d867430b5a0da64e82a8047fc1e355bdb71722" + integrity sha512-3YuAUiSkWykd+2Azjgyxei8OWf8thdn8AITIog2M4UICzoqfjlqr64WIjEXZllf/W6vK1goqleSR6brGomxQqA== + dependencies: + fast-deep-equal "^3.1.3" + multicast-dns "^7.2.5" + +boolbase@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/boolbase/-/boolbase-1.0.0.tgz#68dff5fbe60c51eb37725ea9e3ed310dcc1e776e" + integrity sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww== + +boxen@^6.2.1: + version "6.2.1" + resolved "https://registry.yarnpkg.com/boxen/-/boxen-6.2.1.tgz#b098a2278b2cd2845deef2dff2efc38d329b434d" + integrity sha512-H4PEsJXfFI/Pt8sjDWbHlQPx4zL/bvSQjcilJmaulGt5mLDorHOHpmdXAJcBcmru7PhYSp/cDMWRko4ZUMFkSw== + dependencies: + ansi-align "^3.0.1" + camelcase "^6.2.0" + chalk "^4.1.2" + cli-boxes "^3.0.0" + string-width "^5.0.1" + type-fest "^2.5.0" + widest-line "^4.0.1" + wrap-ansi "^8.0.1" + +boxen@^7.0.0: + version "7.1.1" + resolved "https://registry.yarnpkg.com/boxen/-/boxen-7.1.1.tgz#f9ba525413c2fec9cdb88987d835c4f7cad9c8f4" + integrity sha512-2hCgjEmP8YLWQ130n2FerGv7rYpfBmnmp9Uy2Le1vge6X3gZIfSmEzP5QTDElFxcvVcXlEn8Aq6MU/PZygIOog== + dependencies: + ansi-align "^3.0.1" + camelcase "^7.0.1" + chalk "^5.2.0" + cli-boxes "^3.0.0" + string-width "^5.1.2" + type-fest "^2.13.0" + widest-line "^4.0.1" + wrap-ansi "^8.1.0" + +brace-expansion@^1.1.7: + version "1.1.12" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.12.tgz#ab9b454466e5a8cc3a187beaad580412a9c5b843" + integrity sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg== + dependencies: + balanced-match "^1.0.0" + concat-map "0.0.1" + +braces@^3.0.3, braces@~3.0.2: + version "3.0.3" + resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.3.tgz#490332f40919452272d55a8480adc0c441358789" + integrity sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA== + dependencies: + fill-range "^7.1.1" + +browserslist@^4.0.0, browserslist@^4.23.0, browserslist@^4.24.0, browserslist@^4.24.4, browserslist@^4.25.1, browserslist@^4.25.3: + version "4.26.0" + resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.26.0.tgz#035ca84b4ff312a3c6a7014a77beb83456a882dd" + integrity sha512-P9go2WrP9FiPwLv3zqRD/Uoxo0RSHjzFCiQz7d4vbmwNqQFo9T9WCeP/Qn5EbcKQY6DBbkxEXNcpJOmncNrb7A== + dependencies: + baseline-browser-mapping "^2.8.2" + caniuse-lite "^1.0.30001741" + electron-to-chromium "^1.5.218" + node-releases "^2.0.21" + update-browserslist-db "^1.1.3" + +buffer-from@^1.0.0: + version "1.1.2" + resolved "https://registry.yarnpkg.com/buffer-from/-/buffer-from-1.1.2.tgz#2b146a6fd72e80b4f55d255f35ed59a3a9a41bd5" + integrity sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ== + +bytes@3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/bytes/-/bytes-3.0.0.tgz#d32815404d689699f85a4ea4fa8755dd13a96048" + integrity sha512-pMhOfFDPiv9t5jjIXkHosWmkSyQbvsgEVNkz0ERHbuLh2T/7j4Mqqpz523Fe8MVY89KC6Sh/QfS2sM+SjgFDcw== + +bytes@3.1.2: + version "3.1.2" + resolved "https://registry.yarnpkg.com/bytes/-/bytes-3.1.2.tgz#8b0beeb98605adf1b128fa4386403c009e0221a5" + integrity sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg== + +cacheable-lookup@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/cacheable-lookup/-/cacheable-lookup-7.0.0.tgz#3476a8215d046e5a3202a9209dd13fec1f933a27" + integrity sha512-+qJyx4xiKra8mZrcwhjMRMUhD5NR1R8esPkzIYxX96JiecFoxAXFuz/GpR3+ev4PE1WamHip78wV0vcmPQtp8w== + +cacheable-request@^10.2.8: + version "10.2.14" + resolved "https://registry.yarnpkg.com/cacheable-request/-/cacheable-request-10.2.14.tgz#eb915b665fda41b79652782df3f553449c406b9d" + integrity sha512-zkDT5WAF4hSSoUgyfg5tFIxz8XQK+25W/TLVojJTMKBaxevLBBtLxgqguAuVQB8PVW79FVjHcU+GJ9tVbDZ9mQ== + dependencies: + "@types/http-cache-semantics" "^4.0.2" + get-stream "^6.0.1" + http-cache-semantics "^4.1.1" + keyv "^4.5.3" + mimic-response "^4.0.0" + normalize-url "^8.0.0" + responselike "^3.0.0" + +call-bind-apply-helpers@^1.0.0, call-bind-apply-helpers@^1.0.1, call-bind-apply-helpers@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz#4b5428c222be985d79c3d82657479dbe0b59b2d6" + integrity sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ== + dependencies: + es-errors "^1.3.0" + function-bind "^1.1.2" + +call-bind@^1.0.8: + version "1.0.8" + resolved "https://registry.yarnpkg.com/call-bind/-/call-bind-1.0.8.tgz#0736a9660f537e3388826f440d5ec45f744eaa4c" + integrity sha512-oKlSFMcMwpUg2ednkhQ454wfWiU/ul3CkJe/PEHcTKuiX6RpbehUiFMXu13HalGZxfUwCQzZG747YXBn1im9ww== + dependencies: + call-bind-apply-helpers "^1.0.0" + es-define-property "^1.0.0" + get-intrinsic "^1.2.4" + set-function-length "^1.2.2" + +call-bound@^1.0.2, call-bound@^1.0.3: + version "1.0.4" + resolved "https://registry.yarnpkg.com/call-bound/-/call-bound-1.0.4.tgz#238de935d2a2a692928c538c7ccfa91067fd062a" + integrity sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg== + dependencies: + call-bind-apply-helpers "^1.0.2" + get-intrinsic "^1.3.0" + +callsites@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/callsites/-/callsites-3.1.0.tgz#b3630abd8943432f54b3f0519238e33cd7df2f73" + integrity sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ== + +camel-case@^4.1.2: + version "4.1.2" + resolved "https://registry.yarnpkg.com/camel-case/-/camel-case-4.1.2.tgz#9728072a954f805228225a6deea6b38461e1bd5a" + integrity sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw== + dependencies: + pascal-case "^3.1.2" + tslib "^2.0.3" + +camelcase@^6.2.0: + version "6.3.0" + resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-6.3.0.tgz#5685b95eb209ac9c0c177467778c9c84df58ba9a" + integrity sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA== + +camelcase@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-7.0.1.tgz#f02e50af9fd7782bc8b88a3558c32fd3a388f048" + integrity sha512-xlx1yCK2Oc1APsPXDL2LdlNP6+uu8OCDdhOBSVT279M/S+y75O30C2VuD8T2ogdePBBl7PfPF4504tnLgX3zfw== + +caniuse-api@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/caniuse-api/-/caniuse-api-3.0.0.tgz#5e4d90e2274961d46291997df599e3ed008ee4c0" + integrity sha512-bsTwuIg/BZZK/vreVTYYbSWoe2F+71P7K5QGEX+pT250DZbfU1MQ5prOKpPR+LL6uWKK3KMwMCAS74QB3Um1uw== + dependencies: + browserslist "^4.0.0" + caniuse-lite "^1.0.0" + lodash.memoize "^4.1.2" + lodash.uniq "^4.5.0" + +caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001702, caniuse-lite@^1.0.30001741: + version "1.0.30001741" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001741.tgz#67fb92953edc536442f3c9da74320774aa523143" + integrity sha512-QGUGitqsc8ARjLdgAfxETDhRbJ0REsP6O3I96TAth/mVjh2cYzN2u+3AzPP3aVSm2FehEItaJw1xd+IGBXWeSw== + +ccount@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/ccount/-/ccount-2.0.1.tgz#17a3bf82302e0870d6da43a01311a8bc02a3ecf5" + integrity sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg== + +chalk@^4.0.0, chalk@^4.1.2: + version "4.1.2" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.2.tgz#aac4e2b7734a740867aeb16bf02aad556a1e7a01" + integrity sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA== + dependencies: + ansi-styles "^4.1.0" + supports-color "^7.1.0" + +chalk@^5.0.1, chalk@^5.2.0: + version "5.6.2" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-5.6.2.tgz#b1238b6e23ea337af71c7f8a295db5af0c158aea" + integrity sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA== + +char-regex@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/char-regex/-/char-regex-1.0.2.tgz#d744358226217f981ed58f479b1d6bcc29545dcf" + integrity sha512-kWWXztvZ5SBQV+eRgKFeh8q5sLuZY2+8WUIzlxWVTg+oGwY14qylx1KbKzHd8P6ZYkAg0xyIDU9JMHhyJMZ1jw== + +character-entities-html4@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/character-entities-html4/-/character-entities-html4-2.1.0.tgz#1f1adb940c971a4b22ba39ddca6b618dc6e56b2b" + integrity sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA== + +character-entities-legacy@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/character-entities-legacy/-/character-entities-legacy-3.0.0.tgz#76bc83a90738901d7bc223a9e93759fdd560125b" + integrity sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ== + +character-entities@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/character-entities/-/character-entities-2.0.2.tgz#2d09c2e72cd9523076ccb21157dff66ad43fcc22" + integrity sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ== + +character-reference-invalid@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/character-reference-invalid/-/character-reference-invalid-2.0.1.tgz#85c66b041e43b47210faf401278abf808ac45cb9" + integrity sha512-iBZ4F4wRbyORVsu0jPV7gXkOsGYjGHPmAyv+HiHG8gi5PtC9KI2j1+v8/tlibRvjoWX027ypmG/n0HtO5t7unw== + +cheerio-select@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/cheerio-select/-/cheerio-select-2.1.0.tgz#4d8673286b8126ca2a8e42740d5e3c4884ae21b4" + integrity sha512-9v9kG0LvzrlcungtnJtpGNxY+fzECQKhK4EGJX2vByejiMX84MFNQw4UxPJl3bFbTMw+Dfs37XaIkCwTZfLh4g== + dependencies: + boolbase "^1.0.0" + css-select "^5.1.0" + css-what "^6.1.0" + domelementtype "^2.3.0" + domhandler "^5.0.3" + domutils "^3.0.1" + +cheerio@1.0.0-rc.12: + version "1.0.0-rc.12" + resolved "https://registry.yarnpkg.com/cheerio/-/cheerio-1.0.0-rc.12.tgz#788bf7466506b1c6bf5fae51d24a2c4d62e47683" + integrity sha512-VqR8m68vM46BNnuZ5NtnGBKIE/DfN0cRIzg9n40EIq9NOv90ayxLBXA8fXC5gquFRGJSTRqBq25Jt2ECLR431Q== + dependencies: + cheerio-select "^2.1.0" + dom-serializer "^2.0.0" + domhandler "^5.0.3" + domutils "^3.0.1" + htmlparser2 "^8.0.1" + parse5 "^7.0.0" + parse5-htmlparser2-tree-adapter "^7.0.0" + +chokidar@^3.5.3: + version "3.6.0" + resolved "https://registry.yarnpkg.com/chokidar/-/chokidar-3.6.0.tgz#197c6cc669ef2a8dc5e7b4d97ee4e092c3eb0d5b" + integrity sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw== + dependencies: + anymatch "~3.1.2" + braces "~3.0.2" + glob-parent "~5.1.2" + is-binary-path "~2.1.0" + is-glob "~4.0.1" + normalize-path "~3.0.0" + readdirp "~3.6.0" + optionalDependencies: + fsevents "~2.3.2" + +chrome-trace-event@^1.0.2: + version "1.0.4" + resolved "https://registry.yarnpkg.com/chrome-trace-event/-/chrome-trace-event-1.0.4.tgz#05bffd7ff928465093314708c93bdfa9bd1f0f5b" + integrity sha512-rNjApaLzuwaOTjCiT8lSDdGN1APCiqkChLMJxJPWLunPAt5fy8xgU9/jNOchV84wfIxrA0lRQB7oCT8jrn/wrQ== + +ci-info@^3.2.0: + version "3.9.0" + resolved "https://registry.yarnpkg.com/ci-info/-/ci-info-3.9.0.tgz#4279a62028a7b1f262f3473fc9605f5e218c59b4" + integrity sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ== + +clean-css@^5.2.2, clean-css@^5.3.3, clean-css@~5.3.2: + version "5.3.3" + resolved "https://registry.yarnpkg.com/clean-css/-/clean-css-5.3.3.tgz#b330653cd3bd6b75009cc25c714cae7b93351ccd" + integrity sha512-D5J+kHaVb/wKSFcyyV75uCn8fiY4sV38XJoe4CUyGQ+mOU/fMVYUdH1hJC+CJQ5uY3EnW27SbJYS4X8BiLrAFg== + dependencies: + source-map "~0.6.0" + +clean-stack@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/clean-stack/-/clean-stack-2.2.0.tgz#ee8472dbb129e727b31e8a10a427dee9dfe4008b" + integrity sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A== + +cli-boxes@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/cli-boxes/-/cli-boxes-3.0.0.tgz#71a10c716feeba005e4504f36329ef0b17cf3145" + integrity sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g== + +cli-table3@^0.6.3: + version "0.6.5" + resolved "https://registry.yarnpkg.com/cli-table3/-/cli-table3-0.6.5.tgz#013b91351762739c16a9567c21a04632e449bf2f" + integrity sha512-+W/5efTR7y5HRD7gACw9yQjqMVvEMLBHmboM/kPWam+H+Hmyrgjh6YncVKK122YZkXrLudzTuAukUw9FnMf7IQ== + dependencies: + string-width "^4.2.0" + optionalDependencies: + "@colors/colors" "1.5.0" + +clipboard@^2.0.11: + version "2.0.11" + resolved "https://registry.yarnpkg.com/clipboard/-/clipboard-2.0.11.tgz#62180360b97dd668b6b3a84ec226975762a70be5" + integrity sha512-C+0bbOqkezLIsmWSvlsXS0Q0bmkugu7jcfMIACB+RDEntIzQIkdr148we28AfSloQLRdZlYL/QYyrq05j/3Faw== + dependencies: + good-listener "^1.2.2" + select "^1.1.2" + tiny-emitter "^2.0.0" + +clone-deep@^4.0.1: + version "4.0.1" + resolved "https://registry.yarnpkg.com/clone-deep/-/clone-deep-4.0.1.tgz#c19fd9bdbbf85942b4fd979c84dcf7d5f07c2387" + integrity sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ== + dependencies: + is-plain-object "^2.0.4" + kind-of "^6.0.2" + shallow-clone "^3.0.0" + +clsx@^2.0.0, clsx@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/clsx/-/clsx-2.1.1.tgz#eed397c9fd8bd882bfb18deab7102049a2f32999" + integrity sha512-eYm0QWBtUrBWZWG0d386OGAw16Z995PiOVo2B7bjWSbHedGl5e0ZWaq65kOGgUSNesEIDkB9ISbTg/JK9dhCZA== + +collapse-white-space@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/collapse-white-space/-/collapse-white-space-2.1.0.tgz#640257174f9f42c740b40f3b55ee752924feefca" + integrity sha512-loKTxY1zCOuG4j9f6EPnuyyYkf58RnhhWTvRoZEokgB+WbdXehfjFviyOVYkqzEWz1Q5kRiZdBYS5SwxbQYwzw== + +color-convert@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-2.0.1.tgz#72d3a68d598c9bdb3af2ad1e84f21d896abd4de3" + integrity sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ== + dependencies: + color-name "~1.1.4" + +color-name@~1.1.4: + version "1.1.4" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2" + integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== + +colord@^2.9.3: + version "2.9.3" + resolved "https://registry.yarnpkg.com/colord/-/colord-2.9.3.tgz#4f8ce919de456f1d5c1c368c307fe20f3e59fb43" + integrity sha512-jeC1axXpnb0/2nn/Y1LPuLdgXBLH7aDcHu4KEKfqw3CUhX7ZpfBSlPKyqXE6btIgEzfWtrX3/tyBCaCvXvMkOw== + +colorette@^2.0.10: + version "2.0.20" + resolved "https://registry.yarnpkg.com/colorette/-/colorette-2.0.20.tgz#9eb793e6833067f7235902fcd3b09917a000a95a" + integrity sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w== + +combine-promises@^1.1.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/combine-promises/-/combine-promises-1.2.0.tgz#5f2e68451862acf85761ded4d9e2af7769c2ca6a" + integrity sha512-VcQB1ziGD0NXrhKxiwyNbCDmRzs/OShMs2GqW2DlU2A/Sd0nQxE1oWDAE5O0ygSx5mgQOn9eIFh7yKPgFRVkPQ== + +comma-separated-tokens@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/comma-separated-tokens/-/comma-separated-tokens-2.0.3.tgz#4e89c9458acb61bc8fef19f4529973b2392839ee" + integrity sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg== + +commander@^10.0.0: + version "10.0.1" + resolved "https://registry.yarnpkg.com/commander/-/commander-10.0.1.tgz#881ee46b4f77d1c1dccc5823433aa39b022cbe06" + integrity sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug== + +commander@^2.20.0: + version "2.20.3" + resolved "https://registry.yarnpkg.com/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33" + integrity sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ== + +commander@^5.1.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/commander/-/commander-5.1.0.tgz#46abbd1652f8e059bddaef99bbdcb2ad9cf179ae" + integrity sha512-P0CysNDQ7rtVw4QIQtm+MRxV66vKFSvlsQvGYXZWR3qFU0jlMKHZZZgw8e+8DSah4UDKMqnknRDQz+xuQXQ/Zg== + +commander@^7.2.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/commander/-/commander-7.2.0.tgz#a36cb57d0b501ce108e4d20559a150a391d97ab7" + integrity sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw== + +commander@^8.3.0: + version "8.3.0" + resolved "https://registry.yarnpkg.com/commander/-/commander-8.3.0.tgz#4837ea1b2da67b9c616a67afbb0fafee567bca66" + integrity sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww== + +common-path-prefix@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/common-path-prefix/-/common-path-prefix-3.0.0.tgz#7d007a7e07c58c4b4d5f433131a19141b29f11e0" + integrity sha512-QE33hToZseCH3jS0qN96O/bSh3kaw/h+Tq7ngyY9eWDUnTlTNUyqfqvCXioLe5Na5jFsL78ra/wuBU4iuEgd4w== + +compressible@~2.0.18: + version "2.0.18" + resolved "https://registry.yarnpkg.com/compressible/-/compressible-2.0.18.tgz#af53cca6b070d4c3c0750fbd77286a6d7cc46fba" + integrity sha512-AF3r7P5dWxL8MxyITRMlORQNaOA2IkAFaTr4k7BUumjPtRpGDTZpl0Pb1XCO6JeDCBdp126Cgs9sMxqSjgYyRg== + dependencies: + mime-db ">= 1.43.0 < 2" + +compression@^1.7.4: + version "1.8.1" + resolved "https://registry.yarnpkg.com/compression/-/compression-1.8.1.tgz#4a45d909ac16509195a9a28bd91094889c180d79" + integrity sha512-9mAqGPHLakhCLeNyxPkK4xVo746zQ/czLH1Ky+vkitMnWfWZps8r0qXuwhwizagCRttsL4lfG4pIOvaWLpAP0w== + dependencies: + bytes "3.1.2" + compressible "~2.0.18" + debug "2.6.9" + negotiator "~0.6.4" + on-headers "~1.1.0" + safe-buffer "5.2.1" + vary "~1.1.2" + +concat-map@0.0.1: + version "0.0.1" + resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b" + integrity sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg== + +config-chain@^1.1.11: + version "1.1.13" + resolved "https://registry.yarnpkg.com/config-chain/-/config-chain-1.1.13.tgz#fad0795aa6a6cdaff9ed1b68e9dff94372c232f4" + integrity sha512-qj+f8APARXHrM0hraqXYb2/bOVSV4PvJQlNZ/DVj0QrmNM2q2euizkeuVckQ57J+W0mRH6Hvi+k50M4Jul2VRQ== + dependencies: + ini "^1.3.4" + proto-list "~1.2.1" + +configstore@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/configstore/-/configstore-6.0.0.tgz#49eca2ebc80983f77e09394a1a56e0aca8235566" + integrity sha512-cD31W1v3GqUlQvbBCGcXmd2Nj9SvLDOP1oQ0YFuLETufzSPaKp11rYBsSOm7rCsW3OnIRAFM3OxRhceaXNYHkA== + dependencies: + dot-prop "^6.0.1" + graceful-fs "^4.2.6" + unique-string "^3.0.0" + write-file-atomic "^3.0.3" + xdg-basedir "^5.0.1" + +connect-history-api-fallback@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/connect-history-api-fallback/-/connect-history-api-fallback-2.0.0.tgz#647264845251a0daf25b97ce87834cace0f5f1c8" + integrity sha512-U73+6lQFmfiNPrYbXqr6kZ1i1wiRqXnp2nhMsINseWXO8lDau0LGEffJ8kQi4EjLZympVgRdvqjAgiZ1tgzDDA== + +consola@^3.2.3: + version "3.4.2" + resolved "https://registry.yarnpkg.com/consola/-/consola-3.4.2.tgz#5af110145397bb67afdab77013fdc34cae590ea7" + integrity sha512-5IKcdX0nnYavi6G7TtOhwkYzyjfJlatbjMjuLSfE2kYT5pMDOilZ4OvMhi637CcDICTmz3wARPoyhqyX1Y+XvA== + +content-disposition@0.5.2: + version "0.5.2" + resolved "https://registry.yarnpkg.com/content-disposition/-/content-disposition-0.5.2.tgz#0cf68bb9ddf5f2be7961c3a85178cb85dba78cb4" + integrity sha512-kRGRZw3bLlFISDBgwTSA1TMBFN6J6GWDeubmDE3AF+3+yXL8hTWv8r5rkLbqYXY4RjPk/EzHnClI3zQf1cFmHA== + +content-disposition@0.5.4: + version "0.5.4" + resolved "https://registry.yarnpkg.com/content-disposition/-/content-disposition-0.5.4.tgz#8b82b4efac82512a02bb0b1dcec9d2c5e8eb5bfe" + integrity sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ== + dependencies: + safe-buffer "5.2.1" + +content-type@~1.0.4, content-type@~1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/content-type/-/content-type-1.0.5.tgz#8b773162656d1d1086784c8f23a54ce6d73d7918" + integrity sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA== + +convert-source-map@^1.5.0: + version "1.9.0" + resolved "https://registry.yarnpkg.com/convert-source-map/-/convert-source-map-1.9.0.tgz#7faae62353fb4213366d0ca98358d22e8368b05f" + integrity sha512-ASFBup0Mz1uyiIjANan1jzLQami9z1PoYSZCiiYW2FczPbenXc45FZdBZLzOT+r6+iciuEModtmCti+hjaAk0A== + +convert-source-map@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/convert-source-map/-/convert-source-map-2.0.0.tgz#4b560f649fc4e918dd0ab75cf4961e8bc882d82a" + integrity sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg== + +cookie-signature@1.0.6: + version "1.0.6" + resolved "https://registry.yarnpkg.com/cookie-signature/-/cookie-signature-1.0.6.tgz#e303a882b342cc3ee8ca513a79999734dab3ae2c" + integrity sha512-QADzlaHc8icV8I7vbaJXJwod9HWYp8uCqf1xa4OfNu1T7JVxQIrUgOWtHdNDtPiywmFbiS12VjotIXLrKM3orQ== + +cookie@0.7.1: + version "0.7.1" + resolved "https://registry.yarnpkg.com/cookie/-/cookie-0.7.1.tgz#2f73c42142d5d5cf71310a74fc4ae61670e5dbc9" + integrity sha512-6DnInpx7SJ2AK3+CTUE/ZM0vWTUboZCegxhC2xiIydHR9jNuTAASBrfEpHhiGOZw/nX51bHt6YQl8jsGo4y/0w== + +copy-text-to-clipboard@^3.2.0: + version "3.2.1" + resolved "https://registry.yarnpkg.com/copy-text-to-clipboard/-/copy-text-to-clipboard-3.2.1.tgz#01c3656d6c81a6aa713aa0a8d361214a1eeac6ae" + integrity sha512-3am6cw+WOicd0+HyzhC4kYS02wHJUiVQXmAADxfUARKsHBkWl1Vl3QQEiILlSs8YcPS/C0+y/urCNEYQk+byWA== + +copy-webpack-plugin@^11.0.0: + version "11.0.0" + resolved "https://registry.yarnpkg.com/copy-webpack-plugin/-/copy-webpack-plugin-11.0.0.tgz#96d4dbdb5f73d02dd72d0528d1958721ab72e04a" + integrity sha512-fX2MWpamkW0hZxMEg0+mYnA40LTosOSa5TqZ9GYIBzyJa9C3QUaMPSE2xAi/buNr8u89SfD9wHSQVBzrRa/SOQ== + dependencies: + fast-glob "^3.2.11" + glob-parent "^6.0.1" + globby "^13.1.1" + normalize-path "^3.0.0" + schema-utils "^4.0.0" + serialize-javascript "^6.0.0" + +core-js-compat@^3.43.0: + version "3.45.1" + resolved "https://registry.yarnpkg.com/core-js-compat/-/core-js-compat-3.45.1.tgz#424f3f4af30bf676fd1b67a579465104f64e9c7a" + integrity sha512-tqTt5T4PzsMIZ430XGviK4vzYSoeNJ6CXODi6c/voxOT6IZqBht5/EKaSNnYiEjjRYxjVz7DQIsOsY0XNi8PIA== + dependencies: + browserslist "^4.25.3" + +core-js-pure@^3.43.0: + version "3.45.1" + resolved "https://registry.yarnpkg.com/core-js-pure/-/core-js-pure-3.45.1.tgz#b129d86a5f7f8380378577c7eaee83608570a05a" + integrity sha512-OHnWFKgTUshEU8MK+lOs1H8kC8GkTi9Z1tvNkxrCcw9wl3MJIO7q2ld77wjWn4/xuGrVu2X+nME1iIIPBSdyEQ== + +core-js@^3.31.1: + version "3.45.1" + resolved "https://registry.yarnpkg.com/core-js/-/core-js-3.45.1.tgz#5810e04a1b4e9bc5ddaa4dd12e702ff67300634d" + integrity sha512-L4NPsJlCfZsPeXukyzHFlg/i7IIVwHSItR0wg0FLNqYClJ4MQYTYLbC7EkjKYRLZF2iof2MUgN0EGy7MdQFChg== + +core-util-is@~1.0.0: + version "1.0.3" + resolved "https://registry.yarnpkg.com/core-util-is/-/core-util-is-1.0.3.tgz#a6042d3634c2b27e9328f837b965fac83808db85" + integrity sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ== + +cosmiconfig@^7.0.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/cosmiconfig/-/cosmiconfig-7.1.0.tgz#1443b9afa596b670082ea46cbd8f6a62b84635f6" + integrity sha512-AdmX6xUzdNASswsFtmwSt7Vj8po9IuqXm0UXz7QKPuEUmPB4XyjGfaAr2PSuELMwkRMVH1EpIkX5bTZGRB3eCA== + dependencies: + "@types/parse-json" "^4.0.0" + import-fresh "^3.2.1" + parse-json "^5.0.0" + path-type "^4.0.0" + yaml "^1.10.0" + +cosmiconfig@^8.1.3, cosmiconfig@^8.3.5: + version "8.3.6" + resolved "https://registry.yarnpkg.com/cosmiconfig/-/cosmiconfig-8.3.6.tgz#060a2b871d66dba6c8538ea1118ba1ac16f5fae3" + integrity sha512-kcZ6+W5QzcJ3P1Mt+83OUv/oHFqZHIx8DuxG6eZ5RGMERoLqp4BuGjhHLYGK+Kf5XVkQvqBSmAy/nGWN3qDgEA== + dependencies: + import-fresh "^3.3.0" + js-yaml "^4.1.0" + parse-json "^5.2.0" + path-type "^4.0.0" + +cross-spawn@^7.0.3: + version "7.0.6" + resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.6.tgz#8a58fe78f00dcd70c370451759dfbfaf03e8ee9f" + integrity sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA== + dependencies: + path-key "^3.1.0" + shebang-command "^2.0.0" + which "^2.0.1" + +crypto-random-string@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/crypto-random-string/-/crypto-random-string-4.0.0.tgz#5a3cc53d7dd86183df5da0312816ceeeb5bb1fc2" + integrity sha512-x8dy3RnvYdlUcPOjkEHqozhiwzKNSq7GcPuXFbnyMOCHxX8V3OgIg/pYuabl2sbUPfIJaeAQB7PMOK8DFIdoRA== + dependencies: + type-fest "^1.0.1" + +css-blank-pseudo@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/css-blank-pseudo/-/css-blank-pseudo-7.0.1.tgz#32020bff20a209a53ad71b8675852b49e8d57e46" + integrity sha512-jf+twWGDf6LDoXDUode+nc7ZlrqfaNphrBIBrcmeP3D8yw1uPaix1gCC8LUQUGQ6CycuK2opkbFFWFuq/a94ag== + dependencies: + postcss-selector-parser "^7.0.0" + +css-declaration-sorter@^7.2.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/css-declaration-sorter/-/css-declaration-sorter-7.2.0.tgz#6dec1c9523bc4a643e088aab8f09e67a54961024" + integrity sha512-h70rUM+3PNFuaBDTLe8wF/cdWu+dOZmb7pJt8Z2sedYbAcQVQV/tEchueg3GWxwqS0cxtbxmaHEdkNACqcvsow== + +css-has-pseudo@^7.0.3: + version "7.0.3" + resolved "https://registry.yarnpkg.com/css-has-pseudo/-/css-has-pseudo-7.0.3.tgz#a5ee2daf5f70a2032f3cefdf1e36e7f52a243873" + integrity sha512-oG+vKuGyqe/xvEMoxAQrhi7uY16deJR3i7wwhBerVrGQKSqUC5GiOVxTpM9F9B9hw0J+eKeOWLH7E9gZ1Dr5rA== + dependencies: + "@csstools/selector-specificity" "^5.0.0" + postcss-selector-parser "^7.0.0" + postcss-value-parser "^4.2.0" + +css-loader@^6.11.0: + version "6.11.0" + resolved "https://registry.yarnpkg.com/css-loader/-/css-loader-6.11.0.tgz#33bae3bf6363d0a7c2cf9031c96c744ff54d85ba" + integrity sha512-CTJ+AEQJjq5NzLga5pE39qdiSV56F8ywCIsqNIRF0r7BDgWsN25aazToqAFg7ZrtA/U016xudB3ffgweORxX7g== + dependencies: + icss-utils "^5.1.0" + postcss "^8.4.33" + postcss-modules-extract-imports "^3.1.0" + postcss-modules-local-by-default "^4.0.5" + postcss-modules-scope "^3.2.0" + postcss-modules-values "^4.0.0" + postcss-value-parser "^4.2.0" + semver "^7.5.4" + +css-minimizer-webpack-plugin@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/css-minimizer-webpack-plugin/-/css-minimizer-webpack-plugin-5.0.1.tgz#33effe662edb1a0bf08ad633c32fa75d0f7ec565" + integrity sha512-3caImjKFQkS+ws1TGcFn0V1HyDJFq1Euy589JlD6/3rV2kj+w7r5G9WDMgSHvpvXHNZ2calVypZWuEDQd9wfLg== + dependencies: + "@jridgewell/trace-mapping" "^0.3.18" + cssnano "^6.0.1" + jest-worker "^29.4.3" + postcss "^8.4.24" + schema-utils "^4.0.1" + serialize-javascript "^6.0.1" + +css-prefers-color-scheme@^10.0.0: + version "10.0.0" + resolved "https://registry.yarnpkg.com/css-prefers-color-scheme/-/css-prefers-color-scheme-10.0.0.tgz#ba001b99b8105b8896ca26fc38309ddb2278bd3c" + integrity sha512-VCtXZAWivRglTZditUfB4StnsWr6YVZ2PRtuxQLKTNRdtAf8tpzaVPE9zXIF3VaSc7O70iK/j1+NXxyQCqdPjQ== + +css-select@^4.1.3: + version "4.3.0" + resolved "https://registry.yarnpkg.com/css-select/-/css-select-4.3.0.tgz#db7129b2846662fd8628cfc496abb2b59e41529b" + integrity sha512-wPpOYtnsVontu2mODhA19JrqWxNsfdatRKd64kmpRbQgh1KtItko5sTnEpPdpSaJszTOhEMlF/RPz28qj4HqhQ== + dependencies: + boolbase "^1.0.0" + css-what "^6.0.1" + domhandler "^4.3.1" + domutils "^2.8.0" + nth-check "^2.0.1" + +css-select@^5.1.0: + version "5.2.2" + resolved "https://registry.yarnpkg.com/css-select/-/css-select-5.2.2.tgz#01b6e8d163637bb2dd6c982ca4ed65863682786e" + integrity sha512-TizTzUddG/xYLA3NXodFM0fSbNizXjOKhqiQQwvhlspadZokn1KDy0NZFS0wuEubIYAV5/c1/lAr0TaaFXEXzw== + dependencies: + boolbase "^1.0.0" + css-what "^6.1.0" + domhandler "^5.0.2" + domutils "^3.0.1" + nth-check "^2.0.1" + +css-tree@^2.3.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/css-tree/-/css-tree-2.3.1.tgz#10264ce1e5442e8572fc82fbe490644ff54b5c20" + integrity sha512-6Fv1DV/TYw//QF5IzQdqsNDjx/wc8TrMBZsqjL9eW01tWb7R7k/mq+/VXfJCl7SoD5emsJop9cOByJZfs8hYIw== + dependencies: + mdn-data "2.0.30" + source-map-js "^1.0.1" + +css-tree@~2.2.0: + version "2.2.1" + resolved "https://registry.yarnpkg.com/css-tree/-/css-tree-2.2.1.tgz#36115d382d60afd271e377f9c5f67d02bd48c032" + integrity sha512-OA0mILzGc1kCOCSJerOeqDxDQ4HOh+G8NbOJFOTgOCzpw7fCBubk0fEyxp8AgOL/jvLgYA/uV0cMbe43ElF1JA== + dependencies: + mdn-data "2.0.28" + source-map-js "^1.0.1" + +css-what@^6.0.1, css-what@^6.1.0: + version "6.2.2" + resolved "https://registry.yarnpkg.com/css-what/-/css-what-6.2.2.tgz#cdcc8f9b6977719fdfbd1de7aec24abf756b9dea" + integrity sha512-u/O3vwbptzhMs3L1fQE82ZSLHQQfto5gyZzwteVIEyeaY5Fc7R4dapF/BvRoSYFeqfBk4m0V1Vafq5Pjv25wvA== + +cssdb@^8.4.0: + version "8.4.0" + resolved "https://registry.yarnpkg.com/cssdb/-/cssdb-8.4.0.tgz#232a1aa7751983ed2b40331634902d4c93f0456c" + integrity sha512-lyATYGyvXwQ8h55WeQeEHXhI+47rl52pXSYkFK/ZrCbAJSgVIaPFjYc3RM8TpRHKk7W3wsAZImmLps+P5VyN9g== + +cssesc@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/cssesc/-/cssesc-3.0.0.tgz#37741919903b868565e1c09ea747445cd18983ee" + integrity sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg== + +cssnano-preset-advanced@^6.1.2: + version "6.1.2" + resolved "https://registry.yarnpkg.com/cssnano-preset-advanced/-/cssnano-preset-advanced-6.1.2.tgz#82b090872b8f98c471f681d541c735acf8b94d3f" + integrity sha512-Nhao7eD8ph2DoHolEzQs5CfRpiEP0xa1HBdnFZ82kvqdmbwVBUr2r1QuQ4t1pi+D1ZpqpcO4T+wy/7RxzJ/WPQ== + dependencies: + autoprefixer "^10.4.19" + browserslist "^4.23.0" + cssnano-preset-default "^6.1.2" + postcss-discard-unused "^6.0.5" + postcss-merge-idents "^6.0.3" + postcss-reduce-idents "^6.0.3" + postcss-zindex "^6.0.2" + +cssnano-preset-default@^6.1.2: + version "6.1.2" + resolved "https://registry.yarnpkg.com/cssnano-preset-default/-/cssnano-preset-default-6.1.2.tgz#adf4b89b975aa775f2750c89dbaf199bbd9da35e" + integrity sha512-1C0C+eNaeN8OcHQa193aRgYexyJtU8XwbdieEjClw+J9d94E41LwT6ivKH0WT+fYwYWB0Zp3I3IZ7tI/BbUbrg== + dependencies: + browserslist "^4.23.0" + css-declaration-sorter "^7.2.0" + cssnano-utils "^4.0.2" + postcss-calc "^9.0.1" + postcss-colormin "^6.1.0" + postcss-convert-values "^6.1.0" + postcss-discard-comments "^6.0.2" + postcss-discard-duplicates "^6.0.3" + postcss-discard-empty "^6.0.3" + postcss-discard-overridden "^6.0.2" + postcss-merge-longhand "^6.0.5" + postcss-merge-rules "^6.1.1" + postcss-minify-font-values "^6.1.0" + postcss-minify-gradients "^6.0.3" + postcss-minify-params "^6.1.0" + postcss-minify-selectors "^6.0.4" + postcss-normalize-charset "^6.0.2" + postcss-normalize-display-values "^6.0.2" + postcss-normalize-positions "^6.0.2" + postcss-normalize-repeat-style "^6.0.2" + postcss-normalize-string "^6.0.2" + postcss-normalize-timing-functions "^6.0.2" + postcss-normalize-unicode "^6.1.0" + postcss-normalize-url "^6.0.2" + postcss-normalize-whitespace "^6.0.2" + postcss-ordered-values "^6.0.2" + postcss-reduce-initial "^6.1.0" + postcss-reduce-transforms "^6.0.2" + postcss-svgo "^6.0.3" + postcss-unique-selectors "^6.0.4" + +cssnano-utils@^4.0.2: + version "4.0.2" + resolved "https://registry.yarnpkg.com/cssnano-utils/-/cssnano-utils-4.0.2.tgz#56f61c126cd0f11f2eef1596239d730d9fceff3c" + integrity sha512-ZR1jHg+wZ8o4c3zqf1SIUSTIvm/9mU343FMR6Obe/unskbvpGhZOo1J6d/r8D1pzkRQYuwbcH3hToOuoA2G7oQ== + +cssnano@^6.0.1, cssnano@^6.1.2: + version "6.1.2" + resolved "https://registry.yarnpkg.com/cssnano/-/cssnano-6.1.2.tgz#4bd19e505bd37ee7cf0dc902d3d869f6d79c66b8" + integrity sha512-rYk5UeX7VAM/u0lNqewCdasdtPK81CgX8wJFLEIXHbV2oldWRgJAsZrdhRXkV1NJzA2g850KiFm9mMU2HxNxMA== + dependencies: + cssnano-preset-default "^6.1.2" + lilconfig "^3.1.1" + +csso@^5.0.5: + version "5.0.5" + resolved "https://registry.yarnpkg.com/csso/-/csso-5.0.5.tgz#f9b7fe6cc6ac0b7d90781bb16d5e9874303e2ca6" + integrity sha512-0LrrStPOdJj+SPCCrGhzryycLjwcgUSHBtxNA8aIDxf0GLsRh1cKYhB00Gd1lDOS4yGH69+SNn13+TWbVHETFQ== + dependencies: + css-tree "~2.2.0" + +csstype@^3.0.2, csstype@^3.1.3: + version "3.1.3" + resolved "https://registry.yarnpkg.com/csstype/-/csstype-3.1.3.tgz#d80ff294d114fb0e6ac500fbf85b60137d7eff81" + integrity sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw== + +debounce@^1.2.1: + version "1.2.1" + resolved "https://registry.yarnpkg.com/debounce/-/debounce-1.2.1.tgz#38881d8f4166a5c5848020c11827b834bcb3e0a5" + integrity sha512-XRRe6Glud4rd/ZGQfiV1ruXSfbvfJedlV9Y6zOlP+2K04vBYiJEte6stfFkCP03aMnY5tsipamumUjL14fofug== + +debug@2.6.9: + version "2.6.9" + resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.9.tgz#5d128515df134ff327e90a4c93f4e077a536341f" + integrity sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA== + dependencies: + ms "2.0.0" + +debug@4, debug@^4.0.0, debug@^4.1.0, debug@^4.3.1, debug@^4.4.1: + version "4.4.3" + resolved "https://registry.yarnpkg.com/debug/-/debug-4.4.3.tgz#c6ae432d9bd9662582fce08709b038c58e9e3d6a" + integrity sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA== + dependencies: + ms "^2.1.3" + +decode-named-character-reference@^1.0.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/decode-named-character-reference/-/decode-named-character-reference-1.2.0.tgz#25c32ae6dd5e21889549d40f676030e9514cc0ed" + integrity sha512-c6fcElNV6ShtZXmsgNgFFV5tVX2PaV4g+MOAkb8eXHvn6sryJBrZa9r0zV6+dtTyoCKxtDy5tyQ5ZwQuidtd+Q== + dependencies: + character-entities "^2.0.0" + +decompress-response@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/decompress-response/-/decompress-response-6.0.0.tgz#ca387612ddb7e104bd16d85aab00d5ecf09c66fc" + integrity sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ== + dependencies: + mimic-response "^3.1.0" + +deep-extend@^0.6.0: + version "0.6.0" + resolved "https://registry.yarnpkg.com/deep-extend/-/deep-extend-0.6.0.tgz#c4fa7c95404a17a9c3e8ca7e1537312b736330ac" + integrity sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA== + +deepmerge@^4.3.1: + version "4.3.1" + resolved "https://registry.yarnpkg.com/deepmerge/-/deepmerge-4.3.1.tgz#44b5f2147cd3b00d4b56137685966f26fd25dd4a" + integrity sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A== + +default-gateway@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/default-gateway/-/default-gateway-6.0.3.tgz#819494c888053bdb743edbf343d6cdf7f2943a71" + integrity sha512-fwSOJsbbNzZ/CUFpqFBqYfYNLj1NbMPm8MMCIzHjC83iSJRBEGmDUxU+WP661BaBQImeC2yHwXtz+P/O9o+XEg== + dependencies: + execa "^5.0.0" + +defer-to-connect@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/defer-to-connect/-/defer-to-connect-2.0.1.tgz#8016bdb4143e4632b77a3449c6236277de520587" + integrity sha512-4tvttepXG1VaYGrRibk5EwJd1t4udunSOVMdLSAL6mId1ix438oPwPZMALY41FCijukO1L0twNcGsdzS7dHgDg== + +define-data-property@^1.0.1, define-data-property@^1.1.4: + version "1.1.4" + resolved "https://registry.yarnpkg.com/define-data-property/-/define-data-property-1.1.4.tgz#894dc141bb7d3060ae4366f6a0107e68fbe48c5e" + integrity sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A== + dependencies: + es-define-property "^1.0.0" + es-errors "^1.3.0" + gopd "^1.0.1" + +define-lazy-prop@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/define-lazy-prop/-/define-lazy-prop-2.0.0.tgz#3f7ae421129bcaaac9bc74905c98a0009ec9ee7f" + integrity sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og== + +define-properties@^1.2.1: + version "1.2.1" + resolved "https://registry.yarnpkg.com/define-properties/-/define-properties-1.2.1.tgz#10781cc616eb951a80a034bafcaa7377f6af2b6c" + integrity sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg== + dependencies: + define-data-property "^1.0.1" + has-property-descriptors "^1.0.0" + object-keys "^1.1.1" + +delegate@^3.1.2: + version "3.2.0" + resolved "https://registry.yarnpkg.com/delegate/-/delegate-3.2.0.tgz#b66b71c3158522e8ab5744f720d8ca0c2af59166" + integrity sha512-IofjkYBZaZivn0V8nnsMJGBr4jVLxHDheKSW88PyxS5QC4Vo9ZbZVvhzlSxY87fVq3STR6r+4cGepyHkcWOQSw== + +depd@2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/depd/-/depd-2.0.0.tgz#b696163cc757560d09cf22cc8fad1571b79e76df" + integrity sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw== + +depd@~1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/depd/-/depd-1.1.2.tgz#9bcd52e14c097763e749b274c4346ed2e560b5a9" + integrity sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ== + +dequal@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/dequal/-/dequal-2.0.3.tgz#2644214f1997d39ed0ee0ece72335490a7ac67be" + integrity sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA== + +destroy@1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/destroy/-/destroy-1.2.0.tgz#4803735509ad8be552934c67df614f94e66fa015" + integrity sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg== + +detect-node@^2.0.4: + version "2.1.0" + resolved "https://registry.yarnpkg.com/detect-node/-/detect-node-2.1.0.tgz#c9c70775a49c3d03bc2c06d9a73be550f978f8b1" + integrity sha512-T0NIuQpnTvFDATNuHN5roPwSBG83rFsuO+MXXH9/3N1eFbn4wcPjttvjMLEPWJ0RGUYgQE7cGgS3tNxbqCGM7g== + +detect-port@^1.5.1: + version "1.6.1" + resolved "https://registry.yarnpkg.com/detect-port/-/detect-port-1.6.1.tgz#45e4073997c5f292b957cb678fb0bb8ed4250a67" + integrity sha512-CmnVc+Hek2egPx1PeTFVta2W78xy2K/9Rkf6cC4T59S50tVnzKj+tnx5mmx5lwvCkujZ4uRrpRSuV+IVs3f90Q== + dependencies: + address "^1.0.1" + debug "4" + +devlop@^1.0.0, devlop@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/devlop/-/devlop-1.1.0.tgz#4db7c2ca4dc6e0e834c30be70c94bbc976dc7018" + integrity sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA== + dependencies: + dequal "^2.0.0" + +dir-glob@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/dir-glob/-/dir-glob-3.0.1.tgz#56dbf73d992a4a93ba1584f4534063fd2e41717f" + integrity sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA== + dependencies: + path-type "^4.0.0" + +dns-packet@^5.2.2: + version "5.6.1" + resolved "https://registry.yarnpkg.com/dns-packet/-/dns-packet-5.6.1.tgz#ae888ad425a9d1478a0674256ab866de1012cf2f" + integrity sha512-l4gcSouhcgIKRvyy99RNVOgxXiicE+2jZoNmaNmZ6JXiGajBOJAesk1OBlJuM5k2c+eudGdLxDqXuPCKIj6kpw== + dependencies: + "@leichtgewicht/ip-codec" "^2.0.1" + +dom-converter@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/dom-converter/-/dom-converter-0.2.0.tgz#6721a9daee2e293682955b6afe416771627bb768" + integrity sha512-gd3ypIPfOMr9h5jIKq8E3sHOTCjeirnl0WK5ZdS1AW0Odt0b1PaWaHdJ4Qk4klv+YB9aJBS7mESXjFoDQPu6DA== + dependencies: + utila "~0.4" + +dom-helpers@^5.0.1: + version "5.2.1" + resolved "https://registry.yarnpkg.com/dom-helpers/-/dom-helpers-5.2.1.tgz#d9400536b2bf8225ad98fe052e029451ac40e902" + integrity sha512-nRCa7CK3VTrM2NmGkIy4cbK7IZlgBE/PYMn55rrXefr5xXDP0LdtfPnblFDoVdcAfslJ7or6iqAUnx0CCGIWQA== + dependencies: + "@babel/runtime" "^7.8.7" + csstype "^3.0.2" + +dom-serializer@^1.0.1: + version "1.4.1" + resolved "https://registry.yarnpkg.com/dom-serializer/-/dom-serializer-1.4.1.tgz#de5d41b1aea290215dc45a6dae8adcf1d32e2d30" + integrity sha512-VHwB3KfrcOOkelEG2ZOfxqLZdfkil8PtJi4P8N2MMXucZq2yLp75ClViUlOVwyoHEDjYU433Aq+5zWP61+RGag== + dependencies: + domelementtype "^2.0.1" + domhandler "^4.2.0" + entities "^2.0.0" + +dom-serializer@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/dom-serializer/-/dom-serializer-2.0.0.tgz#e41b802e1eedf9f6cae183ce5e622d789d7d8e53" + integrity sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg== + dependencies: + domelementtype "^2.3.0" + domhandler "^5.0.2" + entities "^4.2.0" + +domelementtype@^2.0.1, domelementtype@^2.2.0, domelementtype@^2.3.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/domelementtype/-/domelementtype-2.3.0.tgz#5c45e8e869952626331d7aab326d01daf65d589d" + integrity sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw== + +domhandler@^4.0.0, domhandler@^4.2.0, domhandler@^4.3.1: + version "4.3.1" + resolved "https://registry.yarnpkg.com/domhandler/-/domhandler-4.3.1.tgz#8d792033416f59d68bc03a5aa7b018c1ca89279c" + integrity sha512-GrwoxYN+uWlzO8uhUXRl0P+kHE4GtVPfYzVLcUxPL7KNdHKj66vvlhiweIHqYYXWlw+T8iLMp42Lm67ghw4WMQ== + dependencies: + domelementtype "^2.2.0" + +domhandler@^5.0.2, domhandler@^5.0.3: + version "5.0.3" + resolved "https://registry.yarnpkg.com/domhandler/-/domhandler-5.0.3.tgz#cc385f7f751f1d1fc650c21374804254538c7d31" + integrity sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w== + dependencies: + domelementtype "^2.3.0" + +domutils@^2.5.2, domutils@^2.8.0: + version "2.8.0" + resolved "https://registry.yarnpkg.com/domutils/-/domutils-2.8.0.tgz#4437def5db6e2d1f5d6ee859bd95ca7d02048135" + integrity sha512-w96Cjofp72M5IIhpjgobBimYEfoPjx1Vx0BSX9P30WBdZW2WIKU0T1Bd0kz2eNZ9ikjKgHbEyKx8BB6H1L3h3A== + dependencies: + dom-serializer "^1.0.1" + domelementtype "^2.2.0" + domhandler "^4.2.0" + +domutils@^3.0.1: + version "3.2.2" + resolved "https://registry.yarnpkg.com/domutils/-/domutils-3.2.2.tgz#edbfe2b668b0c1d97c24baf0f1062b132221bc78" + integrity sha512-6kZKyUajlDuqlHKVX1w7gyslj9MPIXzIFiz/rGu35uC1wMi+kMhQwGhl4lt9unC9Vb9INnY9Z3/ZA3+FhASLaw== + dependencies: + dom-serializer "^2.0.0" + domelementtype "^2.3.0" + domhandler "^5.0.3" + +dot-case@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/dot-case/-/dot-case-3.0.4.tgz#9b2b670d00a431667a8a75ba29cd1b98809ce751" + integrity sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w== + dependencies: + no-case "^3.0.4" + tslib "^2.0.3" + +dot-prop@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/dot-prop/-/dot-prop-6.0.1.tgz#fc26b3cf142b9e59b74dbd39ed66ce620c681083" + integrity sha512-tE7ztYzXHIeyvc7N+hR3oi7FIbf/NIjVP9hmAt3yMXzrQ072/fpjGLx2GxNxGxUl5V73MEqYzioOMoVhGMJ5cA== + dependencies: + is-obj "^2.0.0" + +dunder-proto@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/dunder-proto/-/dunder-proto-1.0.1.tgz#d7ae667e1dc83482f8b70fd0f6eefc50da30f58a" + integrity sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A== + dependencies: + call-bind-apply-helpers "^1.0.1" + es-errors "^1.3.0" + gopd "^1.2.0" + +duplexer@^0.1.2: + version "0.1.2" + resolved "https://registry.yarnpkg.com/duplexer/-/duplexer-0.1.2.tgz#3abe43aef3835f8ae077d136ddce0f276b0400e6" + integrity sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg== + +eastasianwidth@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/eastasianwidth/-/eastasianwidth-0.2.0.tgz#696ce2ec0aa0e6ea93a397ffcf24aa7840c827cb" + integrity sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA== + +ee-first@1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/ee-first/-/ee-first-1.1.1.tgz#590c61156b0ae2f4f0255732a158b266bc56b21d" + integrity sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow== + +electron-to-chromium@^1.5.218: + version "1.5.218" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.218.tgz#921042a011a98a4620853c9d391ab62bcc124400" + integrity sha512-uwwdN0TUHs8u6iRgN8vKeWZMRll4gBkz+QMqdS7DDe49uiK68/UX92lFb61oiFPrpYZNeZIqa4bA7O6Aiasnzg== + +emoji-regex@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37" + integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A== + +emoji-regex@^9.2.2: + version "9.2.2" + resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-9.2.2.tgz#840c8803b0d8047f4ff0cf963176b32d4ef3ed72" + integrity sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg== + +emojilib@^2.4.0: + version "2.4.0" + resolved "https://registry.yarnpkg.com/emojilib/-/emojilib-2.4.0.tgz#ac518a8bb0d5f76dda57289ccb2fdf9d39ae721e" + integrity sha512-5U0rVMU5Y2n2+ykNLQqMoqklN9ICBT/KsvC1Gz6vqHbz2AXXGkG+Pm5rMWk/8Vjrr/mY9985Hi8DYzn1F09Nyw== + +emojis-list@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/emojis-list/-/emojis-list-3.0.0.tgz#5570662046ad29e2e916e71aae260abdff4f6a78" + integrity sha512-/kyM18EfinwXZbno9FyUGeFh87KC8HRQBQGildHZbEuRyWFOmv1U10o9BBp8XVZDVNNuQKyIGIu5ZYAAXJ0V2Q== + +emoticon@^4.0.1: + version "4.1.0" + resolved "https://registry.yarnpkg.com/emoticon/-/emoticon-4.1.0.tgz#d5a156868ee173095627a33de3f1e914c3dde79e" + integrity sha512-VWZfnxqwNcc51hIy/sbOdEem6D+cVtpPzEEtVAFdaas30+1dgkyaOQ4sQ6Bp0tOMqWO1v+HQfYaoodOkdhK6SQ== + +encodeurl@~1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/encodeurl/-/encodeurl-1.0.2.tgz#ad3ff4c86ec2d029322f5a02c3a9a606c95b3f59" + integrity sha512-TPJXq8JqFaVYm2CWmPvnP2Iyo4ZSM7/QKcSmuMLDObfpH5fi7RUGmd/rTDf+rut/saiDiQEeVTNgAmJEdAOx0w== + +encodeurl@~2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/encodeurl/-/encodeurl-2.0.0.tgz#7b8ea898077d7e409d3ac45474ea38eaf0857a58" + integrity sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg== + +enhanced-resolve@^5.17.3: + version "5.18.3" + resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.18.3.tgz#9b5f4c5c076b8787c78fe540392ce76a88855b44" + integrity sha512-d4lC8xfavMeBjzGr2vECC3fsGXziXZQyJxD868h2M/mBI3PwAuODxAkLkq5HYuvrPYcUtiLzsTo8U3PgX3Ocww== + dependencies: + graceful-fs "^4.2.4" + tapable "^2.2.0" + +entities@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/entities/-/entities-2.2.0.tgz#098dc90ebb83d8dffa089d55256b351d34c4da55" + integrity sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A== + +entities@^4.2.0, entities@^4.4.0: + version "4.5.0" + resolved "https://registry.yarnpkg.com/entities/-/entities-4.5.0.tgz#5d268ea5e7113ec74c4d033b79ea5a35a488fb48" + integrity sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw== + +entities@^6.0.0: + version "6.0.1" + resolved "https://registry.yarnpkg.com/entities/-/entities-6.0.1.tgz#c28c34a43379ca7f61d074130b2f5f7020a30694" + integrity sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g== + +error-ex@^1.3.1: + version "1.3.4" + resolved "https://registry.yarnpkg.com/error-ex/-/error-ex-1.3.4.tgz#b3a8d8bb6f92eecc1629e3e27d3c8607a8a32414" + integrity sha512-sqQamAnR14VgCr1A618A3sGrygcpK+HEbenA/HiEAkkUwcZIIB/tgWqHFxWgOyDh4nB4JCRimh79dR5Ywc9MDQ== + dependencies: + is-arrayish "^0.2.1" + +es-define-property@^1.0.0, es-define-property@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/es-define-property/-/es-define-property-1.0.1.tgz#983eb2f9a6724e9303f61addf011c72e09e0b0fa" + integrity sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g== + +es-errors@^1.3.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/es-errors/-/es-errors-1.3.0.tgz#05f75a25dab98e4fb1dcd5e1472c0546d5057c8f" + integrity sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw== + +es-module-lexer@^1.2.1: + version "1.7.0" + resolved "https://registry.yarnpkg.com/es-module-lexer/-/es-module-lexer-1.7.0.tgz#9159601561880a85f2734560a9099b2c31e5372a" + integrity sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA== + +es-object-atoms@^1.0.0, es-object-atoms@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/es-object-atoms/-/es-object-atoms-1.1.1.tgz#1c4f2c4837327597ce69d2ca190a7fdd172338c1" + integrity sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA== + dependencies: + es-errors "^1.3.0" + +esast-util-from-estree@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/esast-util-from-estree/-/esast-util-from-estree-2.0.0.tgz#8d1cfb51ad534d2f159dc250e604f3478a79f1ad" + integrity sha512-4CyanoAudUSBAn5K13H4JhsMH6L9ZP7XbLVe/dKybkxMO7eDyLsT8UHl9TRNrU2Gr9nz+FovfSIjuXWJ81uVwQ== + dependencies: + "@types/estree-jsx" "^1.0.0" + devlop "^1.0.0" + estree-util-visit "^2.0.0" + unist-util-position-from-estree "^2.0.0" + +esast-util-from-js@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/esast-util-from-js/-/esast-util-from-js-2.0.1.tgz#5147bec34cc9da44accf52f87f239a40ac3e8225" + integrity sha512-8Ja+rNJ0Lt56Pcf3TAmpBZjmx8ZcK5Ts4cAzIOjsjevg9oSXJnl6SUQ2EevU8tv3h6ZLWmoKL5H4fgWvdvfETw== + dependencies: + "@types/estree-jsx" "^1.0.0" + acorn "^8.0.0" + esast-util-from-estree "^2.0.0" + vfile-message "^4.0.0" + +escalade@^3.1.1, escalade@^3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/escalade/-/escalade-3.2.0.tgz#011a3f69856ba189dffa7dc8fcce99d2a87903e5" + integrity sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA== + +escape-goat@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/escape-goat/-/escape-goat-4.0.0.tgz#9424820331b510b0666b98f7873fe11ac4aa8081" + integrity sha512-2Sd4ShcWxbx6OY1IHyla/CVNwvg7XwZVoXZHcSu9w9SReNP1EzzD5T8NWKIR38fIqEns9kDWKUQTXXAmlDrdPg== + +escape-html@^1.0.3, escape-html@~1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/escape-html/-/escape-html-1.0.3.tgz#0258eae4d3d0c0974de1c169188ef0051d1d1988" + integrity sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow== + +escape-string-regexp@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4" + integrity sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg== + +escape-string-regexp@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz#14ba83a5d373e3d311e5afca29cf5bfad965bf34" + integrity sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA== + +escape-string-regexp@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz#4683126b500b61762f2dbebace1806e8be31b1c8" + integrity sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw== + +eslint-scope@5.1.1: + version "5.1.1" + resolved "https://registry.yarnpkg.com/eslint-scope/-/eslint-scope-5.1.1.tgz#e786e59a66cb92b3f6c1fb0d508aab174848f48c" + integrity sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw== + dependencies: + esrecurse "^4.3.0" + estraverse "^4.1.1" + +esprima@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/esprima/-/esprima-4.0.1.tgz#13b04cdb3e6c5d19df91ab6987a8695619b0aa71" + integrity sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A== + +esrecurse@^4.3.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/esrecurse/-/esrecurse-4.3.0.tgz#7ad7964d679abb28bee72cec63758b1c5d2c9921" + integrity sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag== + dependencies: + estraverse "^5.2.0" + +estraverse@^4.1.1: + version "4.3.0" + resolved "https://registry.yarnpkg.com/estraverse/-/estraverse-4.3.0.tgz#398ad3f3c5a24948be7725e83d11a7de28cdbd1d" + integrity sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw== + +estraverse@^5.2.0: + version "5.3.0" + resolved "https://registry.yarnpkg.com/estraverse/-/estraverse-5.3.0.tgz#2eea5290702f26ab8fe5370370ff86c965d21123" + integrity sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA== + +estree-util-attach-comments@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/estree-util-attach-comments/-/estree-util-attach-comments-3.0.0.tgz#344bde6a64c8a31d15231e5ee9e297566a691c2d" + integrity sha512-cKUwm/HUcTDsYh/9FgnuFqpfquUbwIqwKM26BVCGDPVgvaCl/nDCCjUfiLlx6lsEZ3Z4RFxNbOQ60pkaEwFxGw== + dependencies: + "@types/estree" "^1.0.0" + +estree-util-build-jsx@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/estree-util-build-jsx/-/estree-util-build-jsx-3.0.1.tgz#b6d0bced1dcc4f06f25cf0ceda2b2dcaf98168f1" + integrity sha512-8U5eiL6BTrPxp/CHbs2yMgP8ftMhR5ww1eIKoWRMlqvltHF8fZn5LRDvTKuxD3DUn+shRbLGqXemcP51oFCsGQ== + dependencies: + "@types/estree-jsx" "^1.0.0" + devlop "^1.0.0" + estree-util-is-identifier-name "^3.0.0" + estree-walker "^3.0.0" + +estree-util-is-identifier-name@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/estree-util-is-identifier-name/-/estree-util-is-identifier-name-3.0.0.tgz#0b5ef4c4ff13508b34dcd01ecfa945f61fce5dbd" + integrity sha512-hFtqIDZTIUZ9BXLb8y4pYGyk6+wekIivNVTcmvk8NoOh+VeRn5y6cEHzbURrWbfp1fIqdVipilzj+lfaadNZmg== + +estree-util-scope@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/estree-util-scope/-/estree-util-scope-1.0.0.tgz#9cbdfc77f5cb51e3d9ed4ad9c4adbff22d43e585" + integrity sha512-2CAASclonf+JFWBNJPndcOpA8EMJwa0Q8LUFJEKqXLW6+qBvbFZuF5gItbQOs/umBUkjviCSDCbBwU2cXbmrhQ== + dependencies: + "@types/estree" "^1.0.0" + devlop "^1.0.0" + +estree-util-to-js@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/estree-util-to-js/-/estree-util-to-js-2.0.0.tgz#10a6fb924814e6abb62becf0d2bc4dea51d04f17" + integrity sha512-WDF+xj5rRWmD5tj6bIqRi6CkLIXbbNQUcxQHzGysQzvHmdYG2G7p/Tf0J0gpxGgkeMZNTIjT/AoSvC9Xehcgdg== + dependencies: + "@types/estree-jsx" "^1.0.0" + astring "^1.8.0" + source-map "^0.7.0" + +estree-util-value-to-estree@^3.0.1: + version "3.4.0" + resolved "https://registry.yarnpkg.com/estree-util-value-to-estree/-/estree-util-value-to-estree-3.4.0.tgz#827122e40c3a756d3c4cf5d5d296fa06026a1a4f" + integrity sha512-Zlp+gxis+gCfK12d3Srl2PdX2ybsEA8ZYy6vQGVQTNNYLEGRQQ56XB64bjemN8kxIKXP1nC9ip4Z+ILy9LGzvQ== + dependencies: + "@types/estree" "^1.0.0" + +estree-util-visit@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/estree-util-visit/-/estree-util-visit-2.0.0.tgz#13a9a9f40ff50ed0c022f831ddf4b58d05446feb" + integrity sha512-m5KgiH85xAhhW8Wta0vShLcUvOsh3LLPI2YVwcbio1l7E09NTLL1EyMZFM1OyWowoH0skScNbhOPl4kcBgzTww== + dependencies: + "@types/estree-jsx" "^1.0.0" + "@types/unist" "^3.0.0" + +estree-walker@^3.0.0: + version "3.0.3" + resolved "https://registry.yarnpkg.com/estree-walker/-/estree-walker-3.0.3.tgz#67c3e549ec402a487b4fc193d1953a524752340d" + integrity sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g== + dependencies: + "@types/estree" "^1.0.0" + +esutils@^2.0.2: + version "2.0.3" + resolved "https://registry.yarnpkg.com/esutils/-/esutils-2.0.3.tgz#74d2eb4de0b8da1293711910d50775b9b710ef64" + integrity sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g== + +eta@^2.2.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/eta/-/eta-2.2.0.tgz#eb8b5f8c4e8b6306561a455e62cd7492fe3a9b8a" + integrity sha512-UVQ72Rqjy/ZKQalzV5dCCJP80GrmPrMxh6NlNf+erV6ObL0ZFkhCstWRawS85z3smdr3d2wXPsZEY7rDPfGd2g== + +etag@~1.8.1: + version "1.8.1" + resolved "https://registry.yarnpkg.com/etag/-/etag-1.8.1.tgz#41ae2eeb65efa62268aebfea83ac7d79299b0887" + integrity sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg== + +eval@^0.1.8: + version "0.1.8" + resolved "https://registry.yarnpkg.com/eval/-/eval-0.1.8.tgz#2b903473b8cc1d1989b83a1e7923f883eb357f85" + integrity sha512-EzV94NYKoO09GLXGjXj9JIlXijVck4ONSr5wiCWDvhsvj5jxSrzTmRU/9C1DyB6uToszLs8aifA6NQ7lEQdvFw== + dependencies: + "@types/node" "*" + require-like ">= 0.1.1" + +eventemitter3@^4.0.0, eventemitter3@^4.0.4: + version "4.0.7" + resolved "https://registry.yarnpkg.com/eventemitter3/-/eventemitter3-4.0.7.tgz#2de9b68f6528d5644ef5c59526a1b4a07306169f" + integrity sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw== + +events@^3.2.0: + version "3.3.0" + resolved "https://registry.yarnpkg.com/events/-/events-3.3.0.tgz#31a95ad0a924e2d2c419a813aeb2c4e878ea7400" + integrity sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q== + +execa@5.1.1, execa@^5.0.0: + version "5.1.1" + resolved "https://registry.yarnpkg.com/execa/-/execa-5.1.1.tgz#f80ad9cbf4298f7bd1d4c9555c21e93741c411dd" + integrity sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg== + dependencies: + cross-spawn "^7.0.3" + get-stream "^6.0.0" + human-signals "^2.1.0" + is-stream "^2.0.0" + merge-stream "^2.0.0" + npm-run-path "^4.0.1" + onetime "^5.1.2" + signal-exit "^3.0.3" + strip-final-newline "^2.0.0" + +express@^4.17.3: + version "4.21.2" + resolved "https://registry.yarnpkg.com/express/-/express-4.21.2.tgz#cf250e48362174ead6cea4a566abef0162c1ec32" + integrity sha512-28HqgMZAmih1Czt9ny7qr6ek2qddF4FclbMzwhCREB6OFfH+rXAnuNCwo1/wFvrtbgsQDb4kSbX9de9lFbrXnA== + dependencies: + accepts "~1.3.8" + array-flatten "1.1.1" + body-parser "1.20.3" + content-disposition "0.5.4" + content-type "~1.0.4" + cookie "0.7.1" + cookie-signature "1.0.6" + debug "2.6.9" + depd "2.0.0" + encodeurl "~2.0.0" + escape-html "~1.0.3" + etag "~1.8.1" + finalhandler "1.3.1" + fresh "0.5.2" + http-errors "2.0.0" + merge-descriptors "1.0.3" + methods "~1.1.2" + on-finished "2.4.1" + parseurl "~1.3.3" + path-to-regexp "0.1.12" + proxy-addr "~2.0.7" + qs "6.13.0" + range-parser "~1.2.1" + safe-buffer "5.2.1" + send "0.19.0" + serve-static "1.16.2" + setprototypeof "1.2.0" + statuses "2.0.1" + type-is "~1.6.18" + utils-merge "1.0.1" + vary "~1.1.2" + +extend-shallow@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/extend-shallow/-/extend-shallow-2.0.1.tgz#51af7d614ad9a9f610ea1bafbb989d6b1c56890f" + integrity sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug== + dependencies: + is-extendable "^0.1.0" + +extend@^3.0.0: + version "3.0.2" + resolved "https://registry.yarnpkg.com/extend/-/extend-3.0.2.tgz#f8b1136b4071fbd8eb140aff858b1019ec2915fa" + integrity sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g== + +fast-deep-equal@^3.1.1, fast-deep-equal@^3.1.3: + version "3.1.3" + resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525" + integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== + +fast-glob@^3.2.11, fast-glob@^3.2.9, fast-glob@^3.3.0: + version "3.3.3" + resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.3.3.tgz#d06d585ce8dba90a16b0505c543c3ccfb3aeb818" + integrity sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg== + dependencies: + "@nodelib/fs.stat" "^2.0.2" + "@nodelib/fs.walk" "^1.2.3" + glob-parent "^5.1.2" + merge2 "^1.3.0" + micromatch "^4.0.8" + +fast-json-stable-stringify@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz#874bf69c6f404c2b5d99c481341399fd55892633" + integrity sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw== + +fast-uri@^3.0.1: + version "3.1.0" + resolved "https://registry.yarnpkg.com/fast-uri/-/fast-uri-3.1.0.tgz#66eecff6c764c0df9b762e62ca7edcfb53b4edfa" + integrity sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA== + +fastq@^1.6.0: + version "1.19.1" + resolved "https://registry.yarnpkg.com/fastq/-/fastq-1.19.1.tgz#d50eaba803c8846a883c16492821ebcd2cda55f5" + integrity sha512-GwLTyxkCXjXbxqIhTsMI2Nui8huMPtnxg7krajPJAjnEG/iiOS7i+zCtWGZR9G0NBKbXKh6X9m9UIsYX/N6vvQ== + dependencies: + reusify "^1.0.4" + +fault@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/fault/-/fault-2.0.1.tgz#d47ca9f37ca26e4bd38374a7c500b5a384755b6c" + integrity sha512-WtySTkS4OKev5JtpHXnib4Gxiurzh5NCGvWrFaZ34m6JehfTUhKZvn9njTfw48t6JumVQOmrKqpmGcdwxnhqBQ== + dependencies: + format "^0.2.0" + +faye-websocket@^0.11.3: + version "0.11.4" + resolved "https://registry.yarnpkg.com/faye-websocket/-/faye-websocket-0.11.4.tgz#7f0d9275cfdd86a1c963dc8b65fcc451edcbb1da" + integrity sha512-CzbClwlXAuiRQAlUyfqPgvPoNKTckTPGfwZV4ZdAhVcP2lh9KUxJg2b5GkE7XbjKQ3YJnQ9z6D9ntLAlB+tP8g== + dependencies: + websocket-driver ">=0.5.1" + +feed@^4.2.2: + version "4.2.2" + resolved "https://registry.yarnpkg.com/feed/-/feed-4.2.2.tgz#865783ef6ed12579e2c44bbef3c9113bc4956a7e" + integrity sha512-u5/sxGfiMfZNtJ3OvQpXcvotFpYkL0n9u9mM2vkui2nGo8b4wvDkJ8gAkYqbA8QpGyFCv3RK0Z+Iv+9veCS9bQ== + dependencies: + xml-js "^1.6.11" + +figures@^3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/figures/-/figures-3.2.0.tgz#625c18bd293c604dc4a8ddb2febf0c88341746af" + integrity sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg== + dependencies: + escape-string-regexp "^1.0.5" + +file-loader@^6.2.0: + version "6.2.0" + resolved "https://registry.yarnpkg.com/file-loader/-/file-loader-6.2.0.tgz#baef7cf8e1840df325e4390b4484879480eebe4d" + integrity sha512-qo3glqyTa61Ytg4u73GultjHGjdRyig3tG6lPtyX/jOEJvHif9uB0/OCI2Kif6ctF3caQTW2G5gym21oAsI4pw== + dependencies: + loader-utils "^2.0.0" + schema-utils "^3.0.0" + +fill-range@^7.1.1: + version "7.1.1" + resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-7.1.1.tgz#44265d3cac07e3ea7dc247516380643754a05292" + integrity sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg== + dependencies: + to-regex-range "^5.0.1" + +finalhandler@1.3.1: + version "1.3.1" + resolved "https://registry.yarnpkg.com/finalhandler/-/finalhandler-1.3.1.tgz#0c575f1d1d324ddd1da35ad7ece3df7d19088019" + integrity sha512-6BN9trH7bp3qvnrRyzsBz+g3lZxTNZTbVO2EV1CS0WIcDbawYVdYvGflME/9QP0h0pYlCDBCTjYa9nZzMDpyxQ== + dependencies: + debug "2.6.9" + encodeurl "~2.0.0" + escape-html "~1.0.3" + on-finished "2.4.1" + parseurl "~1.3.3" + statuses "2.0.1" + unpipe "~1.0.0" + +find-cache-dir@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/find-cache-dir/-/find-cache-dir-4.0.0.tgz#a30ee0448f81a3990708f6453633c733e2f6eec2" + integrity sha512-9ZonPT4ZAK4a+1pUPVPZJapbi7O5qbbJPdYw/NOQWZZbVLdDTYM3A4R9z/DpAM08IDaFGsvPgiGZ82WEwUDWjg== + dependencies: + common-path-prefix "^3.0.0" + pkg-dir "^7.0.0" + +find-root@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/find-root/-/find-root-1.1.0.tgz#abcfc8ba76f708c42a97b3d685b7e9450bfb9ce4" + integrity sha512-NKfW6bec6GfKc0SGx1e07QZY9PE99u0Bft/0rzSD5k3sO/vwkVUpDUKVm5Gpp5Ue3YfShPFTX2070tDs5kB9Ng== + +find-up@^6.3.0: + version "6.3.0" + resolved "https://registry.yarnpkg.com/find-up/-/find-up-6.3.0.tgz#2abab3d3280b2dc7ac10199ef324c4e002c8c790" + integrity sha512-v2ZsoEuVHYy8ZIlYqwPe/39Cy+cFDzp4dXPaxNvkEuouymu+2Jbz0PxpKarJHYJTmv2HWT3O382qY8l4jMWthw== + dependencies: + locate-path "^7.1.0" + path-exists "^5.0.0" + +flat@^5.0.2: + version "5.0.2" + resolved "https://registry.yarnpkg.com/flat/-/flat-5.0.2.tgz#8ca6fe332069ffa9d324c327198c598259ceb241" + integrity sha512-b6suED+5/3rTpUBdG1gupIl8MPFCAMA0QXwmljLhvCUKcUvdE4gWky9zpuGCcXHOsz4J9wPGNWq6OKpmIzz3hQ== + +follow-redirects@^1.0.0: + version "1.15.11" + resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.11.tgz#777d73d72a92f8ec4d2e410eb47352a56b8e8340" + integrity sha512-deG2P0JfjrTxl50XGCDyfI97ZGVCxIpfKYmfyrQ54n5FO/0gfIES8C/Psl6kWVDolizcaaxZJnTS0QSMxvnsBQ== + +form-data-encoder@^2.1.2: + version "2.1.4" + resolved "https://registry.yarnpkg.com/form-data-encoder/-/form-data-encoder-2.1.4.tgz#261ea35d2a70d48d30ec7a9603130fa5515e9cd5" + integrity sha512-yDYSgNMraqvnxiEXO4hi88+YZxaHC6QKzb5N84iRCTDeRO7ZALpir/lVmf/uXUhnwUr2O4HU8s/n6x+yNjQkHw== + +format@^0.2.0: + version "0.2.2" + resolved "https://registry.yarnpkg.com/format/-/format-0.2.2.tgz#d6170107e9efdc4ed30c9dc39016df942b5cb58b" + integrity sha512-wzsgA6WOq+09wrU1tsJ09udeR/YZRaeArL9e1wPbFg3GG2yDnC2ldKpxs4xunpFF9DgqCqOIra3bc1HWrJ37Ww== + +forwarded@0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/forwarded/-/forwarded-0.2.0.tgz#2269936428aad4c15c7ebe9779a84bf0b2a81811" + integrity sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow== + +fraction.js@^4.3.7: + version "4.3.7" + resolved "https://registry.yarnpkg.com/fraction.js/-/fraction.js-4.3.7.tgz#06ca0085157e42fda7f9e726e79fefc4068840f7" + integrity sha512-ZsDfxO51wGAXREY55a7la9LScWpwv9RxIrYABrlvOFBlH/ShPnrtsXeuUIfXKKOVicNxQ+o8JTbJvjS4M89yew== + +fresh@0.5.2: + version "0.5.2" + resolved "https://registry.yarnpkg.com/fresh/-/fresh-0.5.2.tgz#3d8cadd90d976569fa835ab1f8e4b23a105605a7" + integrity sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q== + +fs-extra@^11.1.1, fs-extra@^11.2.0: + version "11.3.2" + resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-11.3.2.tgz#c838aeddc6f4a8c74dd15f85e11fe5511bfe02a4" + integrity sha512-Xr9F6z6up6Ws+NjzMCZc6WXg2YFRlrLP9NQDO3VQrWrfiojdhS56TzueT88ze0uBdCTwEIhQ3ptnmKeWGFAe0A== + dependencies: + graceful-fs "^4.2.0" + jsonfile "^6.0.1" + universalify "^2.0.0" + +fs-monkey@^1.0.4: + version "1.1.0" + resolved "https://registry.yarnpkg.com/fs-monkey/-/fs-monkey-1.1.0.tgz#632aa15a20e71828ed56b24303363fb1414e5997" + integrity sha512-QMUezzXWII9EV5aTFXW1UBVUO77wYPpjqIF8/AviUCThNeSYZykpoTixUeaNNBwmCev0AMDWMAni+f8Hxb1IFw== + +fs.realpath@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" + integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw== + +fsevents@~2.3.2: + version "2.3.3" + resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.3.tgz#cac6407785d03675a2a5e1a5305c697b347d90d6" + integrity sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw== + +function-bind@^1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/function-bind/-/function-bind-1.1.2.tgz#2c02d864d97f3ea6c8830c464cbd11ab6eab7a1c" + integrity sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA== + +gensync@^1.0.0-beta.2: + version "1.0.0-beta.2" + resolved "https://registry.yarnpkg.com/gensync/-/gensync-1.0.0-beta.2.tgz#32a6ee76c3d7f52d46b2b1ae5d93fea8580a25e0" + integrity sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg== + +get-intrinsic@^1.2.4, get-intrinsic@^1.2.5, get-intrinsic@^1.3.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/get-intrinsic/-/get-intrinsic-1.3.0.tgz#743f0e3b6964a93a5491ed1bffaae054d7f98d01" + integrity sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ== + dependencies: + call-bind-apply-helpers "^1.0.2" + es-define-property "^1.0.1" + es-errors "^1.3.0" + es-object-atoms "^1.1.1" + function-bind "^1.1.2" + get-proto "^1.0.1" + gopd "^1.2.0" + has-symbols "^1.1.0" + hasown "^2.0.2" + math-intrinsics "^1.1.0" + +get-own-enumerable-property-symbols@^3.0.0: + version "3.0.2" + resolved "https://registry.yarnpkg.com/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.2.tgz#b5fde77f22cbe35f390b4e089922c50bce6ef664" + integrity sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g== + +get-proto@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/get-proto/-/get-proto-1.0.1.tgz#150b3f2743869ef3e851ec0c49d15b1d14d00ee1" + integrity sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g== + dependencies: + dunder-proto "^1.0.1" + es-object-atoms "^1.0.0" + +get-stream@^6.0.0, get-stream@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-6.0.1.tgz#a262d8eef67aced57c2852ad6167526a43cbf7b7" + integrity sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg== + +github-slugger@^1.5.0: + version "1.5.0" + resolved "https://registry.yarnpkg.com/github-slugger/-/github-slugger-1.5.0.tgz#17891bbc73232051474d68bd867a34625c955f7d" + integrity sha512-wIh+gKBI9Nshz2o46B0B3f5k/W+WI9ZAv6y5Dn5WJ5SK1t0TnDimB4WE5rmTD05ZAIn8HALCZVmCsvj0w0v0lw== + +glob-parent@^5.1.2, glob-parent@~5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4" + integrity sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow== + dependencies: + is-glob "^4.0.1" + +glob-parent@^6.0.1: + version "6.0.2" + resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-6.0.2.tgz#6d237d99083950c79290f24c7642a3de9a28f9e3" + integrity sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A== + dependencies: + is-glob "^4.0.3" + +glob-to-regexp@^0.4.1: + version "0.4.1" + resolved "https://registry.yarnpkg.com/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz#c75297087c851b9a578bd217dd59a92f59fe546e" + integrity sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw== + +glob@^7.1.3: + version "7.2.3" + resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.3.tgz#b8df0fb802bbfa8e89bd1d938b4e16578ed44f2b" + integrity sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q== + dependencies: + fs.realpath "^1.0.0" + inflight "^1.0.4" + inherits "2" + minimatch "^3.1.1" + once "^1.3.0" + path-is-absolute "^1.0.0" + +global-dirs@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/global-dirs/-/global-dirs-3.0.1.tgz#0c488971f066baceda21447aecb1a8b911d22485" + integrity sha512-NBcGGFbBA9s1VzD41QXDG+3++t9Mn5t1FpLdhESY6oKY4gYTFpX4wO3sqGUa0Srjtbfj3szX0RnemmrVRUdULA== + dependencies: + ini "2.0.0" + +globby@^11.1.0: + version "11.1.0" + resolved "https://registry.yarnpkg.com/globby/-/globby-11.1.0.tgz#bd4be98bb042f83d796f7e3811991fbe82a0d34b" + integrity sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g== + dependencies: + array-union "^2.1.0" + dir-glob "^3.0.1" + fast-glob "^3.2.9" + ignore "^5.2.0" + merge2 "^1.4.1" + slash "^3.0.0" + +globby@^13.1.1: + version "13.2.2" + resolved "https://registry.yarnpkg.com/globby/-/globby-13.2.2.tgz#63b90b1bf68619c2135475cbd4e71e66aa090592" + integrity sha512-Y1zNGV+pzQdh7H39l9zgB4PJqjRNqydvdYCDG4HFXM4XuvSaQQlEc91IU1yALL8gUTDomgBAfz3XJdmUS+oo0w== + dependencies: + dir-glob "^3.0.1" + fast-glob "^3.3.0" + ignore "^5.2.4" + merge2 "^1.4.1" + slash "^4.0.0" + +good-listener@^1.2.2: + version "1.2.2" + resolved "https://registry.yarnpkg.com/good-listener/-/good-listener-1.2.2.tgz#d53b30cdf9313dffb7dc9a0d477096aa6d145c50" + integrity sha512-goW1b+d9q/HIwbVYZzZ6SsTr4IgE+WA44A0GmPIQstuOrgsFcT7VEJ48nmr9GaRtNu0XTKacFLGnBPAM6Afouw== + dependencies: + delegate "^3.1.2" + +gopd@^1.0.1, gopd@^1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/gopd/-/gopd-1.2.0.tgz#89f56b8217bdbc8802bd299df6d7f1081d7e51a1" + integrity sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg== + +got@^12.1.0: + version "12.6.1" + resolved "https://registry.yarnpkg.com/got/-/got-12.6.1.tgz#8869560d1383353204b5a9435f782df9c091f549" + integrity sha512-mThBblvlAF1d4O5oqyvN+ZxLAYwIJK7bpMxgYqPD9okW0C3qm5FFn7k811QrcuEBwaogR3ngOFoCfs6mRv7teQ== + dependencies: + "@sindresorhus/is" "^5.2.0" + "@szmarczak/http-timer" "^5.0.1" + cacheable-lookup "^7.0.0" + cacheable-request "^10.2.8" + decompress-response "^6.0.0" + form-data-encoder "^2.1.2" + get-stream "^6.0.1" + http2-wrapper "^2.1.10" + lowercase-keys "^3.0.0" + p-cancelable "^3.0.0" + responselike "^3.0.0" + +graceful-fs@4.2.10: + version "4.2.10" + resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.10.tgz#147d3a006da4ca3ce14728c7aefc287c367d7a6c" + integrity sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA== + +graceful-fs@^4.1.2, graceful-fs@^4.1.6, graceful-fs@^4.2.0, graceful-fs@^4.2.11, graceful-fs@^4.2.4, graceful-fs@^4.2.6, graceful-fs@^4.2.9: + version "4.2.11" + resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.11.tgz#4183e4e8bf08bb6e05bbb2f7d2e0c8f712ca40e3" + integrity sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ== + +gray-matter@^4.0.3: + version "4.0.3" + resolved "https://registry.yarnpkg.com/gray-matter/-/gray-matter-4.0.3.tgz#e893c064825de73ea1f5f7d88c7a9f7274288798" + integrity sha512-5v6yZd4JK3eMI3FqqCouswVqwugaA9r4dNZB1wwcmrD02QkV5H0y7XBQW8QwQqEaZY1pM9aqORSORhJRdNK44Q== + dependencies: + js-yaml "^3.13.1" + kind-of "^6.0.2" + section-matter "^1.0.0" + strip-bom-string "^1.0.0" + +gzip-size@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/gzip-size/-/gzip-size-6.0.0.tgz#065367fd50c239c0671cbcbad5be3e2eeb10e462" + integrity sha512-ax7ZYomf6jqPTQ4+XCpUGyXKHk5WweS+e05MBO4/y3WJ5RkmPXNKvX+bx1behVILVwr6JSQvZAku021CHPXG3Q== + dependencies: + duplexer "^0.1.2" + +handle-thing@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/handle-thing/-/handle-thing-2.0.1.tgz#857f79ce359580c340d43081cc648970d0bb234e" + integrity sha512-9Qn4yBxelxoh2Ow62nP+Ka/kMnOXRi8BXnRaUwezLNhqelnN49xKz4F/dPP8OYLxLxq6JDtZb2i9XznUQbNPTg== + +has-flag@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-4.0.0.tgz#944771fd9c81c81265c4d6941860da06bb59479b" + integrity sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ== + +has-property-descriptors@^1.0.0, has-property-descriptors@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz#963ed7d071dc7bf5f084c5bfbe0d1b6222586854" + integrity sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg== + dependencies: + es-define-property "^1.0.0" + +has-symbols@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/has-symbols/-/has-symbols-1.1.0.tgz#fc9c6a783a084951d0b971fe1018de813707a338" + integrity sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ== + +has-yarn@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/has-yarn/-/has-yarn-3.0.0.tgz#c3c21e559730d1d3b57e28af1f30d06fac38147d" + integrity sha512-IrsVwUHhEULx3R8f/aA8AHuEzAorplsab/v8HBzEiIukwq5i/EC+xmOW+HfP1OaDP+2JkgT1yILHN2O3UFIbcA== + +hasown@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/hasown/-/hasown-2.0.2.tgz#003eaf91be7adc372e84ec59dc37252cedb80003" + integrity sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ== + dependencies: + function-bind "^1.1.2" + +hast-util-from-parse5@^8.0.0: + version "8.0.3" + resolved "https://registry.yarnpkg.com/hast-util-from-parse5/-/hast-util-from-parse5-8.0.3.tgz#830a35022fff28c3fea3697a98c2f4cc6b835a2e" + integrity sha512-3kxEVkEKt0zvcZ3hCRYI8rqrgwtlIOFMWkbclACvjlDw8Li9S2hk/d51OI0nr/gIpdMHNepwgOKqZ/sy0Clpyg== + dependencies: + "@types/hast" "^3.0.0" + "@types/unist" "^3.0.0" + devlop "^1.0.0" + hastscript "^9.0.0" + property-information "^7.0.0" + vfile "^6.0.0" + vfile-location "^5.0.0" + web-namespaces "^2.0.0" + +hast-util-parse-selector@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/hast-util-parse-selector/-/hast-util-parse-selector-4.0.0.tgz#352879fa86e25616036037dd8931fb5f34cb4a27" + integrity sha512-wkQCkSYoOGCRKERFWcxMVMOcYE2K1AaNLU8DXS9arxnLOUEWbOXKXiJUNzEpqZ3JOKpnha3jkFrumEjVliDe7A== + dependencies: + "@types/hast" "^3.0.0" + +hast-util-raw@^9.0.0: + version "9.1.0" + resolved "https://registry.yarnpkg.com/hast-util-raw/-/hast-util-raw-9.1.0.tgz#79b66b26f6f68fb50dfb4716b2cdca90d92adf2e" + integrity sha512-Y8/SBAHkZGoNkpzqqfCldijcuUKh7/su31kEBp67cFY09Wy0mTRgtsLYsiIxMJxlu0f6AA5SUTbDR8K0rxnbUw== + dependencies: + "@types/hast" "^3.0.0" + "@types/unist" "^3.0.0" + "@ungap/structured-clone" "^1.0.0" + hast-util-from-parse5 "^8.0.0" + hast-util-to-parse5 "^8.0.0" + html-void-elements "^3.0.0" + mdast-util-to-hast "^13.0.0" + parse5 "^7.0.0" + unist-util-position "^5.0.0" + unist-util-visit "^5.0.0" + vfile "^6.0.0" + web-namespaces "^2.0.0" + zwitch "^2.0.0" + +hast-util-to-estree@^3.0.0: + version "3.1.3" + resolved "https://registry.yarnpkg.com/hast-util-to-estree/-/hast-util-to-estree-3.1.3.tgz#e654c1c9374645135695cc0ab9f70b8fcaf733d7" + integrity sha512-48+B/rJWAp0jamNbAAf9M7Uf//UVqAoMmgXhBdxTDJLGKY+LRnZ99qcG+Qjl5HfMpYNzS5v4EAwVEF34LeAj7w== + dependencies: + "@types/estree" "^1.0.0" + "@types/estree-jsx" "^1.0.0" + "@types/hast" "^3.0.0" + comma-separated-tokens "^2.0.0" + devlop "^1.0.0" + estree-util-attach-comments "^3.0.0" + estree-util-is-identifier-name "^3.0.0" + hast-util-whitespace "^3.0.0" + mdast-util-mdx-expression "^2.0.0" + mdast-util-mdx-jsx "^3.0.0" + mdast-util-mdxjs-esm "^2.0.0" + property-information "^7.0.0" + space-separated-tokens "^2.0.0" + style-to-js "^1.0.0" + unist-util-position "^5.0.0" + zwitch "^2.0.0" + +hast-util-to-jsx-runtime@^2.0.0: + version "2.3.6" + resolved "https://registry.yarnpkg.com/hast-util-to-jsx-runtime/-/hast-util-to-jsx-runtime-2.3.6.tgz#ff31897aae59f62232e21594eac7ef6b63333e98" + integrity sha512-zl6s8LwNyo1P9uw+XJGvZtdFF1GdAkOg8ujOw+4Pyb76874fLps4ueHXDhXWdk6YHQ6OgUtinliG7RsYvCbbBg== + dependencies: + "@types/estree" "^1.0.0" + "@types/hast" "^3.0.0" + "@types/unist" "^3.0.0" + comma-separated-tokens "^2.0.0" + devlop "^1.0.0" + estree-util-is-identifier-name "^3.0.0" + hast-util-whitespace "^3.0.0" + mdast-util-mdx-expression "^2.0.0" + mdast-util-mdx-jsx "^3.0.0" + mdast-util-mdxjs-esm "^2.0.0" + property-information "^7.0.0" + space-separated-tokens "^2.0.0" + style-to-js "^1.0.0" + unist-util-position "^5.0.0" + vfile-message "^4.0.0" + +hast-util-to-parse5@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/hast-util-to-parse5/-/hast-util-to-parse5-8.0.0.tgz#477cd42d278d4f036bc2ea58586130f6f39ee6ed" + integrity sha512-3KKrV5ZVI8if87DVSi1vDeByYrkGzg4mEfeu4alwgmmIeARiBLKCZS2uw5Gb6nU9x9Yufyj3iudm6i7nl52PFw== + dependencies: + "@types/hast" "^3.0.0" + comma-separated-tokens "^2.0.0" + devlop "^1.0.0" + property-information "^6.0.0" + space-separated-tokens "^2.0.0" + web-namespaces "^2.0.0" + zwitch "^2.0.0" + +hast-util-whitespace@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/hast-util-whitespace/-/hast-util-whitespace-3.0.0.tgz#7778ed9d3c92dd9e8c5c8f648a49c21fc51cb621" + integrity sha512-88JUN06ipLwsnv+dVn+OIYOvAuvBMy/Qoi6O7mQHxdPXpjy+Cd6xRkWwux7DKO+4sYILtLBRIKgsdpS2gQc7qw== + dependencies: + "@types/hast" "^3.0.0" + +hastscript@^9.0.0: + version "9.0.1" + resolved "https://registry.yarnpkg.com/hastscript/-/hastscript-9.0.1.tgz#dbc84bef6051d40084342c229c451cd9dc567dff" + integrity sha512-g7df9rMFX/SPi34tyGCyUBREQoKkapwdY/T04Qn9TDWfHhAYt4/I0gMVirzK5wEzeUqIjEB+LXC/ypb7Aqno5w== + dependencies: + "@types/hast" "^3.0.0" + comma-separated-tokens "^2.0.0" + hast-util-parse-selector "^4.0.0" + property-information "^7.0.0" + space-separated-tokens "^2.0.0" + +he@^1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/he/-/he-1.2.0.tgz#84ae65fa7eafb165fddb61566ae14baf05664f0f" + integrity sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw== + +history@^4.9.0: + version "4.10.1" + resolved "https://registry.yarnpkg.com/history/-/history-4.10.1.tgz#33371a65e3a83b267434e2b3f3b1b4c58aad4cf3" + integrity sha512-36nwAD620w12kuzPAsyINPWJqlNbij+hpK1k9XRloDtym8mxzGYl2c17LnV6IAGB2Dmg4tEa7G7DlawS0+qjew== + dependencies: + "@babel/runtime" "^7.1.2" + loose-envify "^1.2.0" + resolve-pathname "^3.0.0" + tiny-invariant "^1.0.2" + tiny-warning "^1.0.0" + value-equal "^1.0.1" + +hoist-non-react-statics@^3.1.0, hoist-non-react-statics@^3.3.1: + version "3.3.2" + resolved "https://registry.yarnpkg.com/hoist-non-react-statics/-/hoist-non-react-statics-3.3.2.tgz#ece0acaf71d62c2969c2ec59feff42a4b1a85b45" + integrity sha512-/gGivxi8JPKWNm/W0jSmzcMPpfpPLc3dY/6GxhX2hQ9iGj3aDfklV4ET7NjKpSinLpJ5vafa9iiGIEZg10SfBw== + dependencies: + react-is "^16.7.0" + +hpack.js@^2.1.6: + version "2.1.6" + resolved "https://registry.yarnpkg.com/hpack.js/-/hpack.js-2.1.6.tgz#87774c0949e513f42e84575b3c45681fade2a0b2" + integrity sha512-zJxVehUdMGIKsRaNt7apO2Gqp0BdqW5yaiGHXXmbpvxgBYVZnAql+BJb4RO5ad2MgpbZKn5G6nMnegrH1FcNYQ== + dependencies: + inherits "^2.0.1" + obuf "^1.0.0" + readable-stream "^2.0.1" + wbuf "^1.1.0" + +html-entities@^2.3.2: + version "2.6.0" + resolved "https://registry.yarnpkg.com/html-entities/-/html-entities-2.6.0.tgz#7c64f1ea3b36818ccae3d3fb48b6974208e984f8" + integrity sha512-kig+rMn/QOVRvr7c86gQ8lWXq+Hkv6CbAH1hLu+RG338StTpE8Z0b44SDVaqVu7HGKf27frdmUYEs9hTUX/cLQ== + +html-escaper@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/html-escaper/-/html-escaper-2.0.2.tgz#dfd60027da36a36dfcbe236262c00a5822681453" + integrity sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg== + +html-minifier-terser@^6.0.2: + version "6.1.0" + resolved "https://registry.yarnpkg.com/html-minifier-terser/-/html-minifier-terser-6.1.0.tgz#bfc818934cc07918f6b3669f5774ecdfd48f32ab" + integrity sha512-YXxSlJBZTP7RS3tWnQw74ooKa6L9b9i9QYXY21eUEvhZ3u9XLfv6OnFsQq6RxkhHygsaUMvYsZRV5rU/OVNZxw== + dependencies: + camel-case "^4.1.2" + clean-css "^5.2.2" + commander "^8.3.0" + he "^1.2.0" + param-case "^3.0.4" + relateurl "^0.2.7" + terser "^5.10.0" + +html-minifier-terser@^7.2.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/html-minifier-terser/-/html-minifier-terser-7.2.0.tgz#18752e23a2f0ed4b0f550f217bb41693e975b942" + integrity sha512-tXgn3QfqPIpGl9o+K5tpcj3/MN4SfLtsx2GWwBC3SSd0tXQGyF3gsSqad8loJgKZGM3ZxbYDd5yhiBIdWpmvLA== + dependencies: + camel-case "^4.1.2" + clean-css "~5.3.2" + commander "^10.0.0" + entities "^4.4.0" + param-case "^3.0.4" + relateurl "^0.2.7" + terser "^5.15.1" + +html-tags@^3.3.1: + version "3.3.1" + resolved "https://registry.yarnpkg.com/html-tags/-/html-tags-3.3.1.tgz#a04026a18c882e4bba8a01a3d39cfe465d40b5ce" + integrity sha512-ztqyC3kLto0e9WbNp0aeP+M3kTt+nbaIveGmUxAtZa+8iFgKLUOD4YKM5j+f3QD89bra7UeumolZHKuOXnTmeQ== + +html-void-elements@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/html-void-elements/-/html-void-elements-3.0.0.tgz#fc9dbd84af9e747249034d4d62602def6517f1d7" + integrity sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg== + +html-webpack-plugin@^5.6.0: + version "5.6.4" + resolved "https://registry.yarnpkg.com/html-webpack-plugin/-/html-webpack-plugin-5.6.4.tgz#d8cb0f7edff7745ae7d6cccb0bff592e9f7f7959" + integrity sha512-V/PZeWsqhfpE27nKeX9EO2sbR+D17A+tLf6qU+ht66jdUsN0QLKJN27Z+1+gHrVMKgndBahes0PU6rRihDgHTw== + dependencies: + "@types/html-minifier-terser" "^6.0.0" + html-minifier-terser "^6.0.2" + lodash "^4.17.21" + pretty-error "^4.0.0" + tapable "^2.0.0" + +htmlparser2@^6.1.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/htmlparser2/-/htmlparser2-6.1.0.tgz#c4d762b6c3371a05dbe65e94ae43a9f845fb8fb7" + integrity sha512-gyyPk6rgonLFEDGoeRgQNaEUvdJ4ktTmmUh/h2t7s+M8oPpIPxgNACWa+6ESR57kXstwqPiCut0V8NRpcwgU7A== + dependencies: + domelementtype "^2.0.1" + domhandler "^4.0.0" + domutils "^2.5.2" + entities "^2.0.0" + +htmlparser2@^8.0.1: + version "8.0.2" + resolved "https://registry.yarnpkg.com/htmlparser2/-/htmlparser2-8.0.2.tgz#f002151705b383e62433b5cf466f5b716edaec21" + integrity sha512-GYdjWKDkbRLkZ5geuHs5NY1puJ+PXwP7+fHPRz06Eirsb9ugf6d8kkXav6ADhcODhFFPMIXyxkxSuMf3D6NCFA== + dependencies: + domelementtype "^2.3.0" + domhandler "^5.0.3" + domutils "^3.0.1" + entities "^4.4.0" + +http-cache-semantics@^4.1.1: + version "4.2.0" + resolved "https://registry.yarnpkg.com/http-cache-semantics/-/http-cache-semantics-4.2.0.tgz#205f4db64f8562b76a4ff9235aa5279839a09dd5" + integrity sha512-dTxcvPXqPvXBQpq5dUr6mEMJX4oIEFv6bwom3FDwKRDsuIjjJGANqhBuoAn9c1RQJIdAKav33ED65E2ys+87QQ== + +http-deceiver@^1.2.7: + version "1.2.7" + resolved "https://registry.yarnpkg.com/http-deceiver/-/http-deceiver-1.2.7.tgz#fa7168944ab9a519d337cb0bec7284dc3e723d87" + integrity sha512-LmpOGxTfbpgtGVxJrj5k7asXHCgNZp5nLfp+hWc8QQRqtb7fUy6kRY3BO1h9ddF6yIPYUARgxGOwB42DnxIaNw== + +http-errors@2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/http-errors/-/http-errors-2.0.0.tgz#b7774a1486ef73cf7667ac9ae0858c012c57b9d3" + integrity sha512-FtwrG/euBzaEjYeRqOgly7G0qviiXoJWnvEH2Z1plBdXgbyjv34pHTSb9zoeHMyDy33+DWy5Wt9Wo+TURtOYSQ== + dependencies: + depd "2.0.0" + inherits "2.0.4" + setprototypeof "1.2.0" + statuses "2.0.1" + toidentifier "1.0.1" + +http-errors@~1.6.2: + version "1.6.3" + resolved "https://registry.yarnpkg.com/http-errors/-/http-errors-1.6.3.tgz#8b55680bb4be283a0b5bf4ea2e38580be1d9320d" + integrity sha512-lks+lVC8dgGyh97jxvxeYTWQFvh4uw4yC12gVl63Cg30sjPX4wuGcdkICVXDAESr6OJGjqGA8Iz5mkeN6zlD7A== + dependencies: + depd "~1.1.2" + inherits "2.0.3" + setprototypeof "1.1.0" + statuses ">= 1.4.0 < 2" + +http-parser-js@>=0.5.1: + version "0.5.10" + resolved "https://registry.yarnpkg.com/http-parser-js/-/http-parser-js-0.5.10.tgz#b3277bd6d7ed5588e20ea73bf724fcbe44609075" + integrity sha512-Pysuw9XpUq5dVc/2SMHpuTY01RFl8fttgcyunjL7eEMhGM3cI4eOmiCycJDVCo/7O7ClfQD3SaI6ftDzqOXYMA== + +http-proxy-middleware@^2.0.3: + version "2.0.9" + resolved "https://registry.yarnpkg.com/http-proxy-middleware/-/http-proxy-middleware-2.0.9.tgz#e9e63d68afaa4eee3d147f39149ab84c0c2815ef" + integrity sha512-c1IyJYLYppU574+YI7R4QyX2ystMtVXZwIdzazUIPIJsHuWNd+mho2j+bKoHftndicGj9yh+xjd+l0yj7VeT1Q== + dependencies: + "@types/http-proxy" "^1.17.8" + http-proxy "^1.18.1" + is-glob "^4.0.1" + is-plain-obj "^3.0.0" + micromatch "^4.0.2" + +http-proxy@^1.18.1: + version "1.18.1" + resolved "https://registry.yarnpkg.com/http-proxy/-/http-proxy-1.18.1.tgz#401541f0534884bbf95260334e72f88ee3976549" + integrity sha512-7mz/721AbnJwIVbnaSv1Cz3Am0ZLT/UBwkC92VlxhXv/k/BBQfM2fXElQNC27BVGr0uwUpplYPQM9LnaBMR5NQ== + dependencies: + eventemitter3 "^4.0.0" + follow-redirects "^1.0.0" + requires-port "^1.0.0" + +http2-wrapper@^2.1.10: + version "2.2.1" + resolved "https://registry.yarnpkg.com/http2-wrapper/-/http2-wrapper-2.2.1.tgz#310968153dcdedb160d8b72114363ef5fce1f64a" + integrity sha512-V5nVw1PAOgfI3Lmeaj2Exmeg7fenjhRUgz1lPSezy1CuhPYbgQtbQj4jZfEAEMlaL+vupsvhjqCyjzob0yxsmQ== + dependencies: + quick-lru "^5.1.1" + resolve-alpn "^1.2.0" + +human-signals@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0" + integrity sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw== + +iconv-lite@0.4.24: + version "0.4.24" + resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.24.tgz#2022b4b25fbddc21d2f524974a474aafe733908b" + integrity sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA== + dependencies: + safer-buffer ">= 2.1.2 < 3" + +icss-utils@^5.0.0, icss-utils@^5.1.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/icss-utils/-/icss-utils-5.1.0.tgz#c6be6858abd013d768e98366ae47e25d5887b1ae" + integrity sha512-soFhflCVWLfRNOPU3iv5Z9VUdT44xFRbzjLsEzSr5AQmgqPMTHdU3PMT1Cf1ssx8fLNJDA1juftYl+PUcv3MqA== + +ignore@^5.2.0, ignore@^5.2.4: + version "5.3.2" + resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.3.2.tgz#3cd40e729f3643fd87cb04e50bf0eb722bc596f5" + integrity sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g== + +image-size@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/image-size/-/image-size-2.0.2.tgz#84a7b43704db5736f364bf0d1b029821299b4bdc" + integrity sha512-IRqXKlaXwgSMAMtpNzZa1ZAe8m+Sa1770Dhk8VkSsP9LS+iHD62Zd8FQKs8fbPiagBE7BzoFX23cxFnwshpV6w== + +import-fresh@^3.2.1, import-fresh@^3.3.0: + version "3.3.1" + resolved "https://registry.yarnpkg.com/import-fresh/-/import-fresh-3.3.1.tgz#9cecb56503c0ada1f2741dbbd6546e4b13b57ccf" + integrity sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ== + dependencies: + parent-module "^1.0.0" + resolve-from "^4.0.0" + +import-lazy@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/import-lazy/-/import-lazy-4.0.0.tgz#e8eb627483a0a43da3c03f3e35548be5cb0cc153" + integrity sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw== + +imurmurhash@^0.1.4: + version "0.1.4" + resolved "https://registry.yarnpkg.com/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea" + integrity sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA== + +indent-string@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/indent-string/-/indent-string-4.0.0.tgz#624f8f4497d619b2d9768531d58f4122854d7251" + integrity sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg== + +infima@0.2.0-alpha.45: + version "0.2.0-alpha.45" + resolved "https://registry.yarnpkg.com/infima/-/infima-0.2.0-alpha.45.tgz#542aab5a249274d81679631b492973dd2c1e7466" + integrity sha512-uyH0zfr1erU1OohLk0fT4Rrb94AOhguWNOcD9uGrSpRvNB+6gZXUoJX5J0NtvzBO10YZ9PgvA4NFgt+fYg8ojw== + +inflight@^1.0.4: + version "1.0.6" + resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" + integrity sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA== + dependencies: + once "^1.3.0" + wrappy "1" + +inherits@2, inherits@2.0.4, inherits@^2.0.1, inherits@^2.0.3, inherits@~2.0.3: + version "2.0.4" + resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" + integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== + +inherits@2.0.3: + version "2.0.3" + resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.3.tgz#633c2c83e3da42a502f52466022480f4208261de" + integrity sha512-x00IRNXNy63jwGkJmzPigoySHbaqpNuzKbBOmzK+g2OdZpQ9w+sxCN+VSB3ja7IAge2OP2qpfxTjeNcyjmW1uw== + +ini@2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/ini/-/ini-2.0.0.tgz#e5fd556ecdd5726be978fa1001862eacb0a94bc5" + integrity sha512-7PnF4oN3CvZF23ADhA5wRaYEQpJ8qygSkbtTXWBeXWXmEVRXK+1ITciHWwHhsjv1TmW0MgacIv6hEi5pX5NQdA== + +ini@^1.3.4, ini@~1.3.0: + version "1.3.8" + resolved "https://registry.yarnpkg.com/ini/-/ini-1.3.8.tgz#a29da425b48806f34767a4efce397269af28432c" + integrity sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew== + +inline-style-parser@0.2.4: + version "0.2.4" + resolved "https://registry.yarnpkg.com/inline-style-parser/-/inline-style-parser-0.2.4.tgz#f4af5fe72e612839fcd453d989a586566d695f22" + integrity sha512-0aO8FkhNZlj/ZIbNi7Lxxr12obT7cL1moPfE4tg1LkX7LlLfC6DeX4l2ZEud1ukP9jNQyNnfzQVqwbwmAATY4Q== + +invariant@^2.2.4: + version "2.2.4" + resolved "https://registry.yarnpkg.com/invariant/-/invariant-2.2.4.tgz#610f3c92c9359ce1db616e538008d23ff35158e6" + integrity sha512-phJfQVBuaJM5raOpJjSfkiD6BpbCE4Ns//LaXl6wGYtUBY83nWS6Rf9tXm2e8VaK60JEjYldbPif/A2B1C2gNA== + dependencies: + loose-envify "^1.0.0" + +ipaddr.js@1.9.1: + version "1.9.1" + resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-1.9.1.tgz#bff38543eeb8984825079ff3a2a8e6cbd46781b3" + integrity sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g== + +ipaddr.js@^2.0.1: + version "2.2.0" + resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-2.2.0.tgz#d33fa7bac284f4de7af949638c9d68157c6b92e8" + integrity sha512-Ag3wB2o37wslZS19hZqorUnrnzSkpOVy+IiiDEiTqNubEYpYuHWIf6K4psgN2ZWKExS4xhVCrRVfb/wfW8fWJA== + +is-alphabetical@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-alphabetical/-/is-alphabetical-2.0.1.tgz#01072053ea7c1036df3c7d19a6daaec7f19e789b" + integrity sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ== + +is-alphanumerical@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-alphanumerical/-/is-alphanumerical-2.0.1.tgz#7c03fbe96e3e931113e57f964b0a368cc2dfd875" + integrity sha512-hmbYhX/9MUMF5uh7tOXyK/n0ZvWpad5caBA17GsC6vyuCqaWliRG5K1qS9inmUhEMaOBIW7/whAnSwveW/LtZw== + dependencies: + is-alphabetical "^2.0.0" + is-decimal "^2.0.0" + +is-arrayish@^0.2.1: + version "0.2.1" + resolved "https://registry.yarnpkg.com/is-arrayish/-/is-arrayish-0.2.1.tgz#77c99840527aa8ecb1a8ba697b80645a7a926a9d" + integrity sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg== + +is-binary-path@~2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/is-binary-path/-/is-binary-path-2.1.0.tgz#ea1f7f3b80f064236e83470f86c09c254fb45b09" + integrity sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw== + dependencies: + binary-extensions "^2.0.0" + +is-ci@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/is-ci/-/is-ci-3.0.1.tgz#db6ecbed1bd659c43dac0f45661e7674103d1867" + integrity sha512-ZYvCgrefwqoQ6yTyYUbQu64HsITZ3NfKX1lzaEYdkTDcfKzzCI/wthRRYKkdjHKFVgNiXKAKm65Zo1pk2as/QQ== + dependencies: + ci-info "^3.2.0" + +is-core-module@^2.16.0: + version "2.16.1" + resolved "https://registry.yarnpkg.com/is-core-module/-/is-core-module-2.16.1.tgz#2a98801a849f43e2add644fbb6bc6229b19a4ef4" + integrity sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w== + dependencies: + hasown "^2.0.2" + +is-decimal@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-decimal/-/is-decimal-2.0.1.tgz#9469d2dc190d0214fd87d78b78caecc0cc14eef7" + integrity sha512-AAB9hiomQs5DXWcRB1rqsxGUstbRroFOPPVAomNk/3XHR5JyEZChOyTWe2oayKnsSsr/kcGqF+z6yuH6HHpN0A== + +is-docker@^2.0.0, is-docker@^2.1.1: + version "2.2.1" + resolved "https://registry.yarnpkg.com/is-docker/-/is-docker-2.2.1.tgz#33eeabe23cfe86f14bde4408a02c0cfb853acdaa" + integrity sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ== + +is-extendable@^0.1.0: + version "0.1.1" + resolved "https://registry.yarnpkg.com/is-extendable/-/is-extendable-0.1.1.tgz#62b110e289a471418e3ec36a617d472e301dfc89" + integrity sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw== + +is-extglob@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/is-extglob/-/is-extglob-2.1.1.tgz#a88c02535791f02ed37c76a1b9ea9773c833f8c2" + integrity sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ== + +is-fullwidth-code-point@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz#f116f8064fe90b3f7844a38997c0b75051269f1d" + integrity sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg== + +is-glob@^4.0.1, is-glob@^4.0.3, is-glob@~4.0.1: + version "4.0.3" + resolved "https://registry.yarnpkg.com/is-glob/-/is-glob-4.0.3.tgz#64f61e42cbbb2eec2071a9dac0b28ba1e65d5084" + integrity sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg== + dependencies: + is-extglob "^2.1.1" + +is-hexadecimal@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz#86b5bf668fca307498d319dfc03289d781a90027" + integrity sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg== + +is-installed-globally@^0.4.0: + version "0.4.0" + resolved "https://registry.yarnpkg.com/is-installed-globally/-/is-installed-globally-0.4.0.tgz#9a0fd407949c30f86eb6959ef1b7994ed0b7b520" + integrity sha512-iwGqO3J21aaSkC7jWnHP/difazwS7SFeIqxv6wEtLU8Y5KlzFTjyqcSIT0d8s4+dDhKytsk9PJZ2BkS5eZwQRQ== + dependencies: + global-dirs "^3.0.0" + is-path-inside "^3.0.2" + +is-npm@^6.0.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/is-npm/-/is-npm-6.1.0.tgz#f70e0b6c132dfc817ac97d3badc0134945b098d3" + integrity sha512-O2z4/kNgyjhQwVR1Wpkbfc19JIhggF97NZNCpWTnjH7kVcZMUrnut9XSN7txI7VdyIYk5ZatOq3zvSuWpU8hoA== + +is-number@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b" + integrity sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng== + +is-obj@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/is-obj/-/is-obj-1.0.1.tgz#3e4729ac1f5fde025cd7d83a896dab9f4f67db0f" + integrity sha512-l4RyHgRqGN4Y3+9JHVrNqO+tN0rV5My76uW5/nuO4K1b6vw5G8d/cmFjP9tRfEsdhZNt0IFdZuK/c2Vr4Nb+Qg== + +is-obj@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/is-obj/-/is-obj-2.0.0.tgz#473fb05d973705e3fd9620545018ca8e22ef4982" + integrity sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w== + +is-path-inside@^3.0.2: + version "3.0.3" + resolved "https://registry.yarnpkg.com/is-path-inside/-/is-path-inside-3.0.3.tgz#d231362e53a07ff2b0e0ea7fed049161ffd16283" + integrity sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ== + +is-plain-obj@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/is-plain-obj/-/is-plain-obj-3.0.0.tgz#af6f2ea14ac5a646183a5bbdb5baabbc156ad9d7" + integrity sha512-gwsOE28k+23GP1B6vFl1oVh/WOzmawBrKwo5Ev6wMKzPkaXaCDIQKzLnvsA42DRlbVTWorkgTKIviAKCWkfUwA== + +is-plain-obj@^4.0.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/is-plain-obj/-/is-plain-obj-4.1.0.tgz#d65025edec3657ce032fd7db63c97883eaed71f0" + integrity sha512-+Pgi+vMuUNkJyExiMBt5IlFoMyKnr5zhJ4Uspz58WOhBF5QoIZkFyNHIbBAtHwzVAgk5RtndVNsDRN61/mmDqg== + +is-plain-object@^2.0.4: + version "2.0.4" + resolved "https://registry.yarnpkg.com/is-plain-object/-/is-plain-object-2.0.4.tgz#2c163b3fafb1b606d9d17928f05c2a1c38e07677" + integrity sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og== + dependencies: + isobject "^3.0.1" + +is-regexp@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/is-regexp/-/is-regexp-1.0.0.tgz#fd2d883545c46bac5a633e7b9a09e87fa2cb5069" + integrity sha512-7zjFAPO4/gwyQAAgRRmqeEeyIICSdmCqa3tsVHMdBzaXXRiqopZL4Cyghg/XulGWrtABTpbnYYzzIRffLkP4oA== + +is-stream@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-stream/-/is-stream-2.0.1.tgz#fac1e3d53b97ad5a9d0ae9cef2389f5810a5c077" + integrity sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg== + +is-typedarray@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/is-typedarray/-/is-typedarray-1.0.0.tgz#e479c80858df0c1b11ddda6940f96011fcda4a9a" + integrity sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA== + +is-wsl@^2.2.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/is-wsl/-/is-wsl-2.2.0.tgz#74a4c76e77ca9fd3f932f290c17ea326cd157271" + integrity sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww== + dependencies: + is-docker "^2.0.0" + +is-yarn-global@^0.4.0: + version "0.4.1" + resolved "https://registry.yarnpkg.com/is-yarn-global/-/is-yarn-global-0.4.1.tgz#b312d902b313f81e4eaf98b6361ba2b45cd694bb" + integrity sha512-/kppl+R+LO5VmhYSEWARUFjodS25D68gvj8W7z0I7OWhUla5xWu8KL6CtB2V0R6yqhnRgbcaREMr4EEM6htLPQ== + +isarray@0.0.1: + version "0.0.1" + resolved "https://registry.yarnpkg.com/isarray/-/isarray-0.0.1.tgz#8a18acfca9a8f4177e09abfc6038939b05d1eedf" + integrity sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ== + +isarray@~1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/isarray/-/isarray-1.0.0.tgz#bb935d48582cba168c06834957a54a3e07124f11" + integrity sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ== + +isexe@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10" + integrity sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw== + +isobject@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/isobject/-/isobject-3.0.1.tgz#4e431e92b11a9731636aa1f9c8d1ccbcfdab78df" + integrity sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg== + +jest-util@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-util/-/jest-util-29.7.0.tgz#23c2b62bfb22be82b44de98055802ff3710fc0bc" + integrity sha512-z6EbKajIpqGKU56y5KBUgy1dt1ihhQJgWzUlZHArA/+X2ad7Cb5iF+AK1EWVL/Bo7Rz9uurpqw6SiBCefUbCGA== + dependencies: + "@jest/types" "^29.6.3" + "@types/node" "*" + chalk "^4.0.0" + ci-info "^3.2.0" + graceful-fs "^4.2.9" + picomatch "^2.2.3" + +jest-worker@^27.4.5: + version "27.5.1" + resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-27.5.1.tgz#8d146f0900e8973b106b6f73cc1e9a8cb86f8db0" + integrity sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg== + dependencies: + "@types/node" "*" + merge-stream "^2.0.0" + supports-color "^8.0.0" + +jest-worker@^29.4.3: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-29.7.0.tgz#acad073acbbaeb7262bd5389e1bcf43e10058d4a" + integrity sha512-eIz2msL/EzL9UFTFFx7jBTkeZfku0yUAyZZZmJ93H2TYEiroIx2PQjEXcwYtYl8zXCxb+PAmA2hLIt/6ZEkPHw== + dependencies: + "@types/node" "*" + jest-util "^29.7.0" + merge-stream "^2.0.0" + supports-color "^8.0.0" + +jiti@^1.20.0: + version "1.21.7" + resolved "https://registry.yarnpkg.com/jiti/-/jiti-1.21.7.tgz#9dd81043424a3d28458b193d965f0d18a2300ba9" + integrity sha512-/imKNG4EbWNrVjoNC/1H5/9GFy+tqjGBHCaSsN+P2RnPqjsLmv6UD3Ej+Kj8nBWaRAwyk7kK5ZUc+OEatnTR3A== + +joi@^17.9.2: + version "17.13.3" + resolved "https://registry.yarnpkg.com/joi/-/joi-17.13.3.tgz#0f5cc1169c999b30d344366d384b12d92558bcec" + integrity sha512-otDA4ldcIx+ZXsKHWmp0YizCweVRZG96J10b0FevjfuncLO1oX59THoAmHkNubYJ+9gWsYsp5k8v4ib6oDv1fA== + dependencies: + "@hapi/hoek" "^9.3.0" + "@hapi/topo" "^5.1.0" + "@sideway/address" "^4.1.5" + "@sideway/formula" "^3.0.1" + "@sideway/pinpoint" "^2.0.0" + +"js-tokens@^3.0.0 || ^4.0.0", js-tokens@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499" + integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== + +js-yaml@^3.13.1: + version "3.14.1" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.14.1.tgz#dae812fdb3825fa306609a8717383c50c36a0537" + integrity sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g== + dependencies: + argparse "^1.0.7" + esprima "^4.0.0" + +js-yaml@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.1.0.tgz#c1fb65f8f5017901cdd2c951864ba18458a10602" + integrity sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA== + dependencies: + argparse "^2.0.1" + +jsesc@^3.0.2: + version "3.1.0" + resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-3.1.0.tgz#74d335a234f67ed19907fdadfac7ccf9d409825d" + integrity sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA== + +jsesc@~3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-3.0.2.tgz#bb8b09a6597ba426425f2e4a07245c3d00b9343e" + integrity sha512-xKqzzWXDttJuOcawBt4KnKHHIf5oQ/Cxax+0PWFG+DFDgHNAdi+TXECADI+RYiFUMmx8792xsMbbgXj4CwnP4g== + +json-buffer@3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/json-buffer/-/json-buffer-3.0.1.tgz#9338802a30d3b6605fbe0613e094008ca8c05a13" + integrity sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ== + +json-parse-even-better-errors@^2.3.0, json-parse-even-better-errors@^2.3.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz#7c47805a94319928e05777405dc12e1f7a4ee02d" + integrity sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w== + +json-schema-traverse@^0.4.1: + version "0.4.1" + resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz#69f6a87d9513ab8bb8fe63bdb0979c448e684660" + integrity sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg== + +json-schema-traverse@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz#ae7bcb3656ab77a73ba5c49bf654f38e6b6860e2" + integrity sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug== + +json5@^2.1.2, json5@^2.2.3: + version "2.2.3" + resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.3.tgz#78cd6f1a19bdc12b73db5ad0c61efd66c1e29283" + integrity sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg== + +jsonfile@^6.0.1: + version "6.2.0" + resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-6.2.0.tgz#7c265bd1b65de6977478300087c99f1c84383f62" + integrity sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg== + dependencies: + universalify "^2.0.0" + optionalDependencies: + graceful-fs "^4.1.6" + +keyv@^4.5.3: + version "4.5.4" + resolved "https://registry.yarnpkg.com/keyv/-/keyv-4.5.4.tgz#a879a99e29452f942439f2a405e3af8b31d4de93" + integrity sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw== + dependencies: + json-buffer "3.0.1" + +kind-of@^6.0.0, kind-of@^6.0.2: + version "6.0.3" + resolved "https://registry.yarnpkg.com/kind-of/-/kind-of-6.0.3.tgz#07c05034a6c349fa06e24fa35aa76db4580ce4dd" + integrity sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw== + +kleur@^3.0.3: + version "3.0.3" + resolved "https://registry.yarnpkg.com/kleur/-/kleur-3.0.3.tgz#a79c9ecc86ee1ce3fa6206d1216c501f147fc07e" + integrity sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w== + +latest-version@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/latest-version/-/latest-version-7.0.0.tgz#843201591ea81a4d404932eeb61240fe04e9e5da" + integrity sha512-KvNT4XqAMzdcL6ka6Tl3i2lYeFDgXNCuIX+xNx6ZMVR1dFq+idXd9FLKNMOIx0t9mJ9/HudyX4oZWXZQ0UJHeg== + dependencies: + package-json "^8.1.0" + +launch-editor@^2.6.0: + version "2.11.1" + resolved "https://registry.yarnpkg.com/launch-editor/-/launch-editor-2.11.1.tgz#61a0b7314a42fd84a6cbb564573d9e9ffcf3d72b" + integrity sha512-SEET7oNfgSaB6Ym0jufAdCeo3meJVeCaaDyzRygy0xsp2BFKCprcfHljTq4QkzTLUxEKkFK6OK4811YM2oSrRg== + dependencies: + picocolors "^1.1.1" + shell-quote "^1.8.3" + +leven@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/leven/-/leven-3.1.0.tgz#77891de834064cccba82ae7842bb6b14a13ed7f2" + integrity sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A== + +lilconfig@^3.1.1: + version "3.1.3" + resolved "https://registry.yarnpkg.com/lilconfig/-/lilconfig-3.1.3.tgz#a1bcfd6257f9585bf5ae14ceeebb7b559025e4c4" + integrity sha512-/vlFKAoH5Cgt3Ie+JLhRbwOsCQePABiU3tJ1egGvyQ+33R/vcwM2Zl2QR/LzjsBeItPt3oSVXapn+m4nQDvpzw== + +lines-and-columns@^1.1.6: + version "1.2.4" + resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.2.4.tgz#eca284f75d2965079309dc0ad9255abb2ebc1632" + integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg== + +loader-runner@^4.2.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/loader-runner/-/loader-runner-4.3.0.tgz#c1b4a163b99f614830353b16755e7149ac2314e1" + integrity sha512-3R/1M+yS3j5ou80Me59j7F9IMs4PXs3VqRrm0TU3AbKPxlmpoY1TNscJV/oGJXo8qCatFGTfDbY6W6ipGOYXfg== + +loader-utils@^2.0.0: + version "2.0.4" + resolved "https://registry.yarnpkg.com/loader-utils/-/loader-utils-2.0.4.tgz#8b5cb38b5c34a9a018ee1fc0e6a066d1dfcc528c" + integrity sha512-xXqpXoINfFhgua9xiqD8fPFHgkoq1mmmpE92WlDbm9rNRd/EbRb+Gqf908T2DMfuHjjJlksiK2RbHVOdD/MqSw== + dependencies: + big.js "^5.2.2" + emojis-list "^3.0.0" + json5 "^2.1.2" + +locate-path@^7.1.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-7.2.0.tgz#69cb1779bd90b35ab1e771e1f2f89a202c2a8a8a" + integrity sha512-gvVijfZvn7R+2qyPX8mAuKcFGDf6Nc61GdvGafQsHL0sBIxfKzA+usWn4GFC/bk+QdwPUD4kWFJLhElipq+0VA== + dependencies: + p-locate "^6.0.0" + +lodash.debounce@^4.0.8: + version "4.0.8" + resolved "https://registry.yarnpkg.com/lodash.debounce/-/lodash.debounce-4.0.8.tgz#82d79bff30a67c4005ffd5e2515300ad9ca4d7af" + integrity sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow== + +lodash.memoize@^4.1.2: + version "4.1.2" + resolved "https://registry.yarnpkg.com/lodash.memoize/-/lodash.memoize-4.1.2.tgz#bcc6c49a42a2840ed997f323eada5ecd182e0bfe" + integrity sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag== + +lodash.uniq@^4.5.0: + version "4.5.0" + resolved "https://registry.yarnpkg.com/lodash.uniq/-/lodash.uniq-4.5.0.tgz#d0225373aeb652adc1bc82e4945339a842754773" + integrity sha512-xfBaXQd9ryd9dlSDvnvI0lvxfLJlYAZzXomUYzLKtUeOQvOP5piqAWuGtrhWeqaXK9hhoM/iyJc5AV+XfsX3HQ== + +lodash@^4.17.20, lodash@^4.17.21: + version "4.17.21" + resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c" + integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg== + +longest-streak@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/longest-streak/-/longest-streak-3.1.0.tgz#62fa67cd958742a1574af9f39866364102d90cd4" + integrity sha512-9Ri+o0JYgehTaVBBDoMqIl8GXtbWg711O3srftcHhZ0dqnETqLaoIK0x17fUw9rFSlK/0NlsKe0Ahhyl5pXE2g== + +loose-envify@^1.0.0, loose-envify@^1.2.0, loose-envify@^1.3.1, loose-envify@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/loose-envify/-/loose-envify-1.4.0.tgz#71ee51fa7be4caec1a63839f7e682d8132d30caf" + integrity sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q== + dependencies: + js-tokens "^3.0.0 || ^4.0.0" + +lower-case@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/lower-case/-/lower-case-2.0.2.tgz#6fa237c63dbdc4a82ca0fd882e4722dc5e634e28" + integrity sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg== + dependencies: + tslib "^2.0.3" + +lowercase-keys@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/lowercase-keys/-/lowercase-keys-3.0.0.tgz#c5e7d442e37ead247ae9db117a9d0a467c89d4f2" + integrity sha512-ozCC6gdQ+glXOQsveKD0YsDy8DSQFjDTz4zyzEHNV5+JP5D62LmfDZ6o1cycFx9ouG940M5dE8C8CTewdj2YWQ== + +lru-cache@^5.1.1: + version "5.1.1" + resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-5.1.1.tgz#1da27e6710271947695daf6848e847f01d84b920" + integrity sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w== + dependencies: + yallist "^3.0.2" + +markdown-extensions@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/markdown-extensions/-/markdown-extensions-2.0.0.tgz#34bebc83e9938cae16e0e017e4a9814a8330d3c4" + integrity sha512-o5vL7aDWatOTX8LzaS1WMoaoxIiLRQJuIKKe2wAw6IeULDHaqbiqiggmx+pKvZDb1Sj+pE46Sn1T7lCqfFtg1Q== + +markdown-table@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/markdown-table/-/markdown-table-2.0.0.tgz#194a90ced26d31fe753d8b9434430214c011865b" + integrity sha512-Ezda85ToJUBhM6WGaG6veasyym+Tbs3cMAw/ZhOPqXiYsr0jgocBV3j3nx+4lk47plLlIqjwuTm/ywVI+zjJ/A== + dependencies: + repeat-string "^1.0.0" + +markdown-table@^3.0.0: + version "3.0.4" + resolved "https://registry.yarnpkg.com/markdown-table/-/markdown-table-3.0.4.tgz#fe44d6d410ff9d6f2ea1797a3f60aa4d2b631c2a" + integrity sha512-wiYz4+JrLyb/DqW2hkFJxP7Vd7JuTDm77fvbM8VfEQdmSMqcImWeeRbHwZjBjIFki/VaMK2BhFi7oUUZeM5bqw== + +math-intrinsics@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/math-intrinsics/-/math-intrinsics-1.1.0.tgz#a0dd74be81e2aa5c2f27e65ce283605ee4e2b7f9" + integrity sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g== + +mdast-util-directive@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/mdast-util-directive/-/mdast-util-directive-3.1.0.tgz#f3656f4aab6ae3767d3c72cfab5e8055572ccba1" + integrity sha512-I3fNFt+DHmpWCYAT7quoM6lHf9wuqtI+oCOfvILnoicNIqjh5E3dEJWiXuYME2gNe8vl1iMQwyUHa7bgFmak6Q== + dependencies: + "@types/mdast" "^4.0.0" + "@types/unist" "^3.0.0" + ccount "^2.0.0" + devlop "^1.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + parse-entities "^4.0.0" + stringify-entities "^4.0.0" + unist-util-visit-parents "^6.0.0" + +mdast-util-find-and-replace@^3.0.0, mdast-util-find-and-replace@^3.0.1: + version "3.0.2" + resolved "https://registry.yarnpkg.com/mdast-util-find-and-replace/-/mdast-util-find-and-replace-3.0.2.tgz#70a3174c894e14df722abf43bc250cbae44b11df" + integrity sha512-Tmd1Vg/m3Xz43afeNxDIhWRtFZgM2VLyaf4vSTYwudTyeuTneoL3qtWMA5jeLyz/O1vDJmmV4QuScFCA2tBPwg== + dependencies: + "@types/mdast" "^4.0.0" + escape-string-regexp "^5.0.0" + unist-util-is "^6.0.0" + unist-util-visit-parents "^6.0.0" + +mdast-util-from-markdown@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/mdast-util-from-markdown/-/mdast-util-from-markdown-2.0.2.tgz#4850390ca7cf17413a9b9a0fbefcd1bc0eb4160a" + integrity sha512-uZhTV/8NBuw0WHkPTrCqDOl0zVe1BIng5ZtHoDk49ME1qqcjYmmLmOf0gELgcRMxN4w2iuIeVso5/6QymSrgmA== + dependencies: + "@types/mdast" "^4.0.0" + "@types/unist" "^3.0.0" + decode-named-character-reference "^1.0.0" + devlop "^1.0.0" + mdast-util-to-string "^4.0.0" + micromark "^4.0.0" + micromark-util-decode-numeric-character-reference "^2.0.0" + micromark-util-decode-string "^2.0.0" + micromark-util-normalize-identifier "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + unist-util-stringify-position "^4.0.0" + +mdast-util-frontmatter@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/mdast-util-frontmatter/-/mdast-util-frontmatter-2.0.1.tgz#f5f929eb1eb36c8a7737475c7eb438261f964ee8" + integrity sha512-LRqI9+wdgC25P0URIJY9vwocIzCcksduHQ9OF2joxQoyTNVduwLAFUzjoopuRJbJAReaKrNQKAZKL3uCMugWJA== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + escape-string-regexp "^5.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + micromark-extension-frontmatter "^2.0.0" + +mdast-util-gfm-autolink-literal@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/mdast-util-gfm-autolink-literal/-/mdast-util-gfm-autolink-literal-2.0.1.tgz#abd557630337bd30a6d5a4bd8252e1c2dc0875d5" + integrity sha512-5HVP2MKaP6L+G6YaxPNjuL0BPrq9orG3TsrZ9YXbA3vDw/ACI4MEsnoDpn6ZNm7GnZgtAcONJyPhOP8tNJQavQ== + dependencies: + "@types/mdast" "^4.0.0" + ccount "^2.0.0" + devlop "^1.0.0" + mdast-util-find-and-replace "^3.0.0" + micromark-util-character "^2.0.0" + +mdast-util-gfm-footnote@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/mdast-util-gfm-footnote/-/mdast-util-gfm-footnote-2.1.0.tgz#7778e9d9ca3df7238cc2bd3fa2b1bf6a65b19403" + integrity sha512-sqpDWlsHn7Ac9GNZQMeUzPQSMzR6Wv0WKRNvQRg0KqHh02fpTz69Qc1QSseNX29bhz1ROIyNyxExfawVKTm1GQ== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.1.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + micromark-util-normalize-identifier "^2.0.0" + +mdast-util-gfm-strikethrough@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/mdast-util-gfm-strikethrough/-/mdast-util-gfm-strikethrough-2.0.0.tgz#d44ef9e8ed283ac8c1165ab0d0dfd058c2764c16" + integrity sha512-mKKb915TF+OC5ptj5bJ7WFRPdYtuHv0yTRxK2tJvi+BDqbkiG7h7u/9SI89nRAYcmap2xHQL9D+QG/6wSrTtXg== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-gfm-table@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/mdast-util-gfm-table/-/mdast-util-gfm-table-2.0.0.tgz#7a435fb6223a72b0862b33afbd712b6dae878d38" + integrity sha512-78UEvebzz/rJIxLvE7ZtDd/vIQ0RHv+3Mh5DR96p7cS7HsBhYIICDBCu8csTNWNO6tBWfqXPWekRuj2FNOGOZg== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + markdown-table "^3.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-gfm-task-list-item@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/mdast-util-gfm-task-list-item/-/mdast-util-gfm-task-list-item-2.0.0.tgz#e68095d2f8a4303ef24094ab642e1047b991a936" + integrity sha512-IrtvNvjxC1o06taBAVJznEnkiHxLFTzgonUdy8hzFVeDun0uTjxxrRGVaNFqkU1wJR3RBPEfsxmU6jDWPofrTQ== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-gfm@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/mdast-util-gfm/-/mdast-util-gfm-3.1.0.tgz#2cdf63b92c2a331406b0fb0db4c077c1b0331751" + integrity sha512-0ulfdQOM3ysHhCJ1p06l0b0VKlhU0wuQs3thxZQagjcjPrlFRqY215uZGHHJan9GEAXd9MbfPjFJz+qMkVR6zQ== + dependencies: + mdast-util-from-markdown "^2.0.0" + mdast-util-gfm-autolink-literal "^2.0.0" + mdast-util-gfm-footnote "^2.0.0" + mdast-util-gfm-strikethrough "^2.0.0" + mdast-util-gfm-table "^2.0.0" + mdast-util-gfm-task-list-item "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-mdx-expression@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/mdast-util-mdx-expression/-/mdast-util-mdx-expression-2.0.1.tgz#43f0abac9adc756e2086f63822a38c8d3c3a5096" + integrity sha512-J6f+9hUp+ldTZqKRSg7Vw5V6MqjATc+3E4gf3CFNcuZNWD8XdyI6zQ8GqH7f8169MM6P7hMBRDVGnn7oHB9kXQ== + dependencies: + "@types/estree-jsx" "^1.0.0" + "@types/hast" "^3.0.0" + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-mdx-jsx@^3.0.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/mdast-util-mdx-jsx/-/mdast-util-mdx-jsx-3.2.0.tgz#fd04c67a2a7499efb905a8a5c578dddc9fdada0d" + integrity sha512-lj/z8v0r6ZtsN/cGNNtemmmfoLAFZnjMbNyLzBafjzikOM+glrjNHPlf6lQDOTccj9n5b0PPihEBbhneMyGs1Q== + dependencies: + "@types/estree-jsx" "^1.0.0" + "@types/hast" "^3.0.0" + "@types/mdast" "^4.0.0" + "@types/unist" "^3.0.0" + ccount "^2.0.0" + devlop "^1.1.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + parse-entities "^4.0.0" + stringify-entities "^4.0.0" + unist-util-stringify-position "^4.0.0" + vfile-message "^4.0.0" + +mdast-util-mdx@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/mdast-util-mdx/-/mdast-util-mdx-3.0.0.tgz#792f9cf0361b46bee1fdf1ef36beac424a099c41" + integrity sha512-JfbYLAW7XnYTTbUsmpu0kdBUVe+yKVJZBItEjwyYJiDJuZ9w4eeaqks4HQO+R7objWgS2ymV60GYpI14Ug554w== + dependencies: + mdast-util-from-markdown "^2.0.0" + mdast-util-mdx-expression "^2.0.0" + mdast-util-mdx-jsx "^3.0.0" + mdast-util-mdxjs-esm "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-mdxjs-esm@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/mdast-util-mdxjs-esm/-/mdast-util-mdxjs-esm-2.0.1.tgz#019cfbe757ad62dd557db35a695e7314bcc9fa97" + integrity sha512-EcmOpxsZ96CvlP03NghtH1EsLtr0n9Tm4lPUJUBccV9RwUOneqSycg19n5HGzCf+10LozMRSObtVr3ee1WoHtg== + dependencies: + "@types/estree-jsx" "^1.0.0" + "@types/hast" "^3.0.0" + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-phrasing@^4.0.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/mdast-util-phrasing/-/mdast-util-phrasing-4.1.0.tgz#7cc0a8dec30eaf04b7b1a9661a92adb3382aa6e3" + integrity sha512-TqICwyvJJpBwvGAMZjj4J2n0X8QWp21b9l0o7eXyVJ25YNWYbJDVIyD1bZXE6WtV6RmKJVYmQAKWa0zWOABz2w== + dependencies: + "@types/mdast" "^4.0.0" + unist-util-is "^6.0.0" + +mdast-util-to-hast@^13.0.0: + version "13.2.0" + resolved "https://registry.yarnpkg.com/mdast-util-to-hast/-/mdast-util-to-hast-13.2.0.tgz#5ca58e5b921cc0a3ded1bc02eed79a4fe4fe41f4" + integrity sha512-QGYKEuUsYT9ykKBCMOEDLsU5JRObWQusAolFMeko/tYPufNkRffBAQjIE+99jbA87xv6FgmjLtwjh9wBWajwAA== + dependencies: + "@types/hast" "^3.0.0" + "@types/mdast" "^4.0.0" + "@ungap/structured-clone" "^1.0.0" + devlop "^1.0.0" + micromark-util-sanitize-uri "^2.0.0" + trim-lines "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit "^5.0.0" + vfile "^6.0.0" + +mdast-util-to-markdown@^2.0.0: + version "2.1.2" + resolved "https://registry.yarnpkg.com/mdast-util-to-markdown/-/mdast-util-to-markdown-2.1.2.tgz#f910ffe60897f04bb4b7e7ee434486f76288361b" + integrity sha512-xj68wMTvGXVOKonmog6LwyJKrYXZPvlwabaryTjLh9LuvovB/KAH+kvi8Gjj+7rJjsFi23nkUxRQv1KqSroMqA== + dependencies: + "@types/mdast" "^4.0.0" + "@types/unist" "^3.0.0" + longest-streak "^3.0.0" + mdast-util-phrasing "^4.0.0" + mdast-util-to-string "^4.0.0" + micromark-util-classify-character "^2.0.0" + micromark-util-decode-string "^2.0.0" + unist-util-visit "^5.0.0" + zwitch "^2.0.0" + +mdast-util-to-string@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/mdast-util-to-string/-/mdast-util-to-string-4.0.0.tgz#7a5121475556a04e7eddeb67b264aae79d312814" + integrity sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg== + dependencies: + "@types/mdast" "^4.0.0" + +mdn-data@2.0.28: + version "2.0.28" + resolved "https://registry.yarnpkg.com/mdn-data/-/mdn-data-2.0.28.tgz#5ec48e7bef120654539069e1ae4ddc81ca490eba" + integrity sha512-aylIc7Z9y4yzHYAJNuESG3hfhC+0Ibp/MAMiaOZgNv4pmEdFyfZhhhny4MNiAfWdBQ1RQ2mfDWmM1x8SvGyp8g== + +mdn-data@2.0.30: + version "2.0.30" + resolved "https://registry.yarnpkg.com/mdn-data/-/mdn-data-2.0.30.tgz#ce4df6f80af6cfbe218ecd5c552ba13c4dfa08cc" + integrity sha512-GaqWWShW4kv/G9IEucWScBx9G1/vsFZZJUO+tD26M8J8z3Kw5RDQjaoZe03YAClgeS/SWPOcb4nkFBTEi5DUEA== + +media-typer@0.3.0: + version "0.3.0" + resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748" + integrity sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ== + +memfs@^3.4.3: + version "3.6.0" + resolved "https://registry.yarnpkg.com/memfs/-/memfs-3.6.0.tgz#d7a2110f86f79dd950a8b6df6d57bc984aa185f6" + integrity sha512-EGowvkkgbMcIChjMTMkESFDbZeSh8xZ7kNSF0hAiAN4Jh6jgHCRS0Ga/+C8y6Au+oqpezRHCfPsmJ2+DwAgiwQ== + dependencies: + fs-monkey "^1.0.4" + +merge-descriptors@1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/merge-descriptors/-/merge-descriptors-1.0.3.tgz#d80319a65f3c7935351e5cfdac8f9318504dbed5" + integrity sha512-gaNvAS7TZ897/rVaZ0nMtAyxNyi/pdbjbAwUpFQpN70GqnVfOiXpeUUMKRBmzXaSQ8DdTX4/0ms62r2K+hE6mQ== + +merge-stream@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/merge-stream/-/merge-stream-2.0.0.tgz#52823629a14dd00c9770fb6ad47dc6310f2c1f60" + integrity sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w== + +merge2@^1.3.0, merge2@^1.4.1: + version "1.4.1" + resolved "https://registry.yarnpkg.com/merge2/-/merge2-1.4.1.tgz#4368892f885e907455a6fd7dc55c0c9d404990ae" + integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg== + +methods@~1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/methods/-/methods-1.1.2.tgz#5529a4d67654134edcc5266656835b0f851afcee" + integrity sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w== + +micromark-core-commonmark@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/micromark-core-commonmark/-/micromark-core-commonmark-2.0.3.tgz#c691630e485021a68cf28dbc2b2ca27ebf678cd4" + integrity sha512-RDBrHEMSxVFLg6xvnXmb1Ayr2WzLAWjeSATAoxwKYJV94TeNavgoIdA0a9ytzDSVzBy2YKFK+emCPOEibLeCrg== + dependencies: + decode-named-character-reference "^1.0.0" + devlop "^1.0.0" + micromark-factory-destination "^2.0.0" + micromark-factory-label "^2.0.0" + micromark-factory-space "^2.0.0" + micromark-factory-title "^2.0.0" + micromark-factory-whitespace "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-chunked "^2.0.0" + micromark-util-classify-character "^2.0.0" + micromark-util-html-tag-name "^2.0.0" + micromark-util-normalize-identifier "^2.0.0" + micromark-util-resolve-all "^2.0.0" + micromark-util-subtokenize "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-directive@^3.0.0: + version "3.0.2" + resolved "https://registry.yarnpkg.com/micromark-extension-directive/-/micromark-extension-directive-3.0.2.tgz#2eb61985d1995a7c1ff7621676a4f32af29409e8" + integrity sha512-wjcXHgk+PPdmvR58Le9d7zQYWy+vKEU9Se44p2CrCDPiLr2FMyiT4Fyb5UFKFC66wGB3kPlgD7q3TnoqPS7SZA== + dependencies: + devlop "^1.0.0" + micromark-factory-space "^2.0.0" + micromark-factory-whitespace "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + parse-entities "^4.0.0" + +micromark-extension-frontmatter@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-extension-frontmatter/-/micromark-extension-frontmatter-2.0.0.tgz#651c52ffa5d7a8eeed687c513cd869885882d67a" + integrity sha512-C4AkuM3dA58cgZha7zVnuVxBhDsbttIMiytjgsM2XbHAB2faRVaHRle40558FBN+DJcrLNCoqG5mlrpdU4cRtg== + dependencies: + fault "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-gfm-autolink-literal@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/micromark-extension-gfm-autolink-literal/-/micromark-extension-gfm-autolink-literal-2.1.0.tgz#6286aee9686c4462c1e3552a9d505feddceeb935" + integrity sha512-oOg7knzhicgQ3t4QCjCWgTmfNhvQbDDnJeVu9v81r7NltNCVmhPy1fJRX27pISafdjL+SVc4d3l48Gb6pbRypw== + dependencies: + micromark-util-character "^2.0.0" + micromark-util-sanitize-uri "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-gfm-footnote@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/micromark-extension-gfm-footnote/-/micromark-extension-gfm-footnote-2.1.0.tgz#4dab56d4e398b9853f6fe4efac4fc9361f3e0750" + integrity sha512-/yPhxI1ntnDNsiHtzLKYnE3vf9JZ6cAisqVDauhp4CEHxlb4uoOTxOCJ+9s51bIB8U1N1FJ1RXOKTIlD5B/gqw== + dependencies: + devlop "^1.0.0" + micromark-core-commonmark "^2.0.0" + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-normalize-identifier "^2.0.0" + micromark-util-sanitize-uri "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-gfm-strikethrough@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/micromark-extension-gfm-strikethrough/-/micromark-extension-gfm-strikethrough-2.1.0.tgz#86106df8b3a692b5f6a92280d3879be6be46d923" + integrity sha512-ADVjpOOkjz1hhkZLlBiYA9cR2Anf8F4HqZUO6e5eDcPQd0Txw5fxLzzxnEkSkfnD0wziSGiv7sYhk/ktvbf1uw== + dependencies: + devlop "^1.0.0" + micromark-util-chunked "^2.0.0" + micromark-util-classify-character "^2.0.0" + micromark-util-resolve-all "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-gfm-table@^2.0.0: + version "2.1.1" + resolved "https://registry.yarnpkg.com/micromark-extension-gfm-table/-/micromark-extension-gfm-table-2.1.1.tgz#fac70bcbf51fe65f5f44033118d39be8a9b5940b" + integrity sha512-t2OU/dXXioARrC6yWfJ4hqB7rct14e8f7m0cbI5hUmDyyIlwv5vEtooptH8INkbLzOatzKuVbQmAYcbWoyz6Dg== + dependencies: + devlop "^1.0.0" + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-gfm-tagfilter@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-extension-gfm-tagfilter/-/micromark-extension-gfm-tagfilter-2.0.0.tgz#f26d8a7807b5985fba13cf61465b58ca5ff7dc57" + integrity sha512-xHlTOmuCSotIA8TW1mDIM6X2O1SiX5P9IuDtqGonFhEK0qgRI4yeC6vMxEV2dgyr2TiD+2PQ10o+cOhdVAcwfg== + dependencies: + micromark-util-types "^2.0.0" + +micromark-extension-gfm-task-list-item@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/micromark-extension-gfm-task-list-item/-/micromark-extension-gfm-task-list-item-2.1.0.tgz#bcc34d805639829990ec175c3eea12bb5b781f2c" + integrity sha512-qIBZhqxqI6fjLDYFTBIa4eivDMnP+OZqsNwmQ3xNLE4Cxwc+zfQEfbs6tzAo2Hjq+bh6q5F+Z8/cksrLFYWQQw== + dependencies: + devlop "^1.0.0" + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-gfm@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/micromark-extension-gfm/-/micromark-extension-gfm-3.0.0.tgz#3e13376ab95dd7a5cfd0e29560dfe999657b3c5b" + integrity sha512-vsKArQsicm7t0z2GugkCKtZehqUm31oeGBV/KVSorWSy8ZlNAv7ytjFhvaryUiCUJYqs+NoE6AFhpQvBTM6Q4w== + dependencies: + micromark-extension-gfm-autolink-literal "^2.0.0" + micromark-extension-gfm-footnote "^2.0.0" + micromark-extension-gfm-strikethrough "^2.0.0" + micromark-extension-gfm-table "^2.0.0" + micromark-extension-gfm-tagfilter "^2.0.0" + micromark-extension-gfm-task-list-item "^2.0.0" + micromark-util-combine-extensions "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-mdx-expression@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/micromark-extension-mdx-expression/-/micromark-extension-mdx-expression-3.0.1.tgz#43d058d999532fb3041195a3c3c05c46fa84543b" + integrity sha512-dD/ADLJ1AeMvSAKBwO22zG22N4ybhe7kFIZ3LsDI0GlsNr2A3KYxb0LdC1u5rj4Nw+CHKY0RVdnHX8vj8ejm4Q== + dependencies: + "@types/estree" "^1.0.0" + devlop "^1.0.0" + micromark-factory-mdx-expression "^2.0.0" + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-events-to-acorn "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-mdx-jsx@^3.0.0: + version "3.0.2" + resolved "https://registry.yarnpkg.com/micromark-extension-mdx-jsx/-/micromark-extension-mdx-jsx-3.0.2.tgz#ffc98bdb649798902fa9fc5689f67f9c1c902044" + integrity sha512-e5+q1DjMh62LZAJOnDraSSbDMvGJ8x3cbjygy2qFEi7HCeUT4BDKCvMozPozcD6WmOt6sVvYDNBKhFSz3kjOVQ== + dependencies: + "@types/estree" "^1.0.0" + devlop "^1.0.0" + estree-util-is-identifier-name "^3.0.0" + micromark-factory-mdx-expression "^2.0.0" + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-events-to-acorn "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + vfile-message "^4.0.0" + +micromark-extension-mdx-md@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-extension-mdx-md/-/micromark-extension-mdx-md-2.0.0.tgz#1d252881ea35d74698423ab44917e1f5b197b92d" + integrity sha512-EpAiszsB3blw4Rpba7xTOUptcFeBFi+6PY8VnJ2hhimH+vCQDirWgsMpz7w1XcZE7LVrSAUGb9VJpG9ghlYvYQ== + dependencies: + micromark-util-types "^2.0.0" + +micromark-extension-mdxjs-esm@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/micromark-extension-mdxjs-esm/-/micromark-extension-mdxjs-esm-3.0.0.tgz#de21b2b045fd2059bd00d36746081de38390d54a" + integrity sha512-DJFl4ZqkErRpq/dAPyeWp15tGrcrrJho1hKK5uBS70BCtfrIFg81sqcTVu3Ta+KD1Tk5vAtBNElWxtAa+m8K9A== + dependencies: + "@types/estree" "^1.0.0" + devlop "^1.0.0" + micromark-core-commonmark "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-events-to-acorn "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + unist-util-position-from-estree "^2.0.0" + vfile-message "^4.0.0" + +micromark-extension-mdxjs@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/micromark-extension-mdxjs/-/micromark-extension-mdxjs-3.0.0.tgz#b5a2e0ed449288f3f6f6c544358159557549de18" + integrity sha512-A873fJfhnJ2siZyUrJ31l34Uqwy4xIFmvPY1oj+Ean5PHcPBYzEsvqvWGaWcfEIr11O5Dlw3p2y0tZWpKHDejQ== + dependencies: + acorn "^8.0.0" + acorn-jsx "^5.0.0" + micromark-extension-mdx-expression "^3.0.0" + micromark-extension-mdx-jsx "^3.0.0" + micromark-extension-mdx-md "^2.0.0" + micromark-extension-mdxjs-esm "^3.0.0" + micromark-util-combine-extensions "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-factory-destination@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-factory-destination/-/micromark-factory-destination-2.0.1.tgz#8fef8e0f7081f0474fbdd92deb50c990a0264639" + integrity sha512-Xe6rDdJlkmbFRExpTOmRj9N3MaWmbAgdpSrBQvCFqhezUn4AHqJHbaEnfbVYYiexVSs//tqOdY/DxhjdCiJnIA== + dependencies: + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-factory-label@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-factory-label/-/micromark-factory-label-2.0.1.tgz#5267efa97f1e5254efc7f20b459a38cb21058ba1" + integrity sha512-VFMekyQExqIW7xIChcXn4ok29YE3rnuyveW3wZQWWqF4Nv9Wk5rgJ99KzPvHjkmPXF93FXIbBp6YdW3t71/7Vg== + dependencies: + devlop "^1.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-factory-mdx-expression@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/micromark-factory-mdx-expression/-/micromark-factory-mdx-expression-2.0.3.tgz#bb09988610589c07d1c1e4425285895041b3dfa9" + integrity sha512-kQnEtA3vzucU2BkrIa8/VaSAsP+EJ3CKOvhMuJgOEGg9KDC6OAY6nSnNDVRiVNRqj7Y4SlSzcStaH/5jge8JdQ== + dependencies: + "@types/estree" "^1.0.0" + devlop "^1.0.0" + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-events-to-acorn "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + unist-util-position-from-estree "^2.0.0" + vfile-message "^4.0.0" + +micromark-factory-space@^1.0.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/micromark-factory-space/-/micromark-factory-space-1.1.0.tgz#c8f40b0640a0150751d3345ed885a080b0d15faf" + integrity sha512-cRzEj7c0OL4Mw2v6nwzttyOZe8XY/Z8G0rzmWQZTBi/jjwyw/U4uqKtUORXQrR5bAZZnbTI/feRV/R7hc4jQYQ== + dependencies: + micromark-util-character "^1.0.0" + micromark-util-types "^1.0.0" + +micromark-factory-space@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz#36d0212e962b2b3121f8525fc7a3c7c029f334fc" + integrity sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg== + dependencies: + micromark-util-character "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-factory-title@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-factory-title/-/micromark-factory-title-2.0.1.tgz#237e4aa5d58a95863f01032d9ee9b090f1de6e94" + integrity sha512-5bZ+3CjhAd9eChYTHsjy6TGxpOFSKgKKJPJxr293jTbfry2KDoWkhBb6TcPVB4NmzaPhMs1Frm9AZH7OD4Cjzw== + dependencies: + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-factory-whitespace@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-factory-whitespace/-/micromark-factory-whitespace-2.0.1.tgz#06b26b2983c4d27bfcc657b33e25134d4868b0b1" + integrity sha512-Ob0nuZ3PKt/n0hORHyvoD9uZhr+Za8sFoP+OnMcnWK5lngSzALgQYKMr9RJVOWLqQYuyn6ulqGWSXdwf6F80lQ== + dependencies: + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-util-character@^1.0.0, micromark-util-character@^1.1.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/micromark-util-character/-/micromark-util-character-1.2.0.tgz#4fedaa3646db249bc58caeb000eb3549a8ca5dcc" + integrity sha512-lXraTwcX3yH/vMDaFWCQJP1uIszLVebzUa3ZHdrgxr7KEU/9mL4mVgCpGbyhvNLNlauROiNUq7WN5u7ndbY6xg== + dependencies: + micromark-util-symbol "^1.0.0" + micromark-util-types "^1.0.0" + +micromark-util-character@^2.0.0: + version "2.1.1" + resolved "https://registry.yarnpkg.com/micromark-util-character/-/micromark-util-character-2.1.1.tgz#2f987831a40d4c510ac261e89852c4e9703ccda6" + integrity sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q== + dependencies: + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-util-chunked@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-chunked/-/micromark-util-chunked-2.0.1.tgz#47fbcd93471a3fccab86cff03847fc3552db1051" + integrity sha512-QUNFEOPELfmvv+4xiNg2sRYeS/P84pTW0TCgP5zc9FpXetHY0ab7SxKyAQCNCc1eK0459uoLI1y5oO5Vc1dbhA== + dependencies: + micromark-util-symbol "^2.0.0" + +micromark-util-classify-character@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-classify-character/-/micromark-util-classify-character-2.0.1.tgz#d399faf9c45ca14c8b4be98b1ea481bced87b629" + integrity sha512-K0kHzM6afW/MbeWYWLjoHQv1sgg2Q9EccHEDzSkxiP/EaagNzCm7T/WMKZ3rjMbvIpvBiZgwR3dKMygtA4mG1Q== + dependencies: + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-util-combine-extensions@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-combine-extensions/-/micromark-util-combine-extensions-2.0.1.tgz#2a0f490ab08bff5cc2fd5eec6dd0ca04f89b30a9" + integrity sha512-OnAnH8Ujmy59JcyZw8JSbK9cGpdVY44NKgSM7E9Eh7DiLS2E9RNQf0dONaGDzEG9yjEl5hcqeIsj4hfRkLH/Bg== + dependencies: + micromark-util-chunked "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-util-decode-numeric-character-reference@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/micromark-util-decode-numeric-character-reference/-/micromark-util-decode-numeric-character-reference-2.0.2.tgz#fcf15b660979388e6f118cdb6bf7d79d73d26fe5" + integrity sha512-ccUbYk6CwVdkmCQMyr64dXz42EfHGkPQlBj5p7YVGzq8I7CtjXZJrubAYezf7Rp+bjPseiROqe7G6foFd+lEuw== + dependencies: + micromark-util-symbol "^2.0.0" + +micromark-util-decode-string@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-decode-string/-/micromark-util-decode-string-2.0.1.tgz#6cb99582e5d271e84efca8e61a807994d7161eb2" + integrity sha512-nDV/77Fj6eH1ynwscYTOsbK7rR//Uj0bZXBwJZRfaLEJ1iGBR6kIfNmlNqaqJf649EP0F3NWNdeJi03elllNUQ== + dependencies: + decode-named-character-reference "^1.0.0" + micromark-util-character "^2.0.0" + micromark-util-decode-numeric-character-reference "^2.0.0" + micromark-util-symbol "^2.0.0" + +micromark-util-encode@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-encode/-/micromark-util-encode-2.0.1.tgz#0d51d1c095551cfaac368326963cf55f15f540b8" + integrity sha512-c3cVx2y4KqUnwopcO9b/SCdo2O67LwJJ/UyqGfbigahfegL9myoEFoDYZgkT7f36T0bLrM9hZTAaAyH+PCAXjw== + +micromark-util-events-to-acorn@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/micromark-util-events-to-acorn/-/micromark-util-events-to-acorn-2.0.3.tgz#e7a8a6b55a47e5a06c720d5a1c4abae8c37c98f3" + integrity sha512-jmsiEIiZ1n7X1Rr5k8wVExBQCg5jy4UXVADItHmNk1zkwEVhBuIUKRu3fqv+hs4nxLISi2DQGlqIOGiFxgbfHg== + dependencies: + "@types/estree" "^1.0.0" + "@types/unist" "^3.0.0" + devlop "^1.0.0" + estree-util-visit "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + vfile-message "^4.0.0" + +micromark-util-html-tag-name@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-html-tag-name/-/micromark-util-html-tag-name-2.0.1.tgz#e40403096481986b41c106627f98f72d4d10b825" + integrity sha512-2cNEiYDhCWKI+Gs9T0Tiysk136SnR13hhO8yW6BGNyhOC4qYFnwF1nKfD3HFAIXA5c45RrIG1ub11GiXeYd1xA== + +micromark-util-normalize-identifier@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-normalize-identifier/-/micromark-util-normalize-identifier-2.0.1.tgz#c30d77b2e832acf6526f8bf1aa47bc9c9438c16d" + integrity sha512-sxPqmo70LyARJs0w2UclACPUUEqltCkJ6PhKdMIDuJ3gSf/Q+/GIe3WKl0Ijb/GyH9lOpUkRAO2wp0GVkLvS9Q== + dependencies: + micromark-util-symbol "^2.0.0" + +micromark-util-resolve-all@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-resolve-all/-/micromark-util-resolve-all-2.0.1.tgz#e1a2d62cdd237230a2ae11839027b19381e31e8b" + integrity sha512-VdQyxFWFT2/FGJgwQnJYbe1jjQoNTS4RjglmSjTUlpUMa95Htx9NHeYW4rGDJzbjvCsl9eLjMQwGeElsqmzcHg== + dependencies: + micromark-util-types "^2.0.0" + +micromark-util-sanitize-uri@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-2.0.1.tgz#ab89789b818a58752b73d6b55238621b7faa8fd7" + integrity sha512-9N9IomZ/YuGGZZmQec1MbgxtlgougxTodVwDzzEouPKo3qFWvymFHWcnDi2vzV1ff6kas9ucW+o3yzJK9YB1AQ== + dependencies: + micromark-util-character "^2.0.0" + micromark-util-encode "^2.0.0" + micromark-util-symbol "^2.0.0" + +micromark-util-subtokenize@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/micromark-util-subtokenize/-/micromark-util-subtokenize-2.1.0.tgz#d8ade5ba0f3197a1cf6a2999fbbfe6357a1a19ee" + integrity sha512-XQLu552iSctvnEcgXw6+Sx75GflAPNED1qx7eBJ+wydBb2KCbRZe+NwvIEEMM83uml1+2WSXpBAcp9IUCgCYWA== + dependencies: + devlop "^1.0.0" + micromark-util-chunked "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-util-symbol@^1.0.0, micromark-util-symbol@^1.0.1: + version "1.1.0" + resolved "https://registry.yarnpkg.com/micromark-util-symbol/-/micromark-util-symbol-1.1.0.tgz#813cd17837bdb912d069a12ebe3a44b6f7063142" + integrity sha512-uEjpEYY6KMs1g7QfJ2eX1SQEV+ZT4rUD3UcF6l57acZvLNK7PBZL+ty82Z1qhK1/yXIY4bdx04FKMgR0g4IAag== + +micromark-util-symbol@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz#e5da494e8eb2b071a0d08fb34f6cefec6c0a19b8" + integrity sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q== + +micromark-util-types@^1.0.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/micromark-util-types/-/micromark-util-types-1.1.0.tgz#e6676a8cae0bb86a2171c498167971886cb7e283" + integrity sha512-ukRBgie8TIAcacscVHSiddHjO4k/q3pnedmzMQ4iwDcK0FtFCohKOlFbaOL/mPgfnPsL3C1ZyxJa4sbWrBl3jg== + +micromark-util-types@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/micromark-util-types/-/micromark-util-types-2.0.2.tgz#f00225f5f5a0ebc3254f96c36b6605c4b393908e" + integrity sha512-Yw0ECSpJoViF1qTU4DC6NwtC4aWGt1EkzaQB8KPPyCRR8z9TWeV0HbEFGTO+ZY1wB22zmxnJqhPyTpOVCpeHTA== + +micromark@^4.0.0: + version "4.0.2" + resolved "https://registry.yarnpkg.com/micromark/-/micromark-4.0.2.tgz#91395a3e1884a198e62116e33c9c568e39936fdb" + integrity sha512-zpe98Q6kvavpCr1NPVSCMebCKfD7CA2NqZ+rykeNhONIJBpc1tFKt9hucLGwha3jNTNI8lHpctWJWoimVF4PfA== + dependencies: + "@types/debug" "^4.0.0" + debug "^4.0.0" + decode-named-character-reference "^1.0.0" + devlop "^1.0.0" + micromark-core-commonmark "^2.0.0" + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-chunked "^2.0.0" + micromark-util-combine-extensions "^2.0.0" + micromark-util-decode-numeric-character-reference "^2.0.0" + micromark-util-encode "^2.0.0" + micromark-util-normalize-identifier "^2.0.0" + micromark-util-resolve-all "^2.0.0" + micromark-util-sanitize-uri "^2.0.0" + micromark-util-subtokenize "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromatch@^4.0.2, micromatch@^4.0.5, micromatch@^4.0.8: + version "4.0.8" + resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.8.tgz#d66fa18f3a47076789320b9b1af32bd86d9fa202" + integrity sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA== + dependencies: + braces "^3.0.3" + picomatch "^2.3.1" + +mime-db@1.52.0: + version "1.52.0" + resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.52.0.tgz#bbabcdc02859f4987301c856e3387ce5ec43bf70" + integrity sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg== + +"mime-db@>= 1.43.0 < 2": + version "1.54.0" + resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.54.0.tgz#cddb3ee4f9c64530dff640236661d42cb6a314f5" + integrity sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ== + +mime-db@~1.33.0: + version "1.33.0" + resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.33.0.tgz#a3492050a5cb9b63450541e39d9788d2272783db" + integrity sha512-BHJ/EKruNIqJf/QahvxwQZXKygOQ256myeN/Ew+THcAa5q+PjyTTMMeNQC4DZw5AwfvelsUrA6B67NKMqXDbzQ== + +mime-types@2.1.18: + version "2.1.18" + resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.18.tgz#6f323f60a83d11146f831ff11fd66e2fe5503bb8" + integrity sha512-lc/aahn+t4/SWV/qcmumYjymLsWfN3ELhpmVuUFjgsORruuZPVSwAQryq+HHGvO/SI2KVX26bx+En+zhM8g8hQ== + dependencies: + mime-db "~1.33.0" + +mime-types@^2.1.27, mime-types@^2.1.31, mime-types@~2.1.17, mime-types@~2.1.24, mime-types@~2.1.34: + version "2.1.35" + resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.35.tgz#381a871b62a734450660ae3deee44813f70d959a" + integrity sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw== + dependencies: + mime-db "1.52.0" + +mime@1.6.0: + version "1.6.0" + resolved "https://registry.yarnpkg.com/mime/-/mime-1.6.0.tgz#32cd9e5c64553bd58d19a568af452acff04981b1" + integrity sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg== + +mimic-fn@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-2.1.0.tgz#7ed2c2ccccaf84d3ffcb7a69b57711fc2083401b" + integrity sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg== + +mimic-response@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/mimic-response/-/mimic-response-3.1.0.tgz#2d1d59af9c1b129815accc2c46a022a5ce1fa3c9" + integrity sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ== + +mimic-response@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/mimic-response/-/mimic-response-4.0.0.tgz#35468b19e7c75d10f5165ea25e75a5ceea7cf70f" + integrity sha512-e5ISH9xMYU0DzrT+jl8q2ze9D6eWBto+I8CNpe+VI+K2J/F/k3PdkdTdz4wvGVH4NTpo+NRYTVIuMQEMMcsLqg== + +mini-css-extract-plugin@^2.9.2: + version "2.9.4" + resolved "https://registry.yarnpkg.com/mini-css-extract-plugin/-/mini-css-extract-plugin-2.9.4.tgz#cafa1a42f8c71357f49cd1566810d74ff1cb0200" + integrity sha512-ZWYT7ln73Hptxqxk2DxPU9MmapXRhxkJD6tkSR04dnQxm8BGu2hzgKLugK5yySD97u/8yy7Ma7E76k9ZdvtjkQ== + dependencies: + schema-utils "^4.0.0" + tapable "^2.2.1" + +minimalistic-assert@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/minimalistic-assert/-/minimalistic-assert-1.0.1.tgz#2e194de044626d4a10e7f7fbc00ce73e83e4d5c7" + integrity sha512-UtJcAD4yEaGtjPezWuO9wC4nwUnVH/8/Im3yEHQP4b67cXlD/Qr9hdITCU1xDbSEXg2XKNaP8jsReV7vQd00/A== + +minimatch@3.1.2, minimatch@^3.1.1: + version "3.1.2" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.2.tgz#19cd194bfd3e428f049a70817c038d89ab4be35b" + integrity sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw== + dependencies: + brace-expansion "^1.1.7" + +minimist@^1.2.0: + version "1.2.8" + resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.8.tgz#c1a464e7693302e082a075cee0c057741ac4772c" + integrity sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA== + +mrmime@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/mrmime/-/mrmime-2.0.1.tgz#bc3e87f7987853a54c9850eeb1f1078cd44adddc" + integrity sha512-Y3wQdFg2Va6etvQ5I82yUhGdsKrcYox6p7FfL1LbK2J4V01F9TGlepTIhnK24t7koZibmg82KGglhA1XK5IsLQ== + +ms@2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/ms/-/ms-2.0.0.tgz#5608aeadfc00be6c2901df5f9861788de0d597c8" + integrity sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A== + +ms@2.1.3, ms@^2.1.3: + version "2.1.3" + resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.3.tgz#574c8138ce1d2b5861f0b44579dbadd60c6615b2" + integrity sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA== + +multicast-dns@^7.2.5: + version "7.2.5" + resolved "https://registry.yarnpkg.com/multicast-dns/-/multicast-dns-7.2.5.tgz#77eb46057f4d7adbd16d9290fa7299f6fa64cced" + integrity sha512-2eznPJP8z2BFLX50tf0LuODrpINqP1RVIm/CObbTcBRITQgmC/TjcREF1NeTBzIcR5XO/ukWo+YHOjBbFwIupg== + dependencies: + dns-packet "^5.2.2" + thunky "^1.0.2" + +nanoid@^3.3.11: + version "3.3.11" + resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-3.3.11.tgz#4f4f112cefbe303202f2199838128936266d185b" + integrity sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w== + +negotiator@0.6.3: + version "0.6.3" + resolved "https://registry.yarnpkg.com/negotiator/-/negotiator-0.6.3.tgz#58e323a72fedc0d6f9cd4d31fe49f51479590ccd" + integrity sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg== + +negotiator@~0.6.4: + version "0.6.4" + resolved "https://registry.yarnpkg.com/negotiator/-/negotiator-0.6.4.tgz#777948e2452651c570b712dd01c23e262713fff7" + integrity sha512-myRT3DiWPHqho5PrJaIRyaMv2kgYf0mUVgBNOYMuCH5Ki1yEiQaf/ZJuQ62nvpc44wL5WDbTX7yGJi1Neevw8w== + +neo-async@^2.6.2: + version "2.6.2" + resolved "https://registry.yarnpkg.com/neo-async/-/neo-async-2.6.2.tgz#b4aafb93e3aeb2d8174ca53cf163ab7d7308305f" + integrity sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw== + +no-case@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/no-case/-/no-case-3.0.4.tgz#d361fd5c9800f558551a8369fc0dcd4662b6124d" + integrity sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg== + dependencies: + lower-case "^2.0.2" + tslib "^2.0.3" + +node-emoji@^2.1.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/node-emoji/-/node-emoji-2.2.0.tgz#1d000e3c76e462577895be1b436f4aa2d6760eb0" + integrity sha512-Z3lTE9pLaJF47NyMhd4ww1yFTAP8YhYI8SleJiHzM46Fgpm5cnNzSl9XfzFNqbaz+VlJrIj3fXQ4DeN1Rjm6cw== + dependencies: + "@sindresorhus/is" "^4.6.0" + char-regex "^1.0.2" + emojilib "^2.4.0" + skin-tone "^2.0.0" + +node-forge@^1: + version "1.3.1" + resolved "https://registry.yarnpkg.com/node-forge/-/node-forge-1.3.1.tgz#be8da2af243b2417d5f646a770663a92b7e9ded3" + integrity sha512-dPEtOeMvF9VMcYV/1Wb8CPoVAXtp6MKMlcbAt4ddqmGqUJ6fQZFXkNZNkNlfevtNkGtaSoXf/vNNNSvgrdXwtA== + +node-releases@^2.0.21: + version "2.0.21" + resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.21.tgz#f59b018bc0048044be2d4c4c04e4c8b18160894c" + integrity sha512-5b0pgg78U3hwXkCM8Z9b2FJdPZlr9Psr9V2gQPESdGHqbntyFJKFW4r5TeWGFzafGY3hzs1JC62VEQMbl1JFkw== + +normalize-path@^3.0.0, normalize-path@~3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/normalize-path/-/normalize-path-3.0.0.tgz#0dcd69ff23a1c9b11fd0978316644a0388216a65" + integrity sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA== + +normalize-range@^0.1.2: + version "0.1.2" + resolved "https://registry.yarnpkg.com/normalize-range/-/normalize-range-0.1.2.tgz#2d10c06bdfd312ea9777695a4d28439456b75942" + integrity sha512-bdok/XvKII3nUpklnV6P2hxtMNrCboOjAcyBuQnWEhO665FwrSNRxU+AqpsyvO6LgGYPspN+lu5CLtw4jPRKNA== + +normalize-url@^8.0.0: + version "8.1.0" + resolved "https://registry.yarnpkg.com/normalize-url/-/normalize-url-8.1.0.tgz#d33504f67970decf612946fd4880bc8c0983486d" + integrity sha512-X06Mfd/5aKsRHc0O0J5CUedwnPmnDtLF2+nq+KN9KSDlJHkPuh0JUviWjEWMe0SW/9TDdSLVPuk7L5gGTIA1/w== + +npm-run-path@^4.0.1: + version "4.0.1" + resolved "https://registry.yarnpkg.com/npm-run-path/-/npm-run-path-4.0.1.tgz#b7ecd1e5ed53da8e37a55e1c2269e0b97ed748ea" + integrity sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw== + dependencies: + path-key "^3.0.0" + +nprogress@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/nprogress/-/nprogress-0.2.0.tgz#cb8f34c53213d895723fcbab907e9422adbcafb1" + integrity sha512-I19aIingLgR1fmhftnbWWO3dXc0hSxqHQHQb3H8m+K3TnEn/iSeTZZOyvKXWqQESMwuUVnatlCnZdLBZZt2VSA== + +nth-check@^2.0.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/nth-check/-/nth-check-2.1.1.tgz#c9eab428effce36cd6b92c924bdb000ef1f1ed1d" + integrity sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w== + dependencies: + boolbase "^1.0.0" + +null-loader@^4.0.1: + version "4.0.1" + resolved "https://registry.yarnpkg.com/null-loader/-/null-loader-4.0.1.tgz#8e63bd3a2dd3c64236a4679428632edd0a6dbc6a" + integrity sha512-pxqVbi4U6N26lq+LmgIbB5XATP0VdZKOG25DhHi8btMmJJefGArFyDg1yc4U3hWCJbMqSrw0qyrz1UQX+qYXqg== + dependencies: + loader-utils "^2.0.0" + schema-utils "^3.0.0" + +object-assign@^4.1.1: + version "4.1.1" + resolved "https://registry.yarnpkg.com/object-assign/-/object-assign-4.1.1.tgz#2109adc7965887cfc05cbbd442cac8bfbb360863" + integrity sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg== + +object-inspect@^1.13.3: + version "1.13.4" + resolved "https://registry.yarnpkg.com/object-inspect/-/object-inspect-1.13.4.tgz#8375265e21bc20d0fa582c22e1b13485d6e00213" + integrity sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew== + +object-keys@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/object-keys/-/object-keys-1.1.1.tgz#1c47f272df277f3b1daf061677d9c82e2322c60e" + integrity sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA== + +object.assign@^4.1.0: + version "4.1.7" + resolved "https://registry.yarnpkg.com/object.assign/-/object.assign-4.1.7.tgz#8c14ca1a424c6a561b0bb2a22f66f5049a945d3d" + integrity sha512-nK28WOo+QIjBkDduTINE4JkF/UJJKyf2EJxvJKfblDpyg0Q+pkOHNTL0Qwy6NP6FhE/EnzV73BxxqcJaXY9anw== + dependencies: + call-bind "^1.0.8" + call-bound "^1.0.3" + define-properties "^1.2.1" + es-object-atoms "^1.0.0" + has-symbols "^1.1.0" + object-keys "^1.1.1" + +obuf@^1.0.0, obuf@^1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/obuf/-/obuf-1.1.2.tgz#09bea3343d41859ebd446292d11c9d4db619084e" + integrity sha512-PX1wu0AmAdPqOL1mWhqmlOd8kOIZQwGZw6rh7uby9fTc5lhaOWFLX3I6R1hrF9k3zUY40e6igsLGkDXK92LJNg== + +on-finished@2.4.1: + version "2.4.1" + resolved "https://registry.yarnpkg.com/on-finished/-/on-finished-2.4.1.tgz#58c8c44116e54845ad57f14ab10b03533184ac3f" + integrity sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg== + dependencies: + ee-first "1.1.1" + +on-headers@~1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/on-headers/-/on-headers-1.1.0.tgz#59da4f91c45f5f989c6e4bcedc5a3b0aed70ff65" + integrity sha512-737ZY3yNnXy37FHkQxPzt4UZ2UWPWiCZWLvFZ4fu5cueciegX0zGPnrlY6bwRg4FdQOe9YU8MkmJwGhoMybl8A== + +once@^1.3.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" + integrity sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w== + dependencies: + wrappy "1" + +onetime@^5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/onetime/-/onetime-5.1.2.tgz#d0e96ebb56b07476df1dd9c4806e5237985ca45e" + integrity sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg== + dependencies: + mimic-fn "^2.1.0" + +open@^8.0.9, open@^8.4.0: + version "8.4.2" + resolved "https://registry.yarnpkg.com/open/-/open-8.4.2.tgz#5b5ffe2a8f793dcd2aad73e550cb87b59cb084f9" + integrity sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ== + dependencies: + define-lazy-prop "^2.0.0" + is-docker "^2.1.1" + is-wsl "^2.2.0" + +opener@^1.5.2: + version "1.5.2" + resolved "https://registry.yarnpkg.com/opener/-/opener-1.5.2.tgz#5d37e1f35077b9dcac4301372271afdeb2a13598" + integrity sha512-ur5UIdyw5Y7yEj9wLzhqXiy6GZ3Mwx0yGI+5sMn2r0N0v3cKJvUmFH5yPP+WXh9e0xfyzyJX95D8l088DNFj7A== + +p-cancelable@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/p-cancelable/-/p-cancelable-3.0.0.tgz#63826694b54d61ca1c20ebcb6d3ecf5e14cd8050" + integrity sha512-mlVgR3PGuzlo0MmTdk4cXqXWlwQDLnONTAg6sm62XkMJEiRxN3GL3SffkYvqwonbkJBcrI7Uvv5Zh9yjvn2iUw== + +p-finally@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/p-finally/-/p-finally-1.0.0.tgz#3fbcfb15b899a44123b34b6dcc18b724336a2cae" + integrity sha512-LICb2p9CB7FS+0eR1oqWnHhp0FljGLZCWBE9aix0Uye9W8LTQPwMTYVGWQWIw9RdQiDg4+epXQODwIYJtSJaow== + +p-limit@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-4.0.0.tgz#914af6544ed32bfa54670b061cafcbd04984b644" + integrity sha512-5b0R4txpzjPWVw/cXXUResoD4hb6U/x9BH08L7nw+GN1sezDzPdxeRvpc9c433fZhBan/wusjbCsqwqm4EIBIQ== + dependencies: + yocto-queue "^1.0.0" + +p-locate@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-6.0.0.tgz#3da9a49d4934b901089dca3302fa65dc5a05c04f" + integrity sha512-wPrq66Llhl7/4AGC6I+cqxT07LhXvWL08LNXz1fENOw0Ap4sRZZ/gZpTTJ5jpurzzzfS2W/Ge9BY3LgLjCShcw== + dependencies: + p-limit "^4.0.0" + +p-map@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/p-map/-/p-map-4.0.0.tgz#bb2f95a5eda2ec168ec9274e06a747c3e2904d2b" + integrity sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ== + dependencies: + aggregate-error "^3.0.0" + +p-queue@^6.6.2: + version "6.6.2" + resolved "https://registry.yarnpkg.com/p-queue/-/p-queue-6.6.2.tgz#2068a9dcf8e67dd0ec3e7a2bcb76810faa85e426" + integrity sha512-RwFpb72c/BhQLEXIZ5K2e+AhgNVmIejGlTgiB9MzZ0e93GRvqZ7uSi0dvRF7/XIXDeNkra2fNHBxTyPDGySpjQ== + dependencies: + eventemitter3 "^4.0.4" + p-timeout "^3.2.0" + +p-retry@^4.5.0: + version "4.6.2" + resolved "https://registry.yarnpkg.com/p-retry/-/p-retry-4.6.2.tgz#9baae7184057edd4e17231cee04264106e092a16" + integrity sha512-312Id396EbJdvRONlngUx0NydfrIQ5lsYu0znKVUzVvArzEIt08V1qhtyESbGVd1FGX7UKtiFp5uwKZdM8wIuQ== + dependencies: + "@types/retry" "0.12.0" + retry "^0.13.1" + +p-timeout@^3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/p-timeout/-/p-timeout-3.2.0.tgz#c7e17abc971d2a7962ef83626b35d635acf23dfe" + integrity sha512-rhIwUycgwwKcP9yTOOFK/AKsAopjjCakVqLHePO3CC6Mir1Z99xT+R63jZxAT5lFZLa2inS5h+ZS2GvR99/FBg== + dependencies: + p-finally "^1.0.0" + +package-json@^8.1.0: + version "8.1.1" + resolved "https://registry.yarnpkg.com/package-json/-/package-json-8.1.1.tgz#3e9948e43df40d1e8e78a85485f1070bf8f03dc8" + integrity sha512-cbH9IAIJHNj9uXi196JVsRlt7cHKak6u/e6AkL/bkRelZ7rlL3X1YKxsZwa36xipOEKAsdtmaG6aAJoM1fx2zA== + dependencies: + got "^12.1.0" + registry-auth-token "^5.0.1" + registry-url "^6.0.0" + semver "^7.3.7" + +param-case@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/param-case/-/param-case-3.0.4.tgz#7d17fe4aa12bde34d4a77d91acfb6219caad01c5" + integrity sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A== + dependencies: + dot-case "^3.0.4" + tslib "^2.0.3" + +parent-module@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/parent-module/-/parent-module-1.0.1.tgz#691d2709e78c79fae3a156622452d00762caaaa2" + integrity sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g== + dependencies: + callsites "^3.0.0" + +parse-entities@^4.0.0: + version "4.0.2" + resolved "https://registry.yarnpkg.com/parse-entities/-/parse-entities-4.0.2.tgz#61d46f5ed28e4ee62e9ddc43d6b010188443f159" + integrity sha512-GG2AQYWoLgL877gQIKeRPGO1xF9+eG1ujIb5soS5gPvLQ1y2o8FL90w2QWNdf9I361Mpp7726c+lj3U0qK1uGw== + dependencies: + "@types/unist" "^2.0.0" + character-entities-legacy "^3.0.0" + character-reference-invalid "^2.0.0" + decode-named-character-reference "^1.0.0" + is-alphanumerical "^2.0.0" + is-decimal "^2.0.0" + is-hexadecimal "^2.0.0" + +parse-json@^5.0.0, parse-json@^5.2.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/parse-json/-/parse-json-5.2.0.tgz#c76fc66dee54231c962b22bcc8a72cf2f99753cd" + integrity sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg== + dependencies: + "@babel/code-frame" "^7.0.0" + error-ex "^1.3.1" + json-parse-even-better-errors "^2.3.0" + lines-and-columns "^1.1.6" + +parse-numeric-range@^1.3.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/parse-numeric-range/-/parse-numeric-range-1.3.0.tgz#7c63b61190d61e4d53a1197f0c83c47bb670ffa3" + integrity sha512-twN+njEipszzlMJd4ONUYgSfZPDxgHhT9Ahed5uTigpQn90FggW4SA/AIPq/6a149fTbE9qBEcSwE3FAEp6wQQ== + +parse5-htmlparser2-tree-adapter@^7.0.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-7.1.0.tgz#b5a806548ed893a43e24ccb42fbb78069311e81b" + integrity sha512-ruw5xyKs6lrpo9x9rCZqZZnIUntICjQAd0Wsmp396Ul9lN/h+ifgVV1x1gZHi8euej6wTfpqX8j+BFQxF0NS/g== + dependencies: + domhandler "^5.0.3" + parse5 "^7.0.0" + +parse5@^7.0.0: + version "7.3.0" + resolved "https://registry.yarnpkg.com/parse5/-/parse5-7.3.0.tgz#d7e224fa72399c7a175099f45fc2ad024b05ec05" + integrity sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw== + dependencies: + entities "^6.0.0" + +parseurl@~1.3.2, parseurl@~1.3.3: + version "1.3.3" + resolved "https://registry.yarnpkg.com/parseurl/-/parseurl-1.3.3.tgz#9da19e7bee8d12dff0513ed5b76957793bc2e8d4" + integrity sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ== + +pascal-case@^3.1.2: + version "3.1.2" + resolved "https://registry.yarnpkg.com/pascal-case/-/pascal-case-3.1.2.tgz#b48e0ef2b98e205e7c1dae747d0b1508237660eb" + integrity sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g== + dependencies: + no-case "^3.0.4" + tslib "^2.0.3" + +path-exists@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-5.0.0.tgz#a6aad9489200b21fab31e49cf09277e5116fb9e7" + integrity sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ== + +path-is-absolute@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/path-is-absolute/-/path-is-absolute-1.0.1.tgz#174b9268735534ffbc7ace6bf53a5a9e1b5c5f5f" + integrity sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg== + +path-is-inside@1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/path-is-inside/-/path-is-inside-1.0.2.tgz#365417dede44430d1c11af61027facf074bdfc53" + integrity sha512-DUWJr3+ULp4zXmol/SZkFf3JGsS9/SIv+Y3Rt93/UjPpDpklB5f1er4O3POIbUuUJ3FXgqte2Q7SrU6zAqwk8w== + +path-key@^3.0.0, path-key@^3.1.0: + version "3.1.1" + resolved "https://registry.yarnpkg.com/path-key/-/path-key-3.1.1.tgz#581f6ade658cbba65a0d3380de7753295054f375" + integrity sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q== + +path-parse@^1.0.7: + version "1.0.7" + resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.7.tgz#fbc114b60ca42b30d9daf5858e4bd68bbedb6735" + integrity sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw== + +path-to-regexp@0.1.12: + version "0.1.12" + resolved "https://registry.yarnpkg.com/path-to-regexp/-/path-to-regexp-0.1.12.tgz#d5e1a12e478a976d432ef3c58d534b9923164bb7" + integrity sha512-RA1GjUVMnvYFxuqovrEqZoxxW5NUZqbwKtYz/Tt7nXerk0LbLblQmrsgdeOxV5SFHf0UDggjS/bSeOZwt1pmEQ== + +path-to-regexp@3.3.0: + version "3.3.0" + resolved "https://registry.yarnpkg.com/path-to-regexp/-/path-to-regexp-3.3.0.tgz#f7f31d32e8518c2660862b644414b6d5c63a611b" + integrity sha512-qyCH421YQPS2WFDxDjftfc1ZR5WKQzVzqsp4n9M2kQhVOo/ByahFoUNJfl58kOcEGfQ//7weFTDhm+ss8Ecxgw== + +path-to-regexp@^1.7.0: + version "1.9.0" + resolved "https://registry.yarnpkg.com/path-to-regexp/-/path-to-regexp-1.9.0.tgz#5dc0753acbf8521ca2e0f137b4578b917b10cf24" + integrity sha512-xIp7/apCFJuUHdDLWe8O1HIkb0kQrOMb/0u6FXQjemHn/ii5LrIzU6bdECnsiTF/GjZkMEKg1xdiZwNqDYlZ6g== + dependencies: + isarray "0.0.1" + +path-type@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/path-type/-/path-type-4.0.0.tgz#84ed01c0a7ba380afe09d90a8c180dcd9d03043b" + integrity sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw== + +picocolors@^1.0.0, picocolors@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/picocolors/-/picocolors-1.1.1.tgz#3d321af3eab939b083c8f929a1d12cda81c26b6b" + integrity sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA== + +picomatch@^2.0.4, picomatch@^2.2.1, picomatch@^2.2.3, picomatch@^2.3.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.3.1.tgz#3ba3833733646d9d3e4995946c1365a67fb07a42" + integrity sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA== + +pkg-dir@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/pkg-dir/-/pkg-dir-7.0.0.tgz#8f0c08d6df4476756c5ff29b3282d0bab7517d11" + integrity sha512-Ie9z/WINcxxLp27BKOCHGde4ITq9UklYKDzVo1nhk5sqGEXU3FpkwP5GM2voTGJkGd9B3Otl+Q4uwSOeSUtOBA== + dependencies: + find-up "^6.3.0" + +postcss-attribute-case-insensitive@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/postcss-attribute-case-insensitive/-/postcss-attribute-case-insensitive-7.0.1.tgz#0c4500e3bcb2141848e89382c05b5a31c23033a3" + integrity sha512-Uai+SupNSqzlschRyNx3kbCTWgY/2hcwtHEI/ej2LJWc9JJ77qKgGptd8DHwY1mXtZ7Aoh4z4yxfwMBue9eNgw== + dependencies: + postcss-selector-parser "^7.0.0" + +postcss-calc@^9.0.1: + version "9.0.1" + resolved "https://registry.yarnpkg.com/postcss-calc/-/postcss-calc-9.0.1.tgz#a744fd592438a93d6de0f1434c572670361eb6c6" + integrity sha512-TipgjGyzP5QzEhsOZUaIkeO5mKeMFpebWzRogWG/ysonUlnHcq5aJe0jOjpfzUU8PeSaBQnrE8ehR0QA5vs8PQ== + dependencies: + postcss-selector-parser "^6.0.11" + postcss-value-parser "^4.2.0" + +postcss-clamp@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/postcss-clamp/-/postcss-clamp-4.1.0.tgz#7263e95abadd8c2ba1bd911b0b5a5c9c93e02363" + integrity sha512-ry4b1Llo/9zz+PKC+030KUnPITTJAHeOwjfAyyB60eT0AorGLdzp52s31OsPRHRf8NchkgFoG2y6fCfn1IV1Ow== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-color-functional-notation@^7.0.11: + version "7.0.11" + resolved "https://registry.yarnpkg.com/postcss-color-functional-notation/-/postcss-color-functional-notation-7.0.11.tgz#ad6b3d2e71fedd94a932f96260b596c33c53c6a5" + integrity sha512-zfqoUSaHMko/k2PA9xnaydVTHqYv5vphq5Q2AHcG/dCdv/OkHYWcVWfVTBKZ526uzT8L7NghuvSw3C9PxlKnLg== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +postcss-color-hex-alpha@^10.0.0: + version "10.0.0" + resolved "https://registry.yarnpkg.com/postcss-color-hex-alpha/-/postcss-color-hex-alpha-10.0.0.tgz#5dd3eba1f8facb4ea306cba6e3f7712e876b0c76" + integrity sha512-1kervM2cnlgPs2a8Vt/Qbe5cQ++N7rkYo/2rz2BkqJZIHQwaVuJgQH38REHrAi4uM0b1fqxMkWYmese94iMp3w== + dependencies: + "@csstools/utilities" "^2.0.0" + postcss-value-parser "^4.2.0" + +postcss-color-rebeccapurple@^10.0.0: + version "10.0.0" + resolved "https://registry.yarnpkg.com/postcss-color-rebeccapurple/-/postcss-color-rebeccapurple-10.0.0.tgz#5ada28406ac47e0796dff4056b0a9d5a6ecead98" + integrity sha512-JFta737jSP+hdAIEhk1Vs0q0YF5P8fFcj+09pweS8ktuGuZ8pPlykHsk6mPxZ8awDl4TrcxUqJo9l1IhVr/OjQ== + dependencies: + "@csstools/utilities" "^2.0.0" + postcss-value-parser "^4.2.0" + +postcss-colormin@^6.1.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/postcss-colormin/-/postcss-colormin-6.1.0.tgz#076e8d3fb291fbff7b10e6b063be9da42ff6488d" + integrity sha512-x9yX7DOxeMAR+BgGVnNSAxmAj98NX/YxEMNFP+SDCEeNLb2r3i6Hh1ksMsnW8Ub5SLCpbescQqn9YEbE9554Sw== + dependencies: + browserslist "^4.23.0" + caniuse-api "^3.0.0" + colord "^2.9.3" + postcss-value-parser "^4.2.0" + +postcss-convert-values@^6.1.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/postcss-convert-values/-/postcss-convert-values-6.1.0.tgz#3498387f8efedb817cbc63901d45bd1ceaa40f48" + integrity sha512-zx8IwP/ts9WvUM6NkVSkiU902QZL1bwPhaVaLynPtCsOTqp+ZKbNi+s6XJg3rfqpKGA/oc7Oxk5t8pOQJcwl/w== + dependencies: + browserslist "^4.23.0" + postcss-value-parser "^4.2.0" + +postcss-custom-media@^11.0.6: + version "11.0.6" + resolved "https://registry.yarnpkg.com/postcss-custom-media/-/postcss-custom-media-11.0.6.tgz#6b450e5bfa209efb736830066682e6567bd04967" + integrity sha512-C4lD4b7mUIw+RZhtY7qUbf4eADmb7Ey8BFA2px9jUbwg7pjTZDl4KY4bvlUV+/vXQvzQRfiGEVJyAbtOsCMInw== + dependencies: + "@csstools/cascade-layer-name-parser" "^2.0.5" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/media-query-list-parser" "^4.0.3" + +postcss-custom-properties@^14.0.6: + version "14.0.6" + resolved "https://registry.yarnpkg.com/postcss-custom-properties/-/postcss-custom-properties-14.0.6.tgz#1af73a650bf115ba052cf915287c9982825fc90e" + integrity sha512-fTYSp3xuk4BUeVhxCSJdIPhDLpJfNakZKoiTDx7yRGCdlZrSJR7mWKVOBS4sBF+5poPQFMj2YdXx1VHItBGihQ== + dependencies: + "@csstools/cascade-layer-name-parser" "^2.0.5" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/utilities" "^2.0.0" + postcss-value-parser "^4.2.0" + +postcss-custom-selectors@^8.0.5: + version "8.0.5" + resolved "https://registry.yarnpkg.com/postcss-custom-selectors/-/postcss-custom-selectors-8.0.5.tgz#9448ed37a12271d7ab6cb364b6f76a46a4a323e8" + integrity sha512-9PGmckHQswiB2usSO6XMSswO2yFWVoCAuih1yl9FVcwkscLjRKjwsjM3t+NIWpSU2Jx3eOiK2+t4vVTQaoCHHg== + dependencies: + "@csstools/cascade-layer-name-parser" "^2.0.5" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + postcss-selector-parser "^7.0.0" + +postcss-dir-pseudo-class@^9.0.1: + version "9.0.1" + resolved "https://registry.yarnpkg.com/postcss-dir-pseudo-class/-/postcss-dir-pseudo-class-9.0.1.tgz#80d9e842c9ae9d29f6bf5fd3cf9972891d6cc0ca" + integrity sha512-tRBEK0MHYvcMUrAuYMEOa0zg9APqirBcgzi6P21OhxtJyJADo/SWBwY1CAwEohQ/6HDaa9jCjLRG7K3PVQYHEA== + dependencies: + postcss-selector-parser "^7.0.0" + +postcss-discard-comments@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-discard-comments/-/postcss-discard-comments-6.0.2.tgz#e768dcfdc33e0216380623652b0a4f69f4678b6c" + integrity sha512-65w/uIqhSBBfQmYnG92FO1mWZjJ4GL5b8atm5Yw2UgrwD7HiNiSSNwJor1eCFGzUgYnN/iIknhNRVqjrrpuglw== + +postcss-discard-duplicates@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/postcss-discard-duplicates/-/postcss-discard-duplicates-6.0.3.tgz#d121e893c38dc58a67277f75bb58ba43fce4c3eb" + integrity sha512-+JA0DCvc5XvFAxwx6f/e68gQu/7Z9ud584VLmcgto28eB8FqSFZwtrLwB5Kcp70eIoWP/HXqz4wpo8rD8gpsTw== + +postcss-discard-empty@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/postcss-discard-empty/-/postcss-discard-empty-6.0.3.tgz#ee39c327219bb70473a066f772621f81435a79d9" + integrity sha512-znyno9cHKQsK6PtxL5D19Fj9uwSzC2mB74cpT66fhgOadEUPyXFkbgwm5tvc3bt3NAy8ltE5MrghxovZRVnOjQ== + +postcss-discard-overridden@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-discard-overridden/-/postcss-discard-overridden-6.0.2.tgz#4e9f9c62ecd2df46e8fdb44dc17e189776572e2d" + integrity sha512-j87xzI4LUggC5zND7KdjsI25APtyMuynXZSujByMaav2roV6OZX+8AaCUcZSWqckZpjAjRyFDdpqybgjFO0HJQ== + +postcss-discard-unused@^6.0.5: + version "6.0.5" + resolved "https://registry.yarnpkg.com/postcss-discard-unused/-/postcss-discard-unused-6.0.5.tgz#c1b0e8c032c6054c3fbd22aaddba5b248136f338" + integrity sha512-wHalBlRHkaNnNwfC8z+ppX57VhvS+HWgjW508esjdaEYr3Mx7Gnn2xA4R/CKf5+Z9S5qsqC+Uzh4ueENWwCVUA== + dependencies: + postcss-selector-parser "^6.0.16" + +postcss-double-position-gradients@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/postcss-double-position-gradients/-/postcss-double-position-gradients-6.0.3.tgz#d8c4b126af89855a3aa6687e5b1a0d5460d4a5b7" + integrity sha512-Dl0Z9sdbMwrPslgOaGBZRGo3TASmmgTcqcUODr82MTYyJk6devXZM6MlQjpQKMJqlLJ6oL1w78U7IXFdPA5+ug== + dependencies: + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + postcss-value-parser "^4.2.0" + +postcss-focus-visible@^10.0.1: + version "10.0.1" + resolved "https://registry.yarnpkg.com/postcss-focus-visible/-/postcss-focus-visible-10.0.1.tgz#1f7904904368a2d1180b220595d77b6f8a957868" + integrity sha512-U58wyjS/I1GZgjRok33aE8juW9qQgQUNwTSdxQGuShHzwuYdcklnvK/+qOWX1Q9kr7ysbraQ6ht6r+udansalA== + dependencies: + postcss-selector-parser "^7.0.0" + +postcss-focus-within@^9.0.1: + version "9.0.1" + resolved "https://registry.yarnpkg.com/postcss-focus-within/-/postcss-focus-within-9.0.1.tgz#ac01ce80d3f2e8b2b3eac4ff84f8e15cd0057bc7" + integrity sha512-fzNUyS1yOYa7mOjpci/bR+u+ESvdar6hk8XNK/TRR0fiGTp2QT5N+ducP0n3rfH/m9I7H/EQU6lsa2BrgxkEjw== + dependencies: + postcss-selector-parser "^7.0.0" + +postcss-font-variant@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/postcss-font-variant/-/postcss-font-variant-5.0.0.tgz#efd59b4b7ea8bb06127f2d031bfbb7f24d32fa66" + integrity sha512-1fmkBaCALD72CK2a9i468mA/+tr9/1cBxRRMXOUaZqO43oWPR5imcyPjXwuv7PXbCid4ndlP5zWhidQVVa3hmA== + +postcss-gap-properties@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/postcss-gap-properties/-/postcss-gap-properties-6.0.0.tgz#d5ff0bdf923c06686499ed2b12e125fe64054fed" + integrity sha512-Om0WPjEwiM9Ru+VhfEDPZJAKWUd0mV1HmNXqp2C29z80aQ2uP9UVhLc7e3aYMIor/S5cVhoPgYQ7RtfeZpYTRw== + +postcss-image-set-function@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/postcss-image-set-function/-/postcss-image-set-function-7.0.0.tgz#538e94e16716be47f9df0573b56bbaca86e1da53" + integrity sha512-QL7W7QNlZuzOwBTeXEmbVckNt1FSmhQtbMRvGGqqU4Nf4xk6KUEQhAoWuMzwbSv5jxiRiSZ5Tv7eiDB9U87znA== + dependencies: + "@csstools/utilities" "^2.0.0" + postcss-value-parser "^4.2.0" + +postcss-lab-function@^7.0.11: + version "7.0.11" + resolved "https://registry.yarnpkg.com/postcss-lab-function/-/postcss-lab-function-7.0.11.tgz#455934181eea130f8e649c1f54692e1768046f6a" + integrity sha512-BEA4jId8uQe1gyjZZ6Bunb6ZsH2izks+v25AxQJDBtigXCjTLmCPWECwQpLTtcxH589MVxhs/9TAmRC6lUEmXQ== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +postcss-loader@^7.3.4: + version "7.3.4" + resolved "https://registry.yarnpkg.com/postcss-loader/-/postcss-loader-7.3.4.tgz#aed9b79ce4ed7e9e89e56199d25ad1ec8f606209" + integrity sha512-iW5WTTBSC5BfsBJ9daFMPVrLT36MrNiC6fqOZTTaHjBNX6Pfd5p+hSBqe/fEeNd7pc13QiAyGt7VdGMw4eRC4A== + dependencies: + cosmiconfig "^8.3.5" + jiti "^1.20.0" + semver "^7.5.4" + +postcss-logical@^8.1.0: + version "8.1.0" + resolved "https://registry.yarnpkg.com/postcss-logical/-/postcss-logical-8.1.0.tgz#4092b16b49e3ecda70c4d8945257da403d167228" + integrity sha512-pL1hXFQ2fEXNKiNiAgtfA005T9FBxky5zkX6s4GZM2D8RkVgRqz3f4g1JUoq925zXv495qk8UNldDwh8uGEDoA== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-merge-idents@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/postcss-merge-idents/-/postcss-merge-idents-6.0.3.tgz#7b9c31c7bc823c94bec50f297f04e3c2b838ea65" + integrity sha512-1oIoAsODUs6IHQZkLQGO15uGEbK3EAl5wi9SS8hs45VgsxQfMnxvt+L+zIr7ifZFIH14cfAeVe2uCTa+SPRa3g== + dependencies: + cssnano-utils "^4.0.2" + postcss-value-parser "^4.2.0" + +postcss-merge-longhand@^6.0.5: + version "6.0.5" + resolved "https://registry.yarnpkg.com/postcss-merge-longhand/-/postcss-merge-longhand-6.0.5.tgz#ba8a8d473617c34a36abbea8dda2b215750a065a" + integrity sha512-5LOiordeTfi64QhICp07nzzuTDjNSO8g5Ksdibt44d+uvIIAE1oZdRn8y/W5ZtYgRH/lnLDlvi9F8btZcVzu3w== + dependencies: + postcss-value-parser "^4.2.0" + stylehacks "^6.1.1" + +postcss-merge-rules@^6.1.1: + version "6.1.1" + resolved "https://registry.yarnpkg.com/postcss-merge-rules/-/postcss-merge-rules-6.1.1.tgz#7aa539dceddab56019469c0edd7d22b64c3dea9d" + integrity sha512-KOdWF0gju31AQPZiD+2Ar9Qjowz1LTChSjFFbS+e2sFgc4uHOp3ZvVX4sNeTlk0w2O31ecFGgrFzhO0RSWbWwQ== + dependencies: + browserslist "^4.23.0" + caniuse-api "^3.0.0" + cssnano-utils "^4.0.2" + postcss-selector-parser "^6.0.16" + +postcss-minify-font-values@^6.1.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/postcss-minify-font-values/-/postcss-minify-font-values-6.1.0.tgz#a0e574c02ee3f299be2846369211f3b957ea4c59" + integrity sha512-gklfI/n+9rTh8nYaSJXlCo3nOKqMNkxuGpTn/Qm0gstL3ywTr9/WRKznE+oy6fvfolH6dF+QM4nCo8yPLdvGJg== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-minify-gradients@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/postcss-minify-gradients/-/postcss-minify-gradients-6.0.3.tgz#ca3eb55a7bdb48a1e187a55c6377be918743dbd6" + integrity sha512-4KXAHrYlzF0Rr7uc4VrfwDJ2ajrtNEpNEuLxFgwkhFZ56/7gaE4Nr49nLsQDZyUe+ds+kEhf+YAUolJiYXF8+Q== + dependencies: + colord "^2.9.3" + cssnano-utils "^4.0.2" + postcss-value-parser "^4.2.0" + +postcss-minify-params@^6.1.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/postcss-minify-params/-/postcss-minify-params-6.1.0.tgz#54551dec77b9a45a29c3cb5953bf7325a399ba08" + integrity sha512-bmSKnDtyyE8ujHQK0RQJDIKhQ20Jq1LYiez54WiaOoBtcSuflfK3Nm596LvbtlFcpipMjgClQGyGr7GAs+H1uA== + dependencies: + browserslist "^4.23.0" + cssnano-utils "^4.0.2" + postcss-value-parser "^4.2.0" + +postcss-minify-selectors@^6.0.4: + version "6.0.4" + resolved "https://registry.yarnpkg.com/postcss-minify-selectors/-/postcss-minify-selectors-6.0.4.tgz#197f7d72e6dd19eed47916d575d69dc38b396aff" + integrity sha512-L8dZSwNLgK7pjTto9PzWRoMbnLq5vsZSTu8+j1P/2GB8qdtGQfn+K1uSvFgYvgh83cbyxT5m43ZZhUMTJDSClQ== + dependencies: + postcss-selector-parser "^6.0.16" + +postcss-modules-extract-imports@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/postcss-modules-extract-imports/-/postcss-modules-extract-imports-3.1.0.tgz#b4497cb85a9c0c4b5aabeb759bb25e8d89f15002" + integrity sha512-k3kNe0aNFQDAZGbin48pL2VNidTF0w4/eASDsxlyspobzU3wZQLOGj7L9gfRe0Jo9/4uud09DsjFNH7winGv8Q== + +postcss-modules-local-by-default@^4.0.5: + version "4.2.0" + resolved "https://registry.yarnpkg.com/postcss-modules-local-by-default/-/postcss-modules-local-by-default-4.2.0.tgz#d150f43837831dae25e4085596e84f6f5d6ec368" + integrity sha512-5kcJm/zk+GJDSfw+V/42fJ5fhjL5YbFDl8nVdXkJPLLW+Vf9mTD5Xe0wqIaDnLuL2U6cDNpTr+UQ+v2HWIBhzw== + dependencies: + icss-utils "^5.0.0" + postcss-selector-parser "^7.0.0" + postcss-value-parser "^4.1.0" + +postcss-modules-scope@^3.2.0: + version "3.2.1" + resolved "https://registry.yarnpkg.com/postcss-modules-scope/-/postcss-modules-scope-3.2.1.tgz#1bbccddcb398f1d7a511e0a2d1d047718af4078c" + integrity sha512-m9jZstCVaqGjTAuny8MdgE88scJnCiQSlSrOWcTQgM2t32UBe+MUmFSO5t7VMSfAf/FJKImAxBav8ooCHJXCJA== + dependencies: + postcss-selector-parser "^7.0.0" + +postcss-modules-values@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/postcss-modules-values/-/postcss-modules-values-4.0.0.tgz#d7c5e7e68c3bb3c9b27cbf48ca0bb3ffb4602c9c" + integrity sha512-RDxHkAiEGI78gS2ofyvCsu7iycRv7oqw5xMWn9iMoR0N/7mf9D50ecQqUo5BZ9Zh2vH4bCUR/ktCqbB9m8vJjQ== + dependencies: + icss-utils "^5.0.0" + +postcss-nesting@^13.0.2: + version "13.0.2" + resolved "https://registry.yarnpkg.com/postcss-nesting/-/postcss-nesting-13.0.2.tgz#fde0d4df772b76d03b52eccc84372e8d1ca1402e" + integrity sha512-1YCI290TX+VP0U/K/aFxzHzQWHWURL+CtHMSbex1lCdpXD1SoR2sYuxDu5aNI9lPoXpKTCggFZiDJbwylU0LEQ== + dependencies: + "@csstools/selector-resolve-nested" "^3.1.0" + "@csstools/selector-specificity" "^5.0.0" + postcss-selector-parser "^7.0.0" + +postcss-normalize-charset@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-normalize-charset/-/postcss-normalize-charset-6.0.2.tgz#1ec25c435057a8001dac942942a95ffe66f721e1" + integrity sha512-a8N9czmdnrjPHa3DeFlwqst5eaL5W8jYu3EBbTTkI5FHkfMhFZh1EGbku6jhHhIzTA6tquI2P42NtZ59M/H/kQ== + +postcss-normalize-display-values@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-normalize-display-values/-/postcss-normalize-display-values-6.0.2.tgz#54f02764fed0b288d5363cbb140d6950dbbdd535" + integrity sha512-8H04Mxsb82ON/aAkPeq8kcBbAtI5Q2a64X/mnRRfPXBq7XeogoQvReqxEfc0B4WPq1KimjezNC8flUtC3Qz6jg== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-normalize-positions@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-normalize-positions/-/postcss-normalize-positions-6.0.2.tgz#e982d284ec878b9b819796266f640852dbbb723a" + integrity sha512-/JFzI441OAB9O7VnLA+RtSNZvQ0NCFZDOtp6QPFo1iIyawyXg0YI3CYM9HBy1WvwCRHnPep/BvI1+dGPKoXx/Q== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-normalize-repeat-style@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-normalize-repeat-style/-/postcss-normalize-repeat-style-6.0.2.tgz#f8006942fd0617c73f049dd8b6201c3a3040ecf3" + integrity sha512-YdCgsfHkJ2jEXwR4RR3Tm/iOxSfdRt7jplS6XRh9Js9PyCR/aka/FCb6TuHT2U8gQubbm/mPmF6L7FY9d79VwQ== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-normalize-string@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-normalize-string/-/postcss-normalize-string-6.0.2.tgz#e3cc6ad5c95581acd1fc8774b309dd7c06e5e363" + integrity sha512-vQZIivlxlfqqMp4L9PZsFE4YUkWniziKjQWUtsxUiVsSSPelQydwS8Wwcuw0+83ZjPWNTl02oxlIvXsmmG+CiQ== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-normalize-timing-functions@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-normalize-timing-functions/-/postcss-normalize-timing-functions-6.0.2.tgz#40cb8726cef999de984527cbd9d1db1f3e9062c0" + integrity sha512-a+YrtMox4TBtId/AEwbA03VcJgtyW4dGBizPl7e88cTFULYsprgHWTbfyjSLyHeBcK/Q9JhXkt2ZXiwaVHoMzA== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-normalize-unicode@^6.1.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/postcss-normalize-unicode/-/postcss-normalize-unicode-6.1.0.tgz#aaf8bbd34c306e230777e80f7f12a4b7d27ce06e" + integrity sha512-QVC5TQHsVj33otj8/JD869Ndr5Xcc/+fwRh4HAsFsAeygQQXm+0PySrKbr/8tkDKzW+EVT3QkqZMfFrGiossDg== + dependencies: + browserslist "^4.23.0" + postcss-value-parser "^4.2.0" + +postcss-normalize-url@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-normalize-url/-/postcss-normalize-url-6.0.2.tgz#292792386be51a8de9a454cb7b5c58ae22db0f79" + integrity sha512-kVNcWhCeKAzZ8B4pv/DnrU1wNh458zBNp8dh4y5hhxih5RZQ12QWMuQrDgPRw3LRl8mN9vOVfHl7uhvHYMoXsQ== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-normalize-whitespace@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-normalize-whitespace/-/postcss-normalize-whitespace-6.0.2.tgz#fbb009e6ebd312f8b2efb225c2fcc7cf32b400cd" + integrity sha512-sXZ2Nj1icbJOKmdjXVT9pnyHQKiSAyuNQHSgRCUgThn2388Y9cGVDR+E9J9iAYbSbLHI+UUwLVl1Wzco/zgv0Q== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-opacity-percentage@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/postcss-opacity-percentage/-/postcss-opacity-percentage-3.0.0.tgz#0b0db5ed5db5670e067044b8030b89c216e1eb0a" + integrity sha512-K6HGVzyxUxd/VgZdX04DCtdwWJ4NGLG212US4/LA1TLAbHgmAsTWVR86o+gGIbFtnTkfOpb9sCRBx8K7HO66qQ== + +postcss-ordered-values@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-ordered-values/-/postcss-ordered-values-6.0.2.tgz#366bb663919707093451ab70c3f99c05672aaae5" + integrity sha512-VRZSOB+JU32RsEAQrO94QPkClGPKJEL/Z9PCBImXMhIeK5KAYo6slP/hBYlLgrCjFxyqvn5VC81tycFEDBLG1Q== + dependencies: + cssnano-utils "^4.0.2" + postcss-value-parser "^4.2.0" + +postcss-overflow-shorthand@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/postcss-overflow-shorthand/-/postcss-overflow-shorthand-6.0.0.tgz#f5252b4a2ee16c68cd8a9029edb5370c4a9808af" + integrity sha512-BdDl/AbVkDjoTofzDQnwDdm/Ym6oS9KgmO7Gr+LHYjNWJ6ExORe4+3pcLQsLA9gIROMkiGVjjwZNoL/mpXHd5Q== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-page-break@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/postcss-page-break/-/postcss-page-break-3.0.4.tgz#7fbf741c233621622b68d435babfb70dd8c1ee5f" + integrity sha512-1JGu8oCjVXLa9q9rFTo4MbeeA5FMe00/9C7lN4va606Rdb+HkxXtXsmEDrIraQ11fGz/WvKWa8gMuCKkrXpTsQ== + +postcss-place@^10.0.0: + version "10.0.0" + resolved "https://registry.yarnpkg.com/postcss-place/-/postcss-place-10.0.0.tgz#ba36ee4786ca401377ced17a39d9050ed772e5a9" + integrity sha512-5EBrMzat2pPAxQNWYavwAfoKfYcTADJ8AXGVPcUZ2UkNloUTWzJQExgrzrDkh3EKzmAx1evfTAzF9I8NGcc+qw== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-preset-env@^10.2.1: + version "10.3.1" + resolved "https://registry.yarnpkg.com/postcss-preset-env/-/postcss-preset-env-10.3.1.tgz#f3799f0f7a7ea384b3c16e073055c231d11bb3bf" + integrity sha512-8ZOOWVwQ0iMpfEYkYo+U6W7fE2dJ/tP6dtEFwPJ66eB5JjnFupfYh+y6zo+vWDO72nGhKOVdxwhTjfzcSNRg4Q== + dependencies: + "@csstools/postcss-alpha-function" "^1.0.0" + "@csstools/postcss-cascade-layers" "^5.0.2" + "@csstools/postcss-color-function" "^4.0.11" + "@csstools/postcss-color-function-display-p3-linear" "^1.0.0" + "@csstools/postcss-color-mix-function" "^3.0.11" + "@csstools/postcss-color-mix-variadic-function-arguments" "^1.0.1" + "@csstools/postcss-content-alt-text" "^2.0.7" + "@csstools/postcss-exponential-functions" "^2.0.9" + "@csstools/postcss-font-format-keywords" "^4.0.0" + "@csstools/postcss-gamut-mapping" "^2.0.11" + "@csstools/postcss-gradients-interpolation-method" "^5.0.11" + "@csstools/postcss-hwb-function" "^4.0.11" + "@csstools/postcss-ic-unit" "^4.0.3" + "@csstools/postcss-initial" "^2.0.1" + "@csstools/postcss-is-pseudo-class" "^5.0.3" + "@csstools/postcss-light-dark-function" "^2.0.10" + "@csstools/postcss-logical-float-and-clear" "^3.0.0" + "@csstools/postcss-logical-overflow" "^2.0.0" + "@csstools/postcss-logical-overscroll-behavior" "^2.0.0" + "@csstools/postcss-logical-resize" "^3.0.0" + "@csstools/postcss-logical-viewport-units" "^3.0.4" + "@csstools/postcss-media-minmax" "^2.0.9" + "@csstools/postcss-media-queries-aspect-ratio-number-values" "^3.0.5" + "@csstools/postcss-nested-calc" "^4.0.0" + "@csstools/postcss-normalize-display-values" "^4.0.0" + "@csstools/postcss-oklab-function" "^4.0.11" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/postcss-random-function" "^2.0.1" + "@csstools/postcss-relative-color-syntax" "^3.0.11" + "@csstools/postcss-scope-pseudo-class" "^4.0.1" + "@csstools/postcss-sign-functions" "^1.1.4" + "@csstools/postcss-stepped-value-functions" "^4.0.9" + "@csstools/postcss-text-decoration-shorthand" "^4.0.3" + "@csstools/postcss-trigonometric-functions" "^4.0.9" + "@csstools/postcss-unset-value" "^4.0.0" + autoprefixer "^10.4.21" + browserslist "^4.25.1" + css-blank-pseudo "^7.0.1" + css-has-pseudo "^7.0.3" + css-prefers-color-scheme "^10.0.0" + cssdb "^8.4.0" + postcss-attribute-case-insensitive "^7.0.1" + postcss-clamp "^4.1.0" + postcss-color-functional-notation "^7.0.11" + postcss-color-hex-alpha "^10.0.0" + postcss-color-rebeccapurple "^10.0.0" + postcss-custom-media "^11.0.6" + postcss-custom-properties "^14.0.6" + postcss-custom-selectors "^8.0.5" + postcss-dir-pseudo-class "^9.0.1" + postcss-double-position-gradients "^6.0.3" + postcss-focus-visible "^10.0.1" + postcss-focus-within "^9.0.1" + postcss-font-variant "^5.0.0" + postcss-gap-properties "^6.0.0" + postcss-image-set-function "^7.0.0" + postcss-lab-function "^7.0.11" + postcss-logical "^8.1.0" + postcss-nesting "^13.0.2" + postcss-opacity-percentage "^3.0.0" + postcss-overflow-shorthand "^6.0.0" + postcss-page-break "^3.0.4" + postcss-place "^10.0.0" + postcss-pseudo-class-any-link "^10.0.1" + postcss-replace-overflow-wrap "^4.0.0" + postcss-selector-not "^8.0.1" + +postcss-pseudo-class-any-link@^10.0.1: + version "10.0.1" + resolved "https://registry.yarnpkg.com/postcss-pseudo-class-any-link/-/postcss-pseudo-class-any-link-10.0.1.tgz#06455431171bf44b84d79ebaeee9fd1c05946544" + integrity sha512-3el9rXlBOqTFaMFkWDOkHUTQekFIYnaQY55Rsp8As8QQkpiSgIYEcF/6Ond93oHiDsGb4kad8zjt+NPlOC1H0Q== + dependencies: + postcss-selector-parser "^7.0.0" + +postcss-reduce-idents@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/postcss-reduce-idents/-/postcss-reduce-idents-6.0.3.tgz#b0d9c84316d2a547714ebab523ec7d13704cd486" + integrity sha512-G3yCqZDpsNPoQgbDUy3T0E6hqOQ5xigUtBQyrmq3tn2GxlyiL0yyl7H+T8ulQR6kOcHJ9t7/9H4/R2tv8tJbMA== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-reduce-initial@^6.1.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/postcss-reduce-initial/-/postcss-reduce-initial-6.1.0.tgz#4401297d8e35cb6e92c8e9586963e267105586ba" + integrity sha512-RarLgBK/CrL1qZags04oKbVbrrVK2wcxhvta3GCxrZO4zveibqbRPmm2VI8sSgCXwoUHEliRSbOfpR0b/VIoiw== + dependencies: + browserslist "^4.23.0" + caniuse-api "^3.0.0" + +postcss-reduce-transforms@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-reduce-transforms/-/postcss-reduce-transforms-6.0.2.tgz#6fa2c586bdc091a7373caeee4be75a0f3e12965d" + integrity sha512-sB+Ya++3Xj1WaT9+5LOOdirAxP7dJZms3GRcYheSPi1PiTMigsxHAdkrbItHxwYHr4kt1zL7mmcHstgMYT+aiA== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-replace-overflow-wrap@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/postcss-replace-overflow-wrap/-/postcss-replace-overflow-wrap-4.0.0.tgz#d2df6bed10b477bf9c52fab28c568b4b29ca4319" + integrity sha512-KmF7SBPphT4gPPcKZc7aDkweHiKEEO8cla/GjcBK+ckKxiZslIu3C4GCRW3DNfL0o7yW7kMQu9xlZ1kXRXLXtw== + +postcss-selector-not@^8.0.1: + version "8.0.1" + resolved "https://registry.yarnpkg.com/postcss-selector-not/-/postcss-selector-not-8.0.1.tgz#f2df9c6ac9f95e9fe4416ca41a957eda16130172" + integrity sha512-kmVy/5PYVb2UOhy0+LqUYAhKj7DUGDpSWa5LZqlkWJaaAV+dxxsOG3+St0yNLu6vsKD7Dmqx+nWQt0iil89+WA== + dependencies: + postcss-selector-parser "^7.0.0" + +postcss-selector-parser@^6.0.11, postcss-selector-parser@^6.0.16: + version "6.1.2" + resolved "https://registry.yarnpkg.com/postcss-selector-parser/-/postcss-selector-parser-6.1.2.tgz#27ecb41fb0e3b6ba7a1ec84fff347f734c7929de" + integrity sha512-Q8qQfPiZ+THO/3ZrOrO0cJJKfpYCagtMUkXbnEfmgUjwXg6z/WBeOyS9APBBPCTSiDV+s4SwQGu8yFsiMRIudg== + dependencies: + cssesc "^3.0.0" + util-deprecate "^1.0.2" + +postcss-selector-parser@^7.0.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz#4d6af97eba65d73bc4d84bcb343e865d7dd16262" + integrity sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA== + dependencies: + cssesc "^3.0.0" + util-deprecate "^1.0.2" + +postcss-sort-media-queries@^5.2.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/postcss-sort-media-queries/-/postcss-sort-media-queries-5.2.0.tgz#4556b3f982ef27d3bac526b99b6c0d3359a6cf97" + integrity sha512-AZ5fDMLD8SldlAYlvi8NIqo0+Z8xnXU2ia0jxmuhxAU+Lqt9K+AlmLNJ/zWEnE9x+Zx3qL3+1K20ATgNOr3fAA== + dependencies: + sort-css-media-queries "2.2.0" + +postcss-svgo@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/postcss-svgo/-/postcss-svgo-6.0.3.tgz#1d6e180d6df1fa8a3b30b729aaa9161e94f04eaa" + integrity sha512-dlrahRmxP22bX6iKEjOM+c8/1p+81asjKT+V5lrgOH944ryx/OHpclnIbGsKVd3uWOXFLYJwCVf0eEkJGvO96g== + dependencies: + postcss-value-parser "^4.2.0" + svgo "^3.2.0" + +postcss-unique-selectors@^6.0.4: + version "6.0.4" + resolved "https://registry.yarnpkg.com/postcss-unique-selectors/-/postcss-unique-selectors-6.0.4.tgz#983ab308896b4bf3f2baaf2336e14e52c11a2088" + integrity sha512-K38OCaIrO8+PzpArzkLKB42dSARtC2tmG6PvD4b1o1Q2E9Os8jzfWFfSy/rixsHwohtsDdFtAWGjFVFUdwYaMg== + dependencies: + postcss-selector-parser "^6.0.16" + +postcss-value-parser@^4.1.0, postcss-value-parser@^4.2.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/postcss-value-parser/-/postcss-value-parser-4.2.0.tgz#723c09920836ba6d3e5af019f92bc0971c02e514" + integrity sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ== + +postcss-zindex@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-zindex/-/postcss-zindex-6.0.2.tgz#e498304b83a8b165755f53db40e2ea65a99b56e1" + integrity sha512-5BxW9l1evPB/4ZIc+2GobEBoKC+h8gPGCMi+jxsYvd2x0mjq7wazk6DrP71pStqxE9Foxh5TVnonbWpFZzXaYg== + +postcss@^8.4.21, postcss@^8.4.24, postcss@^8.4.33, postcss@^8.5.4: + version "8.5.6" + resolved "https://registry.yarnpkg.com/postcss/-/postcss-8.5.6.tgz#2825006615a619b4f62a9e7426cc120b349a8f3c" + integrity sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg== + dependencies: + nanoid "^3.3.11" + picocolors "^1.1.1" + source-map-js "^1.2.1" + +pretty-error@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/pretty-error/-/pretty-error-4.0.0.tgz#90a703f46dd7234adb46d0f84823e9d1cb8f10d6" + integrity sha512-AoJ5YMAcXKYxKhuJGdcvse+Voc6v1RgnsR3nWcYU7q4t6z0Q6T86sv5Zq8VIRbOWWFpvdGE83LtdSMNd+6Y0xw== + dependencies: + lodash "^4.17.20" + renderkid "^3.0.0" + +pretty-time@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/pretty-time/-/pretty-time-1.1.0.tgz#ffb7429afabb8535c346a34e41873adf3d74dd0e" + integrity sha512-28iF6xPQrP8Oa6uxE6a1biz+lWeTOAPKggvjB8HAs6nVMKZwf5bG++632Dx614hIWgUPkgivRfG+a8uAXGTIbA== + +prism-react-renderer@^2.3.0: + version "2.4.1" + resolved "https://registry.yarnpkg.com/prism-react-renderer/-/prism-react-renderer-2.4.1.tgz#ac63b7f78e56c8f2b5e76e823a976d5ede77e35f" + integrity sha512-ey8Ls/+Di31eqzUxC46h8MksNuGx/n0AAC8uKpwFau4RPDYLuE3EXTp8N8G2vX2N7UC/+IXeNUnlWBGGcAG+Ig== + dependencies: + "@types/prismjs" "^1.26.0" + clsx "^2.0.0" + +prismjs@^1.29.0: + version "1.30.0" + resolved "https://registry.yarnpkg.com/prismjs/-/prismjs-1.30.0.tgz#d9709969d9d4e16403f6f348c63553b19f0975a9" + integrity sha512-DEvV2ZF2r2/63V+tK8hQvrR2ZGn10srHbXviTlcv7Kpzw8jWiNTqbVgjO3IY8RxrrOUF8VPMQQFysYYYv0YZxw== + +process-nextick-args@~2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/process-nextick-args/-/process-nextick-args-2.0.1.tgz#7820d9b16120cc55ca9ae7792680ae7dba6d7fe2" + integrity sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag== + +prompts@^2.4.2: + version "2.4.2" + resolved "https://registry.yarnpkg.com/prompts/-/prompts-2.4.2.tgz#7b57e73b3a48029ad10ebd44f74b01722a4cb069" + integrity sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q== + dependencies: + kleur "^3.0.3" + sisteransi "^1.0.5" + +prop-types@^15.6.2, prop-types@^15.7.2, prop-types@^15.8.1: + version "15.8.1" + resolved "https://registry.yarnpkg.com/prop-types/-/prop-types-15.8.1.tgz#67d87bf1a694f48435cf332c24af10214a3140b5" + integrity sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg== + dependencies: + loose-envify "^1.4.0" + object-assign "^4.1.1" + react-is "^16.13.1" + +property-information@^6.0.0: + version "6.5.0" + resolved "https://registry.yarnpkg.com/property-information/-/property-information-6.5.0.tgz#6212fbb52ba757e92ef4fb9d657563b933b7ffec" + integrity sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig== + +property-information@^7.0.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/property-information/-/property-information-7.1.0.tgz#b622e8646e02b580205415586b40804d3e8bfd5d" + integrity sha512-TwEZ+X+yCJmYfL7TPUOcvBZ4QfoT5YenQiJuX//0th53DE6w0xxLEtfK3iyryQFddXuvkIk51EEgrJQ0WJkOmQ== + +proto-list@~1.2.1: + version "1.2.4" + resolved "https://registry.yarnpkg.com/proto-list/-/proto-list-1.2.4.tgz#212d5bfe1318306a420f6402b8e26ff39647a849" + integrity sha512-vtK/94akxsTMhe0/cbfpR+syPuszcuwhqVjJq26CuNDgFGj682oRBXOP5MJpv2r7JtE8MsiepGIqvvOTBwn2vA== + +proxy-addr@~2.0.7: + version "2.0.7" + resolved "https://registry.yarnpkg.com/proxy-addr/-/proxy-addr-2.0.7.tgz#f19fe69ceab311eeb94b42e70e8c2070f9ba1025" + integrity sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg== + dependencies: + forwarded "0.2.0" + ipaddr.js "1.9.1" + +punycode@^2.1.0: + version "2.3.1" + resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.3.1.tgz#027422e2faec0b25e1549c3e1bd8309b9133b6e5" + integrity sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg== + +pupa@^3.1.0: + version "3.2.1" + resolved "https://registry.yarnpkg.com/pupa/-/pupa-3.2.1.tgz#e28278e4b6e4f5ece1c04404a507ce0d5ecfb4d6" + integrity sha512-6koJt2wLdmDICU5Yht9X4mYjQUFcah7cAu9PEgGP+JGbLQpUQFfaCauHLeutygSkt50oMEX7oAQNmUHxGh5GHQ== + dependencies: + escape-goat "^4.0.0" + +qs@6.13.0: + version "6.13.0" + resolved "https://registry.yarnpkg.com/qs/-/qs-6.13.0.tgz#6ca3bd58439f7e245655798997787b0d88a51906" + integrity sha512-+38qI9SOr8tfZ4QmJNplMUxqjbe7LKvvZgWdExBOmd+egZTtjLB67Gu0HRX3u/XOq7UU2Nx6nsjvS16Z9uwfpg== + dependencies: + side-channel "^1.0.6" + +queue-microtask@^1.2.2: + version "1.2.3" + resolved "https://registry.yarnpkg.com/queue-microtask/-/queue-microtask-1.2.3.tgz#4929228bbc724dfac43e0efb058caf7b6cfb6243" + integrity sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A== + +quick-lru@^5.1.1: + version "5.1.1" + resolved "https://registry.yarnpkg.com/quick-lru/-/quick-lru-5.1.1.tgz#366493e6b3e42a3a6885e2e99d18f80fb7a8c932" + integrity sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA== + +randombytes@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/randombytes/-/randombytes-2.1.0.tgz#df6f84372f0270dc65cdf6291349ab7a473d4f2a" + integrity sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ== + dependencies: + safe-buffer "^5.1.0" + +range-parser@1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/range-parser/-/range-parser-1.2.0.tgz#f49be6b487894ddc40dcc94a322f611092e00d5e" + integrity sha512-kA5WQoNVo4t9lNx2kQNFCxKeBl5IbbSNBl1M/tLkw9WCn+hxNBAW5Qh8gdhs63CJnhjJ2zQWFoqPJP2sK1AV5A== + +range-parser@^1.2.1, range-parser@~1.2.1: + version "1.2.1" + resolved "https://registry.yarnpkg.com/range-parser/-/range-parser-1.2.1.tgz#3cf37023d199e1c24d1a55b84800c2f3e6468031" + integrity sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg== + +raw-body@2.5.2: + version "2.5.2" + resolved "https://registry.yarnpkg.com/raw-body/-/raw-body-2.5.2.tgz#99febd83b90e08975087e8f1f9419a149366b68a" + integrity sha512-8zGqypfENjCIqGhgXToC8aB2r7YrBX+AQAfIPs/Mlk+BtPTztOvTS01NRW/3Eh60J+a48lt8qsCzirQ6loCVfA== + dependencies: + bytes "3.1.2" + http-errors "2.0.0" + iconv-lite "0.4.24" + unpipe "1.0.0" + +rc@1.2.8: + version "1.2.8" + resolved "https://registry.yarnpkg.com/rc/-/rc-1.2.8.tgz#cd924bf5200a075b83c188cd6b9e211b7fc0d3ed" + integrity sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw== + dependencies: + deep-extend "^0.6.0" + ini "~1.3.0" + minimist "^1.2.0" + strip-json-comments "~2.0.1" + +react-dom@^19.0.0: + version "19.1.1" + resolved "https://registry.yarnpkg.com/react-dom/-/react-dom-19.1.1.tgz#2daa9ff7f3ae384aeb30e76d5ee38c046dc89893" + integrity sha512-Dlq/5LAZgF0Gaz6yiqZCf6VCcZs1ghAJyrsu84Q/GT0gV+mCxbfmKNoGRKBYMJ8IEdGPqu49YWXD02GCknEDkw== + dependencies: + scheduler "^0.26.0" + +react-fast-compare@^3.2.0: + version "3.2.2" + resolved "https://registry.yarnpkg.com/react-fast-compare/-/react-fast-compare-3.2.2.tgz#929a97a532304ce9fee4bcae44234f1ce2c21d49" + integrity sha512-nsO+KSNgo1SbJqJEYRE9ERzo7YtYbou/OqjSQKxV7jcKox7+usiUVZOAC+XnDOABXggQTno0Y1CpVnuWEc1boQ== + +"react-helmet-async@npm:@slorber/react-helmet-async@1.3.0": + version "1.3.0" + resolved "https://registry.yarnpkg.com/@slorber/react-helmet-async/-/react-helmet-async-1.3.0.tgz#11fbc6094605cf60aa04a28c17e0aab894b4ecff" + integrity sha512-e9/OK8VhwUSc67diWI8Rb3I0YgI9/SBQtnhe9aEuK6MhZm7ntZZimXgwXnd8W96YTmSOb9M4d8LwhRZyhWr/1A== + dependencies: + "@babel/runtime" "^7.12.5" + invariant "^2.2.4" + prop-types "^15.7.2" + react-fast-compare "^3.2.0" + shallowequal "^1.1.0" + +react-is@^16.13.1, react-is@^16.6.0, react-is@^16.7.0: + version "16.13.1" + resolved "https://registry.yarnpkg.com/react-is/-/react-is-16.13.1.tgz#789729a4dc36de2999dc156dd6c1d9c18cea56a4" + integrity sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ== + +react-is@^19.1.1: + version "19.1.1" + resolved "https://registry.yarnpkg.com/react-is/-/react-is-19.1.1.tgz#038ebe313cf18e1fd1235d51c87360eb87f7c36a" + integrity sha512-tr41fA15Vn8p4X9ntI+yCyeGSf1TlYaY5vlTZfQmeLBrFo3psOPX6HhTDnFNL9uj3EhP0KAQ80cugCl4b4BERA== + +react-json-view-lite@^2.3.0: + version "2.5.0" + resolved "https://registry.yarnpkg.com/react-json-view-lite/-/react-json-view-lite-2.5.0.tgz#c7ff011c7cc80e9900abc7aa4916c6a5c6d6c1c6" + integrity sha512-tk7o7QG9oYyELWHL8xiMQ8x4WzjCzbWNyig3uexmkLb54r8jO0yH3WCWx8UZS0c49eSA4QUmG5caiRJ8fAn58g== + +react-loadable-ssr-addon-v5-slorber@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/react-loadable-ssr-addon-v5-slorber/-/react-loadable-ssr-addon-v5-slorber-1.0.1.tgz#2cdc91e8a744ffdf9e3556caabeb6e4278689883" + integrity sha512-lq3Lyw1lGku8zUEJPDxsNm1AfYHBrO9Y1+olAYwpUJ2IGFBskM0DMKok97A6LWUpHm+o7IvQBOWu9MLenp9Z+A== + dependencies: + "@babel/runtime" "^7.10.3" + +"react-loadable@npm:@docusaurus/react-loadable@6.0.0": + version "6.0.0" + resolved "https://registry.yarnpkg.com/@docusaurus/react-loadable/-/react-loadable-6.0.0.tgz#de6c7f73c96542bd70786b8e522d535d69069dc4" + integrity sha512-YMMxTUQV/QFSnbgrP3tjDzLHRg7vsbMn8e9HAa8o/1iXoiomo48b7sk/kkmWEuWNDPJVlKSJRB6Y2fHqdJk+SQ== + dependencies: + "@types/react" "*" + +react-router-config@^5.1.1: + version "5.1.1" + resolved "https://registry.yarnpkg.com/react-router-config/-/react-router-config-5.1.1.tgz#0f4263d1a80c6b2dc7b9c1902c9526478194a988" + integrity sha512-DuanZjaD8mQp1ppHjgnnUnyOlqYXZVjnov/JzFhjLEwd3Z4dYjMSnqrEzzGThH47vpCOqPPwJM2FtthLeJ8Pbg== + dependencies: + "@babel/runtime" "^7.1.2" + +react-router-dom@^5.3.4: + version "5.3.4" + resolved "https://registry.yarnpkg.com/react-router-dom/-/react-router-dom-5.3.4.tgz#2ed62ffd88cae6db134445f4a0c0ae8b91d2e5e6" + integrity sha512-m4EqFMHv/Ih4kpcBCONHbkT68KoAeHN4p3lAGoNryfHi0dMy0kCzEZakiKRsvg5wHZ/JLrLW8o8KomWiz/qbYQ== + dependencies: + "@babel/runtime" "^7.12.13" + history "^4.9.0" + loose-envify "^1.3.1" + prop-types "^15.6.2" + react-router "5.3.4" + tiny-invariant "^1.0.2" + tiny-warning "^1.0.0" + +react-router@5.3.4, react-router@^5.3.4: + version "5.3.4" + resolved "https://registry.yarnpkg.com/react-router/-/react-router-5.3.4.tgz#8ca252d70fcc37841e31473c7a151cf777887bb5" + integrity sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA== + dependencies: + "@babel/runtime" "^7.12.13" + history "^4.9.0" + hoist-non-react-statics "^3.1.0" + loose-envify "^1.3.1" + path-to-regexp "^1.7.0" + prop-types "^15.6.2" + react-is "^16.6.0" + tiny-invariant "^1.0.2" + tiny-warning "^1.0.0" + +react-transition-group@^4.4.5: + version "4.4.5" + resolved "https://registry.yarnpkg.com/react-transition-group/-/react-transition-group-4.4.5.tgz#e53d4e3f3344da8521489fbef8f2581d42becdd1" + integrity sha512-pZcd1MCJoiKiBR2NRxeCRg13uCXbydPnmB4EOeRrY7480qNWO8IIgQG6zlDkm6uRMsURXPuKq0GWtiM59a5Q6g== + dependencies: + "@babel/runtime" "^7.5.5" + dom-helpers "^5.0.1" + loose-envify "^1.4.0" + prop-types "^15.6.2" + +react@^19.0.0: + version "19.1.1" + resolved "https://registry.yarnpkg.com/react/-/react-19.1.1.tgz#06d9149ec5e083a67f9a1e39ce97b06a03b644af" + integrity sha512-w8nqGImo45dmMIfljjMwOGtbmC/mk4CMYhWIicdSflH91J9TyCyczcPFXJzrZ/ZXcgGRFeP6BU0BEJTw6tZdfQ== + +readable-stream@^2.0.1: + version "2.3.8" + resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.3.8.tgz#91125e8042bba1b9887f49345f6277027ce8be9b" + integrity sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA== + dependencies: + core-util-is "~1.0.0" + inherits "~2.0.3" + isarray "~1.0.0" + process-nextick-args "~2.0.0" + safe-buffer "~5.1.1" + string_decoder "~1.1.1" + util-deprecate "~1.0.1" + +readable-stream@^3.0.6: + version "3.6.2" + resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-3.6.2.tgz#56a9b36ea965c00c5a93ef31eb111a0f11056967" + integrity sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA== + dependencies: + inherits "^2.0.3" + string_decoder "^1.1.1" + util-deprecate "^1.0.1" + +readdirp@~3.6.0: + version "3.6.0" + resolved "https://registry.yarnpkg.com/readdirp/-/readdirp-3.6.0.tgz#74a370bd857116e245b29cc97340cd431a02a6c7" + integrity sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA== + dependencies: + picomatch "^2.2.1" + +recma-build-jsx@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/recma-build-jsx/-/recma-build-jsx-1.0.0.tgz#c02f29e047e103d2fab2054954e1761b8ea253c4" + integrity sha512-8GtdyqaBcDfva+GUKDr3nev3VpKAhup1+RvkMvUxURHpW7QyIvk9F5wz7Vzo06CEMSilw6uArgRqhpiUcWp8ew== + dependencies: + "@types/estree" "^1.0.0" + estree-util-build-jsx "^3.0.0" + vfile "^6.0.0" + +recma-jsx@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/recma-jsx/-/recma-jsx-1.0.1.tgz#58e718f45e2102ed0bf2fa994f05b70d76801a1a" + integrity sha512-huSIy7VU2Z5OLv6oFLosQGGDqPqdO1iq6bWNAdhzMxSJP7RAso4fCZ1cKu8j9YHCZf3TPrq4dw3okhrylgcd7w== + dependencies: + acorn-jsx "^5.0.0" + estree-util-to-js "^2.0.0" + recma-parse "^1.0.0" + recma-stringify "^1.0.0" + unified "^11.0.0" + +recma-parse@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/recma-parse/-/recma-parse-1.0.0.tgz#c351e161bb0ab47d86b92a98a9d891f9b6814b52" + integrity sha512-OYLsIGBB5Y5wjnSnQW6t3Xg7q3fQ7FWbw/vcXtORTnyaSFscOtABg+7Pnz6YZ6c27fG1/aN8CjfwoUEUIdwqWQ== + dependencies: + "@types/estree" "^1.0.0" + esast-util-from-js "^2.0.0" + unified "^11.0.0" + vfile "^6.0.0" + +recma-stringify@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/recma-stringify/-/recma-stringify-1.0.0.tgz#54632030631e0c7546136ff9ef8fde8e7b44f130" + integrity sha512-cjwII1MdIIVloKvC9ErQ+OgAtwHBmcZ0Bg4ciz78FtbT8In39aAYbaA7zvxQ61xVMSPE8WxhLwLbhif4Js2C+g== + dependencies: + "@types/estree" "^1.0.0" + estree-util-to-js "^2.0.0" + unified "^11.0.0" + vfile "^6.0.0" + +regenerate-unicode-properties@^10.2.2: + version "10.2.2" + resolved "https://registry.yarnpkg.com/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.2.tgz#aa113812ba899b630658c7623466be71e1f86f66" + integrity sha512-m03P+zhBeQd1RGnYxrGyDAPpWX/epKirLrp8e3qevZdVkKtnCrjjWczIbYc8+xd6vcTStVlqfycTx1KR4LOr0g== + dependencies: + regenerate "^1.4.2" + +regenerate@^1.4.2: + version "1.4.2" + resolved "https://registry.yarnpkg.com/regenerate/-/regenerate-1.4.2.tgz#b9346d8827e8f5a32f7ba29637d398b69014848a" + integrity sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A== + +regexpu-core@^6.2.0: + version "6.3.1" + resolved "https://registry.yarnpkg.com/regexpu-core/-/regexpu-core-6.3.1.tgz#fb8b707d0efe18e9464d3ae76ae1e3c96c8467ae" + integrity sha512-DzcswPr252wEr7Qz8AyAVbfyBDKLoYp6eRA1We2Fa9qirRFSdtkP5sHr3yglDKy2BbA0fd2T+j/CUSKes3FeVQ== + dependencies: + regenerate "^1.4.2" + regenerate-unicode-properties "^10.2.2" + regjsgen "^0.8.0" + regjsparser "^0.12.0" + unicode-match-property-ecmascript "^2.0.0" + unicode-match-property-value-ecmascript "^2.2.1" + +registry-auth-token@^5.0.1: + version "5.1.0" + resolved "https://registry.yarnpkg.com/registry-auth-token/-/registry-auth-token-5.1.0.tgz#3c659047ecd4caebd25bc1570a3aa979ae490eca" + integrity sha512-GdekYuwLXLxMuFTwAPg5UKGLW/UXzQrZvH/Zj791BQif5T05T0RsaLfHc9q3ZOKi7n+BoprPD9mJ0O0k4xzUlw== + dependencies: + "@pnpm/npm-conf" "^2.1.0" + +registry-url@^6.0.0: + version "6.0.1" + resolved "https://registry.yarnpkg.com/registry-url/-/registry-url-6.0.1.tgz#056d9343680f2f64400032b1e199faa692286c58" + integrity sha512-+crtS5QjFRqFCoQmvGduwYWEBng99ZvmFvF+cUJkGYF1L1BfU8C6Zp9T7f5vPAwyLkUExpvK+ANVZmGU49qi4Q== + dependencies: + rc "1.2.8" + +regjsgen@^0.8.0: + version "0.8.0" + resolved "https://registry.yarnpkg.com/regjsgen/-/regjsgen-0.8.0.tgz#df23ff26e0c5b300a6470cad160a9d090c3a37ab" + integrity sha512-RvwtGe3d7LvWiDQXeQw8p5asZUmfU1G/l6WbUXeHta7Y2PEIvBTwH6E2EfmYUK8pxcxEdEmaomqyp0vZZ7C+3Q== + +regjsparser@^0.12.0: + version "0.12.0" + resolved "https://registry.yarnpkg.com/regjsparser/-/regjsparser-0.12.0.tgz#0e846df6c6530586429377de56e0475583b088dc" + integrity sha512-cnE+y8bz4NhMjISKbgeVJtqNbtf5QpjZP+Bslo+UqkIt9QPnX9q095eiRRASJG1/tz6dlNr6Z5NsBiWYokp6EQ== + dependencies: + jsesc "~3.0.2" + +rehype-raw@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/rehype-raw/-/rehype-raw-7.0.0.tgz#59d7348fd5dbef3807bbaa1d443efd2dd85ecee4" + integrity sha512-/aE8hCfKlQeA8LmyeyQvQF3eBiLRGNlfBJEvWH7ivp9sBqs7TNqBL5X3v157rM4IFETqDnIOO+z5M/biZbo9Ww== + dependencies: + "@types/hast" "^3.0.0" + hast-util-raw "^9.0.0" + vfile "^6.0.0" + +rehype-recma@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/rehype-recma/-/rehype-recma-1.0.0.tgz#d68ef6344d05916bd96e25400c6261775411aa76" + integrity sha512-lqA4rGUf1JmacCNWWZx0Wv1dHqMwxzsDWYMTowuplHF3xH0N/MmrZ/G3BDZnzAkRmxDadujCjaKM2hqYdCBOGw== + dependencies: + "@types/estree" "^1.0.0" + "@types/hast" "^3.0.0" + hast-util-to-estree "^3.0.0" + +relateurl@^0.2.7: + version "0.2.7" + resolved "https://registry.yarnpkg.com/relateurl/-/relateurl-0.2.7.tgz#54dbf377e51440aca90a4cd274600d3ff2d888a9" + integrity sha512-G08Dxvm4iDN3MLM0EsP62EDV9IuhXPR6blNz6Utcp7zyV3tr4HVNINt6MpaRWbxoOHT3Q7YN2P+jaHX8vUbgog== + +remark-directive@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/remark-directive/-/remark-directive-3.0.1.tgz#689ba332f156cfe1118e849164cc81f157a3ef0a" + integrity sha512-gwglrEQEZcZYgVyG1tQuA+h58EZfq5CSULw7J90AFuCTyib1thgHPoqQ+h9iFvU6R+vnZ5oNFQR5QKgGpk741A== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-directive "^3.0.0" + micromark-extension-directive "^3.0.0" + unified "^11.0.0" + +remark-emoji@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/remark-emoji/-/remark-emoji-4.0.1.tgz#671bfda668047689e26b2078c7356540da299f04" + integrity sha512-fHdvsTR1dHkWKev9eNyhTo4EFwbUvJ8ka9SgeWkMPYFX4WoI7ViVBms3PjlQYgw5TLvNQso3GUB/b/8t3yo+dg== + dependencies: + "@types/mdast" "^4.0.2" + emoticon "^4.0.1" + mdast-util-find-and-replace "^3.0.1" + node-emoji "^2.1.0" + unified "^11.0.4" + +remark-frontmatter@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/remark-frontmatter/-/remark-frontmatter-5.0.0.tgz#b68d61552a421ec412c76f4f66c344627dc187a2" + integrity sha512-XTFYvNASMe5iPN0719nPrdItC9aU0ssC4v14mH1BCi1u0n1gAocqcujWUrByftZTbLhRtiKRyjYTSIOcr69UVQ== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-frontmatter "^2.0.0" + micromark-extension-frontmatter "^2.0.0" + unified "^11.0.0" + +remark-gfm@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/remark-gfm/-/remark-gfm-4.0.1.tgz#33227b2a74397670d357bf05c098eaf8513f0d6b" + integrity sha512-1quofZ2RQ9EWdeN34S79+KExV1764+wCUGop5CPL1WGdD0ocPpu91lzPGbwWMECpEpd42kJGQwzRfyov9j4yNg== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-gfm "^3.0.0" + micromark-extension-gfm "^3.0.0" + remark-parse "^11.0.0" + remark-stringify "^11.0.0" + unified "^11.0.0" + +remark-mdx@^3.0.0: + version "3.1.1" + resolved "https://registry.yarnpkg.com/remark-mdx/-/remark-mdx-3.1.1.tgz#047f97038bc7ec387aebb4b0a4fe23779999d845" + integrity sha512-Pjj2IYlUY3+D8x00UJsIOg5BEvfMyeI+2uLPn9VO9Wg4MEtN/VTIq2NEJQfde9PnX15KgtHyl9S0BcTnWrIuWg== + dependencies: + mdast-util-mdx "^3.0.0" + micromark-extension-mdxjs "^3.0.0" + +remark-parse@^11.0.0: + version "11.0.0" + resolved "https://registry.yarnpkg.com/remark-parse/-/remark-parse-11.0.0.tgz#aa60743fcb37ebf6b069204eb4da304e40db45a1" + integrity sha512-FCxlKLNGknS5ba/1lmpYijMUzX2esxW5xQqjWxw2eHFfS2MSdaHVINFmhjo+qN1WhZhNimq0dZATN9pH0IDrpA== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-from-markdown "^2.0.0" + micromark-util-types "^2.0.0" + unified "^11.0.0" + +remark-rehype@^11.0.0: + version "11.1.2" + resolved "https://registry.yarnpkg.com/remark-rehype/-/remark-rehype-11.1.2.tgz#2addaadda80ca9bd9aa0da763e74d16327683b37" + integrity sha512-Dh7l57ianaEoIpzbp0PC9UKAdCSVklD8E5Rpw7ETfbTl3FqcOOgq5q2LVDhgGCkaBv7p24JXikPdvhhmHvKMsw== + dependencies: + "@types/hast" "^3.0.0" + "@types/mdast" "^4.0.0" + mdast-util-to-hast "^13.0.0" + unified "^11.0.0" + vfile "^6.0.0" + +remark-stringify@^11.0.0: + version "11.0.0" + resolved "https://registry.yarnpkg.com/remark-stringify/-/remark-stringify-11.0.0.tgz#4c5b01dd711c269df1aaae11743eb7e2e7636fd3" + integrity sha512-1OSmLd3awB/t8qdoEOMazZkNsfVTeY4fTsgzcQFdXNq8ToTN4ZGwrMnlda4K6smTFKD+GRV6O48i6Z4iKgPPpw== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-to-markdown "^2.0.0" + unified "^11.0.0" + +renderkid@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/renderkid/-/renderkid-3.0.0.tgz#5fd823e4d6951d37358ecc9a58b1f06836b6268a" + integrity sha512-q/7VIQA8lmM1hF+jn+sFSPWGlMkSAeNYcPLmDQx2zzuiDfaLrOmumR8iaUKlenFgh0XRPIUeSPlH3A+AW3Z5pg== + dependencies: + css-select "^4.1.3" + dom-converter "^0.2.0" + htmlparser2 "^6.1.0" + lodash "^4.17.21" + strip-ansi "^6.0.1" + +repeat-string@^1.0.0: + version "1.6.1" + resolved "https://registry.yarnpkg.com/repeat-string/-/repeat-string-1.6.1.tgz#8dcae470e1c88abc2d600fff4a776286da75e637" + integrity sha512-PV0dzCYDNfRi1jCDbJzpW7jNNDRuCOG/jI5ctQcGKt/clZD+YcPS3yIlWuTJMmESC8aevCFmWJy5wjAFgNqN6w== + +require-from-string@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/require-from-string/-/require-from-string-2.0.2.tgz#89a7fdd938261267318eafe14f9c32e598c36909" + integrity sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw== + +"require-like@>= 0.1.1": + version "0.1.2" + resolved "https://registry.yarnpkg.com/require-like/-/require-like-0.1.2.tgz#ad6f30c13becd797010c468afa775c0c0a6b47fa" + integrity sha512-oyrU88skkMtDdauHDuKVrgR+zuItqr6/c//FXzvmxRGMexSDc6hNvJInGW3LL46n+8b50RykrvwSUIIQH2LQ5A== + +requires-port@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/requires-port/-/requires-port-1.0.0.tgz#925d2601d39ac485e091cf0da5c6e694dc3dcaff" + integrity sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ== + +resolve-alpn@^1.2.0: + version "1.2.1" + resolved "https://registry.yarnpkg.com/resolve-alpn/-/resolve-alpn-1.2.1.tgz#b7adbdac3546aaaec20b45e7d8265927072726f9" + integrity sha512-0a1F4l73/ZFZOakJnQ3FvkJ2+gSTQWz/r2KE5OdDY0TxPm5h4GkqkWWfM47T7HsbnOtcJVEF4epCVy6u7Q3K+g== + +resolve-from@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/resolve-from/-/resolve-from-4.0.0.tgz#4abcd852ad32dd7baabfe9b40e00a36db5f392e6" + integrity sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g== + +resolve-pathname@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/resolve-pathname/-/resolve-pathname-3.0.0.tgz#99d02224d3cf263689becbb393bc560313025dcd" + integrity sha512-C7rARubxI8bXFNB/hqcp/4iUeIXJhJZvFPFPiSPRnhU5UPxzMFIl+2E6yY6c4k9giDJAhtV+enfA+G89N6Csng== + +resolve@^1.19.0, resolve@^1.22.10: + version "1.22.10" + resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.22.10.tgz#b663e83ffb09bbf2386944736baae803029b8b39" + integrity sha512-NPRy+/ncIMeDlTAsuqwKIiferiawhefFJtkNSW0qZJEqMEb+qBt/77B/jGeeek+F0uOeN05CDa6HXbbIgtVX4w== + dependencies: + is-core-module "^2.16.0" + path-parse "^1.0.7" + supports-preserve-symlinks-flag "^1.0.0" + +responselike@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/responselike/-/responselike-3.0.0.tgz#20decb6c298aff0dbee1c355ca95461d42823626" + integrity sha512-40yHxbNcl2+rzXvZuVkrYohathsSJlMTXKryG5y8uciHv1+xDLHQpgjG64JUO9nrEq2jGLH6IZ8BcZyw3wrweg== + dependencies: + lowercase-keys "^3.0.0" + +retry@^0.13.1: + version "0.13.1" + resolved "https://registry.yarnpkg.com/retry/-/retry-0.13.1.tgz#185b1587acf67919d63b357349e03537b2484658" + integrity sha512-XQBQ3I8W1Cge0Seh+6gjj03LbmRFWuoszgK9ooCpwYIrhhoO80pfq4cUkU5DkknwfOfFteRwlZ56PYOGYyFWdg== + +reusify@^1.0.4: + version "1.1.0" + resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.1.0.tgz#0fe13b9522e1473f51b558ee796e08f11f9b489f" + integrity sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw== + +rimraf@^3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-3.0.2.tgz#f1a5402ba6220ad52cc1282bac1ae3aa49fd061a" + integrity sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA== + dependencies: + glob "^7.1.3" + +rtlcss@^4.1.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/rtlcss/-/rtlcss-4.3.0.tgz#f8efd4d5b64f640ec4af8fa25b65bacd9e07cc97" + integrity sha512-FI+pHEn7Wc4NqKXMXFM+VAYKEj/mRIcW4h24YVwVtyjI+EqGrLc2Hx/Ny0lrZ21cBWU2goLy36eqMcNj3AQJig== + dependencies: + escalade "^3.1.1" + picocolors "^1.0.0" + postcss "^8.4.21" + strip-json-comments "^3.1.1" + +run-parallel@^1.1.9: + version "1.2.0" + resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee" + integrity sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA== + dependencies: + queue-microtask "^1.2.2" + +safe-buffer@5.2.1, safe-buffer@>=5.1.0, safe-buffer@^5.1.0, safe-buffer@~5.2.0: + version "5.2.1" + resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.1.tgz#1eaf9fa9bdb1fdd4ec75f58f9cdb4e6b7827eec6" + integrity sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ== + +safe-buffer@~5.1.0, safe-buffer@~5.1.1: + version "5.1.2" + resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.2.tgz#991ec69d296e0313747d59bdfd2b745c35f8828d" + integrity sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g== + +"safer-buffer@>= 2.1.2 < 3": + version "2.1.2" + resolved "https://registry.yarnpkg.com/safer-buffer/-/safer-buffer-2.1.2.tgz#44fa161b0187b9549dd84bb91802f9bd8385cd6a" + integrity sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg== + +sax@^1.2.4: + version "1.4.1" + resolved "https://registry.yarnpkg.com/sax/-/sax-1.4.1.tgz#44cc8988377f126304d3b3fc1010c733b929ef0f" + integrity sha512-+aWOz7yVScEGoKNd4PA10LZ8sk0A/z5+nXQG5giUO5rprX9jgYsTdov9qCchZiPIZezbZH+jRut8nPodFAX4Jg== + +scheduler@^0.26.0: + version "0.26.0" + resolved "https://registry.yarnpkg.com/scheduler/-/scheduler-0.26.0.tgz#4ce8a8c2a2095f13ea11bf9a445be50c555d6337" + integrity sha512-NlHwttCI/l5gCPR3D1nNXtWABUmBwvZpEQiD4IXSbIDq8BzLIK/7Ir5gTFSGZDUu37K5cMNp0hFtzO38sC7gWA== + +schema-dts@^1.1.2: + version "1.1.5" + resolved "https://registry.yarnpkg.com/schema-dts/-/schema-dts-1.1.5.tgz#9237725d305bac3469f02b292a035107595dc324" + integrity sha512-RJr9EaCmsLzBX2NDiO5Z3ux2BVosNZN5jo0gWgsyKvxKIUL5R3swNvoorulAeL9kLB0iTSX7V6aokhla2m7xbg== + +schema-utils@^3.0.0: + version "3.3.0" + resolved "https://registry.yarnpkg.com/schema-utils/-/schema-utils-3.3.0.tgz#f50a88877c3c01652a15b622ae9e9795df7a60fe" + integrity sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg== + dependencies: + "@types/json-schema" "^7.0.8" + ajv "^6.12.5" + ajv-keywords "^3.5.2" + +schema-utils@^4.0.0, schema-utils@^4.0.1, schema-utils@^4.3.0, schema-utils@^4.3.2: + version "4.3.2" + resolved "https://registry.yarnpkg.com/schema-utils/-/schema-utils-4.3.2.tgz#0c10878bf4a73fd2b1dfd14b9462b26788c806ae" + integrity sha512-Gn/JaSk/Mt9gYubxTtSn/QCV4em9mpAPiR1rqy/Ocu19u/G9J5WWdNoUT4SiV6mFC3y6cxyFcFwdzPM3FgxGAQ== + dependencies: + "@types/json-schema" "^7.0.9" + ajv "^8.9.0" + ajv-formats "^2.1.1" + ajv-keywords "^5.1.0" + +section-matter@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/section-matter/-/section-matter-1.0.0.tgz#e9041953506780ec01d59f292a19c7b850b84167" + integrity sha512-vfD3pmTzGpufjScBh50YHKzEu2lxBWhVEHsNGoEXmCmn2hKGfeNLYMzCJpe8cD7gqX7TJluOVpBkAequ6dgMmA== + dependencies: + extend-shallow "^2.0.1" + kind-of "^6.0.0" + +select-hose@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/select-hose/-/select-hose-2.0.0.tgz#625d8658f865af43ec962bfc376a37359a4994ca" + integrity sha512-mEugaLK+YfkijB4fx0e6kImuJdCIt2LxCRcbEYPqRGCs4F2ogyfZU5IAZRdjCP8JPq2AtdNoC/Dux63d9Kiryg== + +select@^1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/select/-/select-1.1.2.tgz#0e7350acdec80b1108528786ec1d4418d11b396d" + integrity sha512-OwpTSOfy6xSs1+pwcNrv0RBMOzI39Lp3qQKUTPVVPRjCdNa5JH/oPRiqsesIskK8TVgmRiHwO4KXlV2Li9dANA== + +selfsigned@^2.1.1: + version "2.4.1" + resolved "https://registry.yarnpkg.com/selfsigned/-/selfsigned-2.4.1.tgz#560d90565442a3ed35b674034cec4e95dceb4ae0" + integrity sha512-th5B4L2U+eGLq1TVh7zNRGBapioSORUeymIydxgFpwww9d2qyKvtuPU2jJuHvYAwwqi2Y596QBL3eEqcPEYL8Q== + dependencies: + "@types/node-forge" "^1.3.0" + node-forge "^1" + +semver-diff@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/semver-diff/-/semver-diff-4.0.0.tgz#3afcf5ed6d62259f5c72d0d5d50dffbdc9680df5" + integrity sha512-0Ju4+6A8iOnpL/Thra7dZsSlOHYAHIeMxfhWQRI1/VLcT3WDBZKKtQt/QkBOsiIN9ZpuvHE6cGZ0x4glCMmfiA== + dependencies: + semver "^7.3.5" + +semver@^6.3.1: + version "6.3.1" + resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.1.tgz#556d2ef8689146e46dcea4bfdd095f3434dffcb4" + integrity sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA== + +semver@^7.3.5, semver@^7.3.7, semver@^7.5.4: + version "7.7.2" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.7.2.tgz#67d99fdcd35cec21e6f8b87a7fd515a33f982b58" + integrity sha512-RF0Fw+rO5AMf9MAyaRXI4AV0Ulj5lMHqVxxdSgiVbixSCXoEmmX/jk0CuJw4+3SqroYO9VoUh+HcuJivvtJemA== + +send@0.19.0: + version "0.19.0" + resolved "https://registry.yarnpkg.com/send/-/send-0.19.0.tgz#bbc5a388c8ea6c048967049dbeac0e4a3f09d7f8" + integrity sha512-dW41u5VfLXu8SJh5bwRmyYUbAoSB3c9uQh6L8h/KtsFREPWpbX1lrljJo186Jc4nmci/sGUZ9a0a0J2zgfq2hw== + dependencies: + debug "2.6.9" + depd "2.0.0" + destroy "1.2.0" + encodeurl "~1.0.2" + escape-html "~1.0.3" + etag "~1.8.1" + fresh "0.5.2" + http-errors "2.0.0" + mime "1.6.0" + ms "2.1.3" + on-finished "2.4.1" + range-parser "~1.2.1" + statuses "2.0.1" + +serialize-javascript@^6.0.0, serialize-javascript@^6.0.1, serialize-javascript@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/serialize-javascript/-/serialize-javascript-6.0.2.tgz#defa1e055c83bf6d59ea805d8da862254eb6a6c2" + integrity sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g== + dependencies: + randombytes "^2.1.0" + +serve-handler@^6.1.6: + version "6.1.6" + resolved "https://registry.yarnpkg.com/serve-handler/-/serve-handler-6.1.6.tgz#50803c1d3e947cd4a341d617f8209b22bd76cfa1" + integrity sha512-x5RL9Y2p5+Sh3D38Fh9i/iQ5ZK+e4xuXRd/pGbM4D13tgo/MGwbttUk8emytcr1YYzBYs+apnUngBDFYfpjPuQ== + dependencies: + bytes "3.0.0" + content-disposition "0.5.2" + mime-types "2.1.18" + minimatch "3.1.2" + path-is-inside "1.0.2" + path-to-regexp "3.3.0" + range-parser "1.2.0" + +serve-index@^1.9.1: + version "1.9.1" + resolved "https://registry.yarnpkg.com/serve-index/-/serve-index-1.9.1.tgz#d3768d69b1e7d82e5ce050fff5b453bea12a9239" + integrity sha512-pXHfKNP4qujrtteMrSBb0rc8HJ9Ms/GrXwcUtUtD5s4ewDJI8bT3Cz2zTVRMKtri49pLx2e0Ya8ziP5Ya2pZZw== + dependencies: + accepts "~1.3.4" + batch "0.6.1" + debug "2.6.9" + escape-html "~1.0.3" + http-errors "~1.6.2" + mime-types "~2.1.17" + parseurl "~1.3.2" + +serve-static@1.16.2: + version "1.16.2" + resolved "https://registry.yarnpkg.com/serve-static/-/serve-static-1.16.2.tgz#b6a5343da47f6bdd2673848bf45754941e803296" + integrity sha512-VqpjJZKadQB/PEbEwvFdO43Ax5dFBZ2UECszz8bQ7pi7wt//PWe1P6MN7eCnjsatYtBT6EuiClbjSWP2WrIoTw== + dependencies: + encodeurl "~2.0.0" + escape-html "~1.0.3" + parseurl "~1.3.3" + send "0.19.0" + +set-function-length@^1.2.2: + version "1.2.2" + resolved "https://registry.yarnpkg.com/set-function-length/-/set-function-length-1.2.2.tgz#aac72314198eaed975cf77b2c3b6b880695e5449" + integrity sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg== + dependencies: + define-data-property "^1.1.4" + es-errors "^1.3.0" + function-bind "^1.1.2" + get-intrinsic "^1.2.4" + gopd "^1.0.1" + has-property-descriptors "^1.0.2" + +setprototypeof@1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/setprototypeof/-/setprototypeof-1.1.0.tgz#d0bd85536887b6fe7c0d818cb962d9d91c54e656" + integrity sha512-BvE/TwpZX4FXExxOxZyRGQQv651MSwmWKZGqvmPcRIjDqWub67kTKuIMx43cZZrS/cBBzwBcNDWoFxt2XEFIpQ== + +setprototypeof@1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/setprototypeof/-/setprototypeof-1.2.0.tgz#66c9a24a73f9fc28cbe66b09fed3d33dcaf1b424" + integrity sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw== + +shallow-clone@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/shallow-clone/-/shallow-clone-3.0.1.tgz#8f2981ad92531f55035b01fb230769a40e02efa3" + integrity sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA== + dependencies: + kind-of "^6.0.2" + +shallowequal@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/shallowequal/-/shallowequal-1.1.0.tgz#188d521de95b9087404fd4dcb68b13df0ae4e7f8" + integrity sha512-y0m1JoUZSlPAjXVtPPW70aZWfIL/dSP7AFkRnniLCrK/8MDKog3TySTBmckD+RObVxH0v4Tox67+F14PdED2oQ== + +shebang-command@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/shebang-command/-/shebang-command-2.0.0.tgz#ccd0af4f8835fbdc265b82461aaf0c36663f34ea" + integrity sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA== + dependencies: + shebang-regex "^3.0.0" + +shebang-regex@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172" + integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A== + +shell-quote@^1.8.3: + version "1.8.3" + resolved "https://registry.yarnpkg.com/shell-quote/-/shell-quote-1.8.3.tgz#55e40ef33cf5c689902353a3d8cd1a6725f08b4b" + integrity sha512-ObmnIF4hXNg1BqhnHmgbDETF8dLPCggZWBjkQfhZpbszZnYur5DUljTcCHii5LC3J5E0yeO/1LIMyH+UvHQgyw== + +side-channel-list@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/side-channel-list/-/side-channel-list-1.0.0.tgz#10cb5984263115d3b7a0e336591e290a830af8ad" + integrity sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA== + dependencies: + es-errors "^1.3.0" + object-inspect "^1.13.3" + +side-channel-map@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/side-channel-map/-/side-channel-map-1.0.1.tgz#d6bb6b37902c6fef5174e5f533fab4c732a26f42" + integrity sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA== + dependencies: + call-bound "^1.0.2" + es-errors "^1.3.0" + get-intrinsic "^1.2.5" + object-inspect "^1.13.3" + +side-channel-weakmap@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz#11dda19d5368e40ce9ec2bdc1fb0ecbc0790ecea" + integrity sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A== + dependencies: + call-bound "^1.0.2" + es-errors "^1.3.0" + get-intrinsic "^1.2.5" + object-inspect "^1.13.3" + side-channel-map "^1.0.1" + +side-channel@^1.0.6: + version "1.1.0" + resolved "https://registry.yarnpkg.com/side-channel/-/side-channel-1.1.0.tgz#c3fcff9c4da932784873335ec9765fa94ff66bc9" + integrity sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw== + dependencies: + es-errors "^1.3.0" + object-inspect "^1.13.3" + side-channel-list "^1.0.0" + side-channel-map "^1.0.1" + side-channel-weakmap "^1.0.2" + +signal-exit@^3.0.2, signal-exit@^3.0.3: + version "3.0.7" + resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.7.tgz#a9a1767f8af84155114eaabd73f99273c8f59ad9" + integrity sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ== + +sirv@^2.0.3: + version "2.0.4" + resolved "https://registry.yarnpkg.com/sirv/-/sirv-2.0.4.tgz#5dd9a725c578e34e449f332703eb2a74e46a29b0" + integrity sha512-94Bdh3cC2PKrbgSOUqTiGPWVZeSiXfKOVZNJniWoqrWrRkB1CJzBU3NEbiTsPcYy1lDsANA/THzS+9WBiy5nfQ== + dependencies: + "@polka/url" "^1.0.0-next.24" + mrmime "^2.0.0" + totalist "^3.0.0" + +sisteransi@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/sisteransi/-/sisteransi-1.0.5.tgz#134d681297756437cc05ca01370d3a7a571075ed" + integrity sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg== + +sitemap@^7.1.1: + version "7.1.2" + resolved "https://registry.yarnpkg.com/sitemap/-/sitemap-7.1.2.tgz#6ce1deb43f6f177c68bc59cf93632f54e3ae6b72" + integrity sha512-ARCqzHJ0p4gWt+j7NlU5eDlIO9+Rkr/JhPFZKKQ1l5GCus7rJH4UdrlVAh0xC/gDS/Qir2UMxqYNHtsKr2rpCw== + dependencies: + "@types/node" "^17.0.5" + "@types/sax" "^1.2.1" + arg "^5.0.0" + sax "^1.2.4" + +skin-tone@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/skin-tone/-/skin-tone-2.0.0.tgz#4e3933ab45c0d4f4f781745d64b9f4c208e41237" + integrity sha512-kUMbT1oBJCpgrnKoSr0o6wPtvRWT9W9UKvGLwfJYO2WuahZRHOpEyL1ckyMGgMWh0UdpmaoFqKKD29WTomNEGA== + dependencies: + unicode-emoji-modifier-base "^1.0.0" + +slash@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/slash/-/slash-3.0.0.tgz#6539be870c165adbd5240220dbe361f1bc4d4634" + integrity sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q== + +slash@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/slash/-/slash-4.0.0.tgz#2422372176c4c6c5addb5e2ada885af984b396a7" + integrity sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew== + +snake-case@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/snake-case/-/snake-case-3.0.4.tgz#4f2bbd568e9935abdfd593f34c691dadb49c452c" + integrity sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg== + dependencies: + dot-case "^3.0.4" + tslib "^2.0.3" + +sockjs@^0.3.24: + version "0.3.24" + resolved "https://registry.yarnpkg.com/sockjs/-/sockjs-0.3.24.tgz#c9bc8995f33a111bea0395ec30aa3206bdb5ccce" + integrity sha512-GJgLTZ7vYb/JtPSSZ10hsOYIvEYsjbNU+zPdIHcUaWVNUEPivzxku31865sSSud0Da0W4lEeOPlmw93zLQchuQ== + dependencies: + faye-websocket "^0.11.3" + uuid "^8.3.2" + websocket-driver "^0.7.4" + +sort-css-media-queries@2.2.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/sort-css-media-queries/-/sort-css-media-queries-2.2.0.tgz#aa33cf4a08e0225059448b6c40eddbf9f1c8334c" + integrity sha512-0xtkGhWCC9MGt/EzgnvbbbKhqWjl1+/rncmhTh5qCpbYguXh6S/qwePfv/JQ8jePXXmqingylxoC49pCkSPIbA== + +source-map-js@^1.0.1, source-map-js@^1.2.1: + version "1.2.1" + resolved "https://registry.yarnpkg.com/source-map-js/-/source-map-js-1.2.1.tgz#1ce5650fddd87abc099eda37dcff024c2667ae46" + integrity sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA== + +source-map-support@~0.5.20: + version "0.5.21" + resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.5.21.tgz#04fe7c7f9e1ed2d662233c28cb2b35b9f63f6e4f" + integrity sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w== + dependencies: + buffer-from "^1.0.0" + source-map "^0.6.0" + +source-map@^0.5.7: + version "0.5.7" + resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.5.7.tgz#8a039d2d1021d22d1ea14c80d8ea468ba2ef3fcc" + integrity sha512-LbrmJOMUSdEVxIKvdcJzQC+nQhe8FUZQTXQy6+I75skNgn3OoQ0DZA8YnFa7gp8tqtL3KPf1kmo0R5DoApeSGQ== + +source-map@^0.6.0, source-map@~0.6.0: + version "0.6.1" + resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.6.1.tgz#74722af32e9614e9c287a8d0bbde48b5e2f1a263" + integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g== + +source-map@^0.7.0: + version "0.7.6" + resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.7.6.tgz#a3658ab87e5b6429c8a1f3ba0083d4c61ca3ef02" + integrity sha512-i5uvt8C3ikiWeNZSVZNWcfZPItFQOsYTUAOkcUPGd8DqDy1uOUikjt5dG+uRlwyvR108Fb9DOd4GvXfT0N2/uQ== + +space-separated-tokens@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/space-separated-tokens/-/space-separated-tokens-2.0.2.tgz#1ecd9d2350a3844572c3f4a312bceb018348859f" + integrity sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q== + +spdy-transport@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/spdy-transport/-/spdy-transport-3.0.0.tgz#00d4863a6400ad75df93361a1608605e5dcdcf31" + integrity sha512-hsLVFE5SjA6TCisWeJXFKniGGOpBgMLmerfO2aCyCU5s7nJ/rpAepqmFifv/GCbSbueEeAJJnmSQ2rKC/g8Fcw== + dependencies: + debug "^4.1.0" + detect-node "^2.0.4" + hpack.js "^2.1.6" + obuf "^1.1.2" + readable-stream "^3.0.6" + wbuf "^1.7.3" + +spdy@^4.0.2: + version "4.0.2" + resolved "https://registry.yarnpkg.com/spdy/-/spdy-4.0.2.tgz#b74f466203a3eda452c02492b91fb9e84a27677b" + integrity sha512-r46gZQZQV+Kl9oItvl1JZZqJKGr+oEkB08A6BzkiR7593/7IbtuncXHd2YoYeTsG4157ZssMu9KYvUHLcjcDoA== + dependencies: + debug "^4.1.0" + handle-thing "^2.0.0" + http-deceiver "^1.2.7" + select-hose "^2.0.0" + spdy-transport "^3.0.0" + +sprintf-js@~1.0.2: + version "1.0.3" + resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c" + integrity sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g== + +srcset@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/srcset/-/srcset-4.0.0.tgz#336816b665b14cd013ba545b6fe62357f86e65f4" + integrity sha512-wvLeHgcVHKO8Sc/H/5lkGreJQVeYMm9rlmt8PuR1xE31rIuXhuzznUUqAt8MqLhB3MqJdFzlNAfpcWnxiFUcPw== + +statuses@2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/statuses/-/statuses-2.0.1.tgz#55cb000ccf1d48728bd23c685a063998cf1a1b63" + integrity sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ== + +"statuses@>= 1.4.0 < 2": + version "1.5.0" + resolved "https://registry.yarnpkg.com/statuses/-/statuses-1.5.0.tgz#161c7dac177659fd9811f43771fa99381478628c" + integrity sha512-OpZ3zP+jT1PI7I8nemJX4AKmAX070ZkYPVWV/AaKTJl+tXCTGyVdC1a4SL8RUQYEwk/f34ZX8UTykN68FwrqAA== + +std-env@^3.7.0: + version "3.9.0" + resolved "https://registry.yarnpkg.com/std-env/-/std-env-3.9.0.tgz#1a6f7243b339dca4c9fd55e1c7504c77ef23e8f1" + integrity sha512-UGvjygr6F6tpH7o2qyqR6QYpwraIjKSdtzyBdyytFOHmPZY917kwdwLG0RbOjWOnKmnm3PeHjaoLLMie7kPLQw== + +string-width@^4.1.0, string-width@^4.2.0: + version "4.2.3" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" + integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== + dependencies: + emoji-regex "^8.0.0" + is-fullwidth-code-point "^3.0.0" + strip-ansi "^6.0.1" + +string-width@^5.0.1, string-width@^5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-5.1.2.tgz#14f8daec6d81e7221d2a357e668cab73bdbca794" + integrity sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA== + dependencies: + eastasianwidth "^0.2.0" + emoji-regex "^9.2.2" + strip-ansi "^7.0.1" + +string_decoder@^1.1.1: + version "1.3.0" + resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.3.0.tgz#42f114594a46cf1a8e30b0a84f56c78c3edac21e" + integrity sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA== + dependencies: + safe-buffer "~5.2.0" + +string_decoder@~1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.1.1.tgz#9cf1611ba62685d7030ae9e4ba34149c3af03fc8" + integrity sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg== + dependencies: + safe-buffer "~5.1.0" + +stringify-entities@^4.0.0: + version "4.0.4" + resolved "https://registry.yarnpkg.com/stringify-entities/-/stringify-entities-4.0.4.tgz#b3b79ef5f277cc4ac73caeb0236c5ba939b3a4f3" + integrity sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg== + dependencies: + character-entities-html4 "^2.0.0" + character-entities-legacy "^3.0.0" + +stringify-object@^3.3.0: + version "3.3.0" + resolved "https://registry.yarnpkg.com/stringify-object/-/stringify-object-3.3.0.tgz#703065aefca19300d3ce88af4f5b3956d7556629" + integrity sha512-rHqiFh1elqCQ9WPLIC8I0Q/g/wj5J1eMkyoiD6eoQApWHP0FtlK7rqnhmabL5VUY9JQCcqwwvlOaSuutekgyrw== + dependencies: + get-own-enumerable-property-symbols "^3.0.0" + is-obj "^1.0.1" + is-regexp "^1.0.0" + +strip-ansi@^6.0.0, strip-ansi@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" + integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== + dependencies: + ansi-regex "^5.0.1" + +strip-ansi@^7.0.1: + version "7.1.2" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-7.1.2.tgz#132875abde678c7ea8d691533f2e7e22bb744dba" + integrity sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA== + dependencies: + ansi-regex "^6.0.1" + +strip-bom-string@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/strip-bom-string/-/strip-bom-string-1.0.0.tgz#e5211e9224369fbb81d633a2f00044dc8cedad92" + integrity sha512-uCC2VHvQRYu+lMh4My/sFNmF2klFymLX1wHJeXnbEJERpV/ZsVuonzerjfrGpIGF7LBVa1O7i9kjiWvJiFck8g== + +strip-final-newline@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/strip-final-newline/-/strip-final-newline-2.0.0.tgz#89b852fb2fcbe936f6f4b3187afb0a12c1ab58ad" + integrity sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA== + +strip-json-comments@^3.1.1: + version "3.1.1" + resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-3.1.1.tgz#31f1281b3832630434831c310c01cccda8cbe006" + integrity sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig== + +strip-json-comments@~2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-2.0.1.tgz#3c531942e908c2697c0ec344858c286c7ca0a60a" + integrity sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ== + +style-to-js@^1.0.0: + version "1.1.17" + resolved "https://registry.yarnpkg.com/style-to-js/-/style-to-js-1.1.17.tgz#488b1558a8c1fd05352943f088cc3ce376813d83" + integrity sha512-xQcBGDxJb6jjFCTzvQtfiPn6YvvP2O8U1MDIPNfJQlWMYfktPy+iGsHE7cssjs7y84d9fQaK4UF3RIJaAHSoYA== + dependencies: + style-to-object "1.0.9" + +style-to-object@1.0.9: + version "1.0.9" + resolved "https://registry.yarnpkg.com/style-to-object/-/style-to-object-1.0.9.tgz#35c65b713f4a6dba22d3d0c61435f965423653f0" + integrity sha512-G4qppLgKu/k6FwRpHiGiKPaPTFcG3g4wNVX/Qsfu+RqQM30E7Tyu/TEgxcL9PNLF5pdRLwQdE3YKKf+KF2Dzlw== + dependencies: + inline-style-parser "0.2.4" + +stylehacks@^6.1.1: + version "6.1.1" + resolved "https://registry.yarnpkg.com/stylehacks/-/stylehacks-6.1.1.tgz#543f91c10d17d00a440430362d419f79c25545a6" + integrity sha512-gSTTEQ670cJNoaeIp9KX6lZmm8LJ3jPB5yJmX8Zq/wQxOsAFXV3qjWzHas3YYk1qesuVIyYWWUpZ0vSE/dTSGg== + dependencies: + browserslist "^4.23.0" + postcss-selector-parser "^6.0.16" + +stylis@4.2.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/stylis/-/stylis-4.2.0.tgz#79daee0208964c8fe695a42fcffcac633a211a51" + integrity sha512-Orov6g6BB1sDfYgzWfTHDOxamtX1bE/zo104Dh9e6fqJ3PooipYyfJ0pUmrZO2wAvO8YbEyeFrkV91XTsGMSrw== + +supports-color@^7.1.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-7.2.0.tgz#1b7dcdcb32b8138801b3e478ba6a51caa89648da" + integrity sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw== + dependencies: + has-flag "^4.0.0" + +supports-color@^8.0.0: + version "8.1.1" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-8.1.1.tgz#cd6fc17e28500cff56c1b86c0a7fd4a54a73005c" + integrity sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q== + dependencies: + has-flag "^4.0.0" + +supports-preserve-symlinks-flag@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz#6eda4bd344a3c94aea376d4cc31bc77311039e09" + integrity sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w== + +svg-parser@^2.0.4: + version "2.0.4" + resolved "https://registry.yarnpkg.com/svg-parser/-/svg-parser-2.0.4.tgz#fdc2e29e13951736140b76cb122c8ee6630eb6b5" + integrity sha512-e4hG1hRwoOdRb37cIMSgzNsxyzKfayW6VOflrwvR+/bzrkyxY/31WkbgnQpgtrNp1SdpJvpUAGTa/ZoiPNDuRQ== + +svgo@^3.0.2, svgo@^3.2.0: + version "3.3.2" + resolved "https://registry.yarnpkg.com/svgo/-/svgo-3.3.2.tgz#ad58002652dffbb5986fc9716afe52d869ecbda8" + integrity sha512-OoohrmuUlBs8B8o6MB2Aevn+pRIH9zDALSR+6hhqVfa6fRwG/Qw9VUMSMW9VNg2CFc/MTIfabtdOVl9ODIJjpw== + dependencies: + "@trysound/sax" "0.2.0" + commander "^7.2.0" + css-select "^5.1.0" + css-tree "^2.3.1" + css-what "^6.1.0" + csso "^5.0.5" + picocolors "^1.0.0" + +tapable@^2.0.0, tapable@^2.1.1, tapable@^2.2.0, tapable@^2.2.1: + version "2.2.3" + resolved "https://registry.yarnpkg.com/tapable/-/tapable-2.2.3.tgz#4b67b635b2d97578a06a2713d2f04800c237e99b" + integrity sha512-ZL6DDuAlRlLGghwcfmSn9sK3Hr6ArtyudlSAiCqQ6IfE+b+HHbydbYDIG15IfS5do+7XQQBdBiubF/cV2dnDzg== + +terser-webpack-plugin@^5.3.11, terser-webpack-plugin@^5.3.9: + version "5.3.14" + resolved "https://registry.yarnpkg.com/terser-webpack-plugin/-/terser-webpack-plugin-5.3.14.tgz#9031d48e57ab27567f02ace85c7d690db66c3e06" + integrity sha512-vkZjpUjb6OMS7dhV+tILUW6BhpDR7P2L/aQSAv+Uwk+m8KATX9EccViHTJR2qDtACKPIYndLGCyl3FMo+r2LMw== + dependencies: + "@jridgewell/trace-mapping" "^0.3.25" + jest-worker "^27.4.5" + schema-utils "^4.3.0" + serialize-javascript "^6.0.2" + terser "^5.31.1" + +terser@^5.10.0, terser@^5.15.1, terser@^5.31.1: + version "5.44.0" + resolved "https://registry.yarnpkg.com/terser/-/terser-5.44.0.tgz#ebefb8e5b8579d93111bfdfc39d2cf63879f4a82" + integrity sha512-nIVck8DK+GM/0Frwd+nIhZ84pR/BX7rmXMfYwyg+Sri5oGVE99/E3KvXqpC2xHFxyqXyGHTKBSioxxplrO4I4w== + dependencies: + "@jridgewell/source-map" "^0.3.3" + acorn "^8.15.0" + commander "^2.20.0" + source-map-support "~0.5.20" + +thunky@^1.0.2: + version "1.1.0" + resolved "https://registry.yarnpkg.com/thunky/-/thunky-1.1.0.tgz#5abaf714a9405db0504732bbccd2cedd9ef9537d" + integrity sha512-eHY7nBftgThBqOyHGVN+l8gF0BucP09fMo0oO/Lb0w1OF80dJv+lDVpXG60WMQvkcxAkNybKsrEIE3ZtKGmPrA== + +tiny-emitter@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/tiny-emitter/-/tiny-emitter-2.1.0.tgz#1d1a56edfc51c43e863cbb5382a72330e3555423" + integrity sha512-NB6Dk1A9xgQPMoGqC5CVXn123gWyte215ONT5Pp5a0yt4nlEoO1ZWeCwpncaekPHXO60i47ihFnZPiRPjRMq4Q== + +tiny-invariant@^1.0.2: + version "1.3.3" + resolved "https://registry.yarnpkg.com/tiny-invariant/-/tiny-invariant-1.3.3.tgz#46680b7a873a0d5d10005995eb90a70d74d60127" + integrity sha512-+FbBPE1o9QAYvviau/qC5SE3caw21q3xkvWKBtja5vgqOWIHHJ3ioaq1VPfn/Szqctz2bU/oYeKd9/z5BL+PVg== + +tiny-warning@^1.0.0: + version "1.0.3" + resolved "https://registry.yarnpkg.com/tiny-warning/-/tiny-warning-1.0.3.tgz#94a30db453df4c643d0fd566060d60a875d84754" + integrity sha512-lBN9zLN/oAf68o3zNXYrdCt1kP8WsiGW8Oo2ka41b2IM5JL/S1CTyX1rW0mb/zSuJun0ZUrDxx4sqvYS2FWzPA== + +tinypool@^1.0.2: + version "1.1.1" + resolved "https://registry.yarnpkg.com/tinypool/-/tinypool-1.1.1.tgz#059f2d042bd37567fbc017d3d426bdd2a2612591" + integrity sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg== + +to-regex-range@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/to-regex-range/-/to-regex-range-5.0.1.tgz#1648c44aae7c8d988a326018ed72f5b4dd0392e4" + integrity sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ== + dependencies: + is-number "^7.0.0" + +toidentifier@1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/toidentifier/-/toidentifier-1.0.1.tgz#3be34321a88a820ed1bd80dfaa33e479fbb8dd35" + integrity sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA== + +totalist@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/totalist/-/totalist-3.0.1.tgz#ba3a3d600c915b1a97872348f79c127475f6acf8" + integrity sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ== + +trim-lines@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/trim-lines/-/trim-lines-3.0.1.tgz#d802e332a07df861c48802c04321017b1bd87338" + integrity sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg== + +trough@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/trough/-/trough-2.2.0.tgz#94a60bd6bd375c152c1df911a4b11d5b0256f50f" + integrity sha512-tmMpK00BjZiUyVyvrBK7knerNgmgvcV/KLVyuma/SC+TQN167GrMRciANTz09+k3zW8L8t60jWO1GpfkZdjTaw== + +tslib@^2.0.3, tslib@^2.6.0: + version "2.8.1" + resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.8.1.tgz#612efe4ed235d567e8aba5f2a5fab70280ade83f" + integrity sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w== + +type-fest@^0.21.3: + version "0.21.3" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.21.3.tgz#d260a24b0198436e133fa26a524a6d65fa3b2e37" + integrity sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w== + +type-fest@^1.0.1: + version "1.4.0" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-1.4.0.tgz#e9fb813fe3bf1744ec359d55d1affefa76f14be1" + integrity sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA== + +type-fest@^2.13.0, type-fest@^2.5.0: + version "2.19.0" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-2.19.0.tgz#88068015bb33036a598b952e55e9311a60fd3a9b" + integrity sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA== + +type-is@~1.6.18: + version "1.6.18" + resolved "https://registry.yarnpkg.com/type-is/-/type-is-1.6.18.tgz#4e552cd05df09467dcbc4ef739de89f2cf37c131" + integrity sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g== + dependencies: + media-typer "0.3.0" + mime-types "~2.1.24" + +typedarray-to-buffer@^3.1.5: + version "3.1.5" + resolved "https://registry.yarnpkg.com/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz#a97ee7a9ff42691b9f783ff1bc5112fe3fca9080" + integrity sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q== + dependencies: + is-typedarray "^1.0.0" + +undici-types@~7.12.0: + version "7.12.0" + resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-7.12.0.tgz#15c5c7475c2a3ba30659529f5cdb4674b622fafb" + integrity sha512-goOacqME2GYyOZZfb5Lgtu+1IDmAlAEu5xnD3+xTzS10hT0vzpf0SPjkXwAw9Jm+4n/mQGDP3LO8CPbYROeBfQ== + +unicode-canonical-property-names-ecmascript@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.1.tgz#cb3173fe47ca743e228216e4a3ddc4c84d628cc2" + integrity sha512-dA8WbNeb2a6oQzAQ55YlT5vQAWGV9WXOsi3SskE3bcCdM0P4SDd+24zS/OCacdRq5BkdsRj9q3Pg6YyQoxIGqg== + +unicode-emoji-modifier-base@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/unicode-emoji-modifier-base/-/unicode-emoji-modifier-base-1.0.0.tgz#dbbd5b54ba30f287e2a8d5a249da6c0cef369459" + integrity sha512-yLSH4py7oFH3oG/9K+XWrz1pSi3dfUrWEnInbxMfArOfc1+33BlGPQtLsOYwvdMy11AwUBetYuaRxSPqgkq+8g== + +unicode-match-property-ecmascript@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/unicode-match-property-ecmascript/-/unicode-match-property-ecmascript-2.0.0.tgz#54fd16e0ecb167cf04cf1f756bdcc92eba7976c3" + integrity sha512-5kaZCrbp5mmbz5ulBkDkbY0SsPOjKqVS35VpL9ulMPfSl0J0Xsm+9Evphv9CoIZFwre7aJoa94AY6seMKGVN5Q== + dependencies: + unicode-canonical-property-names-ecmascript "^2.0.0" + unicode-property-aliases-ecmascript "^2.0.0" + +unicode-match-property-value-ecmascript@^2.2.1: + version "2.2.1" + resolved "https://registry.yarnpkg.com/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.2.1.tgz#65a7adfad8574c219890e219285ce4c64ed67eaa" + integrity sha512-JQ84qTuMg4nVkx8ga4A16a1epI9H6uTXAknqxkGF/aFfRLw1xC/Bp24HNLaZhHSkWd3+84t8iXnp1J0kYcZHhg== + +unicode-property-aliases-ecmascript@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/unicode-property-aliases-ecmascript/-/unicode-property-aliases-ecmascript-2.2.0.tgz#301d4f8a43d2b75c97adfad87c9dd5350c9475d1" + integrity sha512-hpbDzxUY9BFwX+UeBnxv3Sh1q7HFxj48DTmXchNgRa46lO8uj3/1iEn3MiNUYTg1g9ctIqXCCERn8gYZhHC5lQ== + +unified@^11.0.0, unified@^11.0.3, unified@^11.0.4: + version "11.0.5" + resolved "https://registry.yarnpkg.com/unified/-/unified-11.0.5.tgz#f66677610a5c0a9ee90cab2b8d4d66037026d9e1" + integrity sha512-xKvGhPWw3k84Qjh8bI3ZeJjqnyadK+GEFtazSfZv/rKeTkTjOJho6mFqh2SM96iIcZokxiOpg78GazTSg8+KHA== + dependencies: + "@types/unist" "^3.0.0" + bail "^2.0.0" + devlop "^1.0.0" + extend "^3.0.0" + is-plain-obj "^4.0.0" + trough "^2.0.0" + vfile "^6.0.0" + +unique-string@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/unique-string/-/unique-string-3.0.0.tgz#84a1c377aff5fd7a8bc6b55d8244b2bd90d75b9a" + integrity sha512-VGXBUVwxKMBUznyffQweQABPRRW1vHZAbadFZud4pLFAqRGvv/96vafgjWFqzourzr8YonlQiPgH0YCJfawoGQ== + dependencies: + crypto-random-string "^4.0.0" + +unist-util-is@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/unist-util-is/-/unist-util-is-6.0.0.tgz#b775956486aff107a9ded971d996c173374be424" + integrity sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw== + dependencies: + "@types/unist" "^3.0.0" + +unist-util-position-from-estree@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/unist-util-position-from-estree/-/unist-util-position-from-estree-2.0.0.tgz#d94da4df596529d1faa3de506202f0c9a23f2200" + integrity sha512-KaFVRjoqLyF6YXCbVLNad/eS4+OfPQQn2yOd7zF/h5T/CSL2v8NpN6a5TPvtbXthAGw5nG+PuTtq+DdIZr+cRQ== + dependencies: + "@types/unist" "^3.0.0" + +unist-util-position@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/unist-util-position/-/unist-util-position-5.0.0.tgz#678f20ab5ca1207a97d7ea8a388373c9cf896be4" + integrity sha512-fucsC7HjXvkB5R3kTCO7kUjRdrS0BJt3M/FPxmHMBOm8JQi2BsHAHFsy27E0EolP8rp0NzXsJ+jNPyDWvOJZPA== + dependencies: + "@types/unist" "^3.0.0" + +unist-util-stringify-position@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/unist-util-stringify-position/-/unist-util-stringify-position-4.0.0.tgz#449c6e21a880e0855bf5aabadeb3a740314abac2" + integrity sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ== + dependencies: + "@types/unist" "^3.0.0" + +unist-util-visit-parents@^6.0.0: + version "6.0.1" + resolved "https://registry.yarnpkg.com/unist-util-visit-parents/-/unist-util-visit-parents-6.0.1.tgz#4d5f85755c3b8f0dc69e21eca5d6d82d22162815" + integrity sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw== + dependencies: + "@types/unist" "^3.0.0" + unist-util-is "^6.0.0" + +unist-util-visit@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/unist-util-visit/-/unist-util-visit-5.0.0.tgz#a7de1f31f72ffd3519ea71814cccf5fd6a9217d6" + integrity sha512-MR04uvD+07cwl/yhVuVWAtw+3GOR/knlL55Nd/wAdblk27GCVt3lqpTivy/tkJcZoNPzTwS1Y+KMojlLDhoTzg== + dependencies: + "@types/unist" "^3.0.0" + unist-util-is "^6.0.0" + unist-util-visit-parents "^6.0.0" + +universalify@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/universalify/-/universalify-2.0.1.tgz#168efc2180964e6386d061e094df61afe239b18d" + integrity sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw== + +unpipe@1.0.0, unpipe@~1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/unpipe/-/unpipe-1.0.0.tgz#b2bf4ee8514aae6165b4817829d21b2ef49904ec" + integrity sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ== + +update-browserslist-db@^1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/update-browserslist-db/-/update-browserslist-db-1.1.3.tgz#348377dd245216f9e7060ff50b15a1b740b75420" + integrity sha512-UxhIZQ+QInVdunkDAaiazvvT/+fXL5Osr0JZlJulepYu6Jd7qJtDZjlur0emRlT71EN3ScPoE7gvsuIKKNavKw== + dependencies: + escalade "^3.2.0" + picocolors "^1.1.1" + +update-notifier@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/update-notifier/-/update-notifier-6.0.2.tgz#a6990253dfe6d5a02bd04fbb6a61543f55026b60" + integrity sha512-EDxhTEVPZZRLWYcJ4ZXjGFN0oP7qYvbXWzEgRm/Yql4dHX5wDbvh89YHP6PK1lzZJYrMtXUuZZz8XGK+U6U1og== + dependencies: + boxen "^7.0.0" + chalk "^5.0.1" + configstore "^6.0.0" + has-yarn "^3.0.0" + import-lazy "^4.0.0" + is-ci "^3.0.1" + is-installed-globally "^0.4.0" + is-npm "^6.0.0" + is-yarn-global "^0.4.0" + latest-version "^7.0.0" + pupa "^3.1.0" + semver "^7.3.7" + semver-diff "^4.0.0" + xdg-basedir "^5.1.0" + +uri-js@^4.2.2: + version "4.4.1" + resolved "https://registry.yarnpkg.com/uri-js/-/uri-js-4.4.1.tgz#9b1a52595225859e55f669d928f88c6c57f2a77e" + integrity sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg== + dependencies: + punycode "^2.1.0" + +url-loader@^4.1.1: + version "4.1.1" + resolved "https://registry.yarnpkg.com/url-loader/-/url-loader-4.1.1.tgz#28505e905cae158cf07c92ca622d7f237e70a4e2" + integrity sha512-3BTV812+AVHHOJQO8O5MkWgZ5aosP7GnROJwvzLS9hWDj00lZ6Z0wNak423Lp9PBZN05N+Jk/N5Si8jRAlGyWA== + dependencies: + loader-utils "^2.0.0" + mime-types "^2.1.27" + schema-utils "^3.0.0" + +util-deprecate@^1.0.1, util-deprecate@^1.0.2, util-deprecate@~1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf" + integrity sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw== + +utila@~0.4: + version "0.4.0" + resolved "https://registry.yarnpkg.com/utila/-/utila-0.4.0.tgz#8a16a05d445657a3aea5eecc5b12a4fa5379772c" + integrity sha512-Z0DbgELS9/L/75wZbro8xAnT50pBVFQZ+hUEueGDU5FN51YSCYM+jdxsfCiHjwNP/4LCDD0i/graKpeBnOXKRA== + +utility-types@^3.10.0: + version "3.11.0" + resolved "https://registry.yarnpkg.com/utility-types/-/utility-types-3.11.0.tgz#607c40edb4f258915e901ea7995607fdf319424c" + integrity sha512-6Z7Ma2aVEWisaL6TvBCy7P8rm2LQoPv6dJ7ecIaIixHcwfbJ0x7mWdbcwlIM5IGQxPZSFYeqRCqlOOeKoJYMkw== + +utils-merge@1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/utils-merge/-/utils-merge-1.0.1.tgz#9f95710f50a267947b2ccc124741c1028427e713" + integrity sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA== + +uuid@^8.3.2: + version "8.3.2" + resolved "https://registry.yarnpkg.com/uuid/-/uuid-8.3.2.tgz#80d5b5ced271bb9af6c445f21a1a04c606cefbe2" + integrity sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg== + +value-equal@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/value-equal/-/value-equal-1.0.1.tgz#1e0b794c734c5c0cade179c437d356d931a34d6c" + integrity sha512-NOJ6JZCAWr0zlxZt+xqCHNTEKOsrks2HQd4MqhP1qy4z1SkbEP467eNx6TgDKXMvUOb+OENfJCZwM+16n7fRfw== + +vary@~1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/vary/-/vary-1.1.2.tgz#2299f02c6ded30d4a5961b0b9f74524a18f634fc" + integrity sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg== + +vfile-location@^5.0.0: + version "5.0.3" + resolved "https://registry.yarnpkg.com/vfile-location/-/vfile-location-5.0.3.tgz#cb9eacd20f2b6426d19451e0eafa3d0a846225c3" + integrity sha512-5yXvWDEgqeiYiBe1lbxYF7UMAIm/IcopxMHrMQDq3nvKcjPKIhZklUKL+AE7J7uApI4kwe2snsK+eI6UTj9EHg== + dependencies: + "@types/unist" "^3.0.0" + vfile "^6.0.0" + +vfile-message@^4.0.0: + version "4.0.3" + resolved "https://registry.yarnpkg.com/vfile-message/-/vfile-message-4.0.3.tgz#87b44dddd7b70f0641c2e3ed0864ba73e2ea8df4" + integrity sha512-QTHzsGd1EhbZs4AsQ20JX1rC3cOlt/IWJruk893DfLRr57lcnOeMaWG4K0JrRta4mIJZKth2Au3mM3u03/JWKw== + dependencies: + "@types/unist" "^3.0.0" + unist-util-stringify-position "^4.0.0" + +vfile@^6.0.0, vfile@^6.0.1: + version "6.0.3" + resolved "https://registry.yarnpkg.com/vfile/-/vfile-6.0.3.tgz#3652ab1c496531852bf55a6bac57af981ebc38ab" + integrity sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q== + dependencies: + "@types/unist" "^3.0.0" + vfile-message "^4.0.0" + +watchpack@^2.4.1: + version "2.4.4" + resolved "https://registry.yarnpkg.com/watchpack/-/watchpack-2.4.4.tgz#473bda72f0850453da6425081ea46fc0d7602947" + integrity sha512-c5EGNOiyxxV5qmTtAB7rbiXxi1ooX1pQKMLX/MIabJjRA0SJBQOjKF+KSVfHkr9U1cADPon0mRiVe/riyaiDUA== + dependencies: + glob-to-regexp "^0.4.1" + graceful-fs "^4.1.2" + +wbuf@^1.1.0, wbuf@^1.7.3: + version "1.7.3" + resolved "https://registry.yarnpkg.com/wbuf/-/wbuf-1.7.3.tgz#c1d8d149316d3ea852848895cb6a0bfe887b87df" + integrity sha512-O84QOnr0icsbFGLS0O3bI5FswxzRr8/gHwWkDlQFskhSPryQXvrTMxjxGP4+iWYoauLoBvfDpkrOauZ+0iZpDA== + dependencies: + minimalistic-assert "^1.0.0" + +web-namespaces@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/web-namespaces/-/web-namespaces-2.0.1.tgz#1010ff7c650eccb2592cebeeaf9a1b253fd40692" + integrity sha512-bKr1DkiNa2krS7qxNtdrtHAmzuYGFQLiQ13TsorsdT6ULTkPLKuu5+GsFpDlg6JFjUTwX2DyhMPG2be8uPrqsQ== + +webpack-bundle-analyzer@^4.10.2: + version "4.10.2" + resolved "https://registry.yarnpkg.com/webpack-bundle-analyzer/-/webpack-bundle-analyzer-4.10.2.tgz#633af2862c213730be3dbdf40456db171b60d5bd" + integrity sha512-vJptkMm9pk5si4Bv922ZbKLV8UTT4zib4FPgXMhgzUny0bfDDkLXAVQs3ly3fS4/TN9ROFtb0NFrm04UXFE/Vw== + dependencies: + "@discoveryjs/json-ext" "0.5.7" + acorn "^8.0.4" + acorn-walk "^8.0.0" + commander "^7.2.0" + debounce "^1.2.1" + escape-string-regexp "^4.0.0" + gzip-size "^6.0.0" + html-escaper "^2.0.2" + opener "^1.5.2" + picocolors "^1.0.0" + sirv "^2.0.3" + ws "^7.3.1" + +webpack-dev-middleware@^5.3.4: + version "5.3.4" + resolved "https://registry.yarnpkg.com/webpack-dev-middleware/-/webpack-dev-middleware-5.3.4.tgz#eb7b39281cbce10e104eb2b8bf2b63fce49a3517" + integrity sha512-BVdTqhhs+0IfoeAf7EoH5WE+exCmqGerHfDM0IL096Px60Tq2Mn9MAbnaGUe6HiMa41KMCYF19gyzZmBcq/o4Q== + dependencies: + colorette "^2.0.10" + memfs "^3.4.3" + mime-types "^2.1.31" + range-parser "^1.2.1" + schema-utils "^4.0.0" + +webpack-dev-server@^4.15.2: + version "4.15.2" + resolved "https://registry.yarnpkg.com/webpack-dev-server/-/webpack-dev-server-4.15.2.tgz#9e0c70a42a012560860adb186986da1248333173" + integrity sha512-0XavAZbNJ5sDrCbkpWL8mia0o5WPOd2YGtxrEiZkBK9FjLppIUK2TgxK6qGD2P3hUXTJNNPVibrerKcx5WkR1g== + dependencies: + "@types/bonjour" "^3.5.9" + "@types/connect-history-api-fallback" "^1.3.5" + "@types/express" "^4.17.13" + "@types/serve-index" "^1.9.1" + "@types/serve-static" "^1.13.10" + "@types/sockjs" "^0.3.33" + "@types/ws" "^8.5.5" + ansi-html-community "^0.0.8" + bonjour-service "^1.0.11" + chokidar "^3.5.3" + colorette "^2.0.10" + compression "^1.7.4" + connect-history-api-fallback "^2.0.0" + default-gateway "^6.0.3" + express "^4.17.3" + graceful-fs "^4.2.6" + html-entities "^2.3.2" + http-proxy-middleware "^2.0.3" + ipaddr.js "^2.0.1" + launch-editor "^2.6.0" + open "^8.0.9" + p-retry "^4.5.0" + rimraf "^3.0.2" + schema-utils "^4.0.0" + selfsigned "^2.1.1" + serve-index "^1.9.1" + sockjs "^0.3.24" + spdy "^4.0.2" + webpack-dev-middleware "^5.3.4" + ws "^8.13.0" + +webpack-merge@^5.9.0: + version "5.10.0" + resolved "https://registry.yarnpkg.com/webpack-merge/-/webpack-merge-5.10.0.tgz#a3ad5d773241e9c682803abf628d4cd62b8a4177" + integrity sha512-+4zXKdx7UnO+1jaN4l2lHVD+mFvnlZQP/6ljaJVb4SZiwIKeUnrT5l0gkT8z+n4hKpC+jpOv6O9R+gLtag7pSA== + dependencies: + clone-deep "^4.0.1" + flat "^5.0.2" + wildcard "^2.0.0" + +webpack-merge@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/webpack-merge/-/webpack-merge-6.0.1.tgz#50c776868e080574725abc5869bd6e4ef0a16c6a" + integrity sha512-hXXvrjtx2PLYx4qruKl+kyRSLc52V+cCvMxRjmKwoA+CBbbF5GfIBtR6kCvl0fYGqTUPKB+1ktVmTHqMOzgCBg== + dependencies: + clone-deep "^4.0.1" + flat "^5.0.2" + wildcard "^2.0.1" + +webpack-sources@^3.3.3: + version "3.3.3" + resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-3.3.3.tgz#d4bf7f9909675d7a070ff14d0ef2a4f3c982c723" + integrity sha512-yd1RBzSGanHkitROoPFd6qsrxt+oFhg/129YzheDGqeustzX0vTZJZsSsQjVQC4yzBQ56K55XU8gaNCtIzOnTg== + +webpack@^5.88.1, webpack@^5.95.0: + version "5.101.3" + resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.101.3.tgz#3633b2375bb29ea4b06ffb1902734d977bc44346" + integrity sha512-7b0dTKR3Ed//AD/6kkx/o7duS8H3f1a4w3BYpIriX4BzIhjkn4teo05cptsxvLesHFKK5KObnadmCHBwGc+51A== + dependencies: + "@types/eslint-scope" "^3.7.7" + "@types/estree" "^1.0.8" + "@types/json-schema" "^7.0.15" + "@webassemblyjs/ast" "^1.14.1" + "@webassemblyjs/wasm-edit" "^1.14.1" + "@webassemblyjs/wasm-parser" "^1.14.1" + acorn "^8.15.0" + acorn-import-phases "^1.0.3" + browserslist "^4.24.0" + chrome-trace-event "^1.0.2" + enhanced-resolve "^5.17.3" + es-module-lexer "^1.2.1" + eslint-scope "5.1.1" + events "^3.2.0" + glob-to-regexp "^0.4.1" + graceful-fs "^4.2.11" + json-parse-even-better-errors "^2.3.1" + loader-runner "^4.2.0" + mime-types "^2.1.27" + neo-async "^2.6.2" + schema-utils "^4.3.2" + tapable "^2.1.1" + terser-webpack-plugin "^5.3.11" + watchpack "^2.4.1" + webpack-sources "^3.3.3" + +webpackbar@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/webpackbar/-/webpackbar-6.0.1.tgz#5ef57d3bf7ced8b19025477bc7496ea9d502076b" + integrity sha512-TnErZpmuKdwWBdMoexjio3KKX6ZtoKHRVvLIU0A47R0VVBDtx3ZyOJDktgYixhoJokZTYTt1Z37OkO9pnGJa9Q== + dependencies: + ansi-escapes "^4.3.2" + chalk "^4.1.2" + consola "^3.2.3" + figures "^3.2.0" + markdown-table "^2.0.0" + pretty-time "^1.1.0" + std-env "^3.7.0" + wrap-ansi "^7.0.0" + +websocket-driver@>=0.5.1, websocket-driver@^0.7.4: + version "0.7.4" + resolved "https://registry.yarnpkg.com/websocket-driver/-/websocket-driver-0.7.4.tgz#89ad5295bbf64b480abcba31e4953aca706f5760" + integrity sha512-b17KeDIQVjvb0ssuSDF2cYXSg2iztliJ4B9WdsuB6J952qCPKmnVq4DyW5motImXHDC1cBT/1UezrJVsKw5zjg== + dependencies: + http-parser-js ">=0.5.1" + safe-buffer ">=5.1.0" + websocket-extensions ">=0.1.1" + +websocket-extensions@>=0.1.1: + version "0.1.4" + resolved "https://registry.yarnpkg.com/websocket-extensions/-/websocket-extensions-0.1.4.tgz#7f8473bc839dfd87608adb95d7eb075211578a42" + integrity sha512-OqedPIGOfsDlo31UNwYbCFMSaO9m9G/0faIHj5/dZFDMFqPTcx6UwqyOy3COEaEOg/9VsGIpdqn62W5KhoKSpg== + +which@^2.0.1: + version "2.0.2" + resolved "https://registry.yarnpkg.com/which/-/which-2.0.2.tgz#7c6a8dd0a636a0327e10b59c9286eee93f3f51b1" + integrity sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA== + dependencies: + isexe "^2.0.0" + +widest-line@^4.0.1: + version "4.0.1" + resolved "https://registry.yarnpkg.com/widest-line/-/widest-line-4.0.1.tgz#a0fc673aaba1ea6f0a0d35b3c2795c9a9cc2ebf2" + integrity sha512-o0cyEG0e8GPzT4iGHphIOh0cJOV8fivsXxddQasHPHfoZf1ZexrfeA21w2NaEN1RHE+fXlfISmOE8R9N3u3Qig== + dependencies: + string-width "^5.0.1" + +wildcard@^2.0.0, wildcard@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/wildcard/-/wildcard-2.0.1.tgz#5ab10d02487198954836b6349f74fff961e10f67" + integrity sha512-CC1bOL87PIWSBhDcTrdeLo6eGT7mCFtrg0uIJtqJUFyK+eJnzl8A1niH56uu7KMa5XFrtiV+AQuHO3n7DsHnLQ== + +wrap-ansi@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" + integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q== + dependencies: + ansi-styles "^4.0.0" + string-width "^4.1.0" + strip-ansi "^6.0.0" + +wrap-ansi@^8.0.1, wrap-ansi@^8.1.0: + version "8.1.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-8.1.0.tgz#56dc22368ee570face1b49819975d9b9a5ead214" + integrity sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ== + dependencies: + ansi-styles "^6.1.0" + string-width "^5.0.1" + strip-ansi "^7.0.1" + +wrappy@1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" + integrity sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ== + +write-file-atomic@^3.0.3: + version "3.0.3" + resolved "https://registry.yarnpkg.com/write-file-atomic/-/write-file-atomic-3.0.3.tgz#56bd5c5a5c70481cd19c571bd39ab965a5de56e8" + integrity sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q== + dependencies: + imurmurhash "^0.1.4" + is-typedarray "^1.0.0" + signal-exit "^3.0.2" + typedarray-to-buffer "^3.1.5" + +ws@^7.3.1: + version "7.5.10" + resolved "https://registry.yarnpkg.com/ws/-/ws-7.5.10.tgz#58b5c20dc281633f6c19113f39b349bd8bd558d9" + integrity sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ== + +ws@^8.13.0: + version "8.18.3" + resolved "https://registry.yarnpkg.com/ws/-/ws-8.18.3.tgz#b56b88abffde62791c639170400c93dcb0c95472" + integrity sha512-PEIGCY5tSlUt50cqyMXfCzX+oOPqN0vuGqWzbcJ2xvnkzkq46oOpz7dQaTDBdfICb4N14+GARUDw2XV2N4tvzg== + +xdg-basedir@^5.0.1, xdg-basedir@^5.1.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/xdg-basedir/-/xdg-basedir-5.1.0.tgz#1efba19425e73be1bc6f2a6ceb52a3d2c884c0c9" + integrity sha512-GCPAHLvrIH13+c0SuacwvRYj2SxJXQ4kaVTT5xgL3kPrz56XxkF21IGhjSE1+W0aw7gpBWRGXLCPnPby6lSpmQ== + +xml-js@^1.6.11: + version "1.6.11" + resolved "https://registry.yarnpkg.com/xml-js/-/xml-js-1.6.11.tgz#927d2f6947f7f1c19a316dd8eea3614e8b18f8e9" + integrity sha512-7rVi2KMfwfWFl+GpPg6m80IVMWXLRjO+PxTq7V2CDhoGak0wzYzFgUY2m4XJ47OGdXd8eLE8EmwfAmdjw7lC1g== + dependencies: + sax "^1.2.4" + +yallist@^3.0.2: + version "3.1.1" + resolved "https://registry.yarnpkg.com/yallist/-/yallist-3.1.1.tgz#dbb7daf9bfd8bac9ab45ebf602b8cbad0d5d08fd" + integrity sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g== + +yaml@^1.10.0: + version "1.10.2" + resolved "https://registry.yarnpkg.com/yaml/-/yaml-1.10.2.tgz#2301c5ffbf12b467de8da2333a459e29e7920e4b" + integrity sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg== + +yocto-queue@^1.0.0: + version "1.2.1" + resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-1.2.1.tgz#36d7c4739f775b3cbc28e6136e21aa057adec418" + integrity sha512-AyeEbWOu/TAXdxlV9wmGcR0+yh2j3vYPGOECcIj2S7MkrLyC7ne+oye2BKTItt0ii2PHk4cDy+95+LshzbXnGg== + +zwitch@^2.0.0: + version "2.0.4" + resolved "https://registry.yarnpkg.com/zwitch/-/zwitch-2.0.4.tgz#c827d4b0acb76fc3e685a4c6ec2902d51070e9d7" + integrity sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A== From f651df80697760353d74352f0357a6fb21c4f3f8 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Tue, 16 Sep 2025 18:55:28 +1000 Subject: [PATCH 2/2] move docs to microsite --- .../{prod-web-deploy.yml.disabled => prod-web-deploy.yml} | 0 .../{test-web-deploy.yml.disabled => test-web-deploy.yml} | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{prod-web-deploy.yml.disabled => prod-web-deploy.yml} (100%) rename .github/workflows/{test-web-deploy.yml.disabled => test-web-deploy.yml} (100%) diff --git a/.github/workflows/prod-web-deploy.yml.disabled b/.github/workflows/prod-web-deploy.yml similarity index 100% rename from .github/workflows/prod-web-deploy.yml.disabled rename to .github/workflows/prod-web-deploy.yml diff --git a/.github/workflows/test-web-deploy.yml.disabled b/.github/workflows/test-web-deploy.yml similarity index 100% rename from .github/workflows/test-web-deploy.yml.disabled rename to .github/workflows/test-web-deploy.yml