productivity
PagerDuty Lua API for KosmoKrator Agents
Agent-facing Lua documentation and function reference for the PagerDuty KosmoKrator integration.Lua Namespace
Agents call this integration through app.integrations.pagerduty.*.
Use lua_read_doc("integrations.pagerduty") inside KosmoKrator to discover the same reference at runtime.
Call Lua from the Headless CLI
Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic
PagerDuty workflow without starting an interactive agent session.
kosmo integrations:lua --eval 'dump(app.integrations.pagerduty.associate_trigger_and_service({}))' --json kosmo integrations:lua --eval 'print(docs.read("pagerduty"))' --json
kosmo integrations:lua --eval 'print(docs.read("pagerduty.associate_trigger_and_service"))' --json Workflow file
Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.
local pagerduty = app.integrations.pagerduty
local result = pagerduty.associate_trigger_and_service({})
dump(result) kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json integrations:lua exposes app.integrations.pagerduty, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.pagerduty.default.* or app.integrations.pagerduty.work.* when you configured named credential accounts.
MCP-only Lua
If the script only needs configured MCP servers and does not need PagerDuty, use the narrower mcp:lua command.
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json Agent-Facing Lua Docs
This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.
PagerDuty Lua Docs
Namespace: pagerduty
This integration is generated from PagerDuty’s official REST OpenAPI schema and exposes 420 REST operations. Use it for incident response automation, service and team inventory, escalation policies, schedules, users, automation actions, analytics, status pages, maintenance windows, priorities, tags, and webhooks.
Authentication
Configure a PagerDuty REST API token. Requests use Authorization: Bearer <token> and Accept: application/vnd.pagerduty+json;version=2.
Common Tools
pagerduty_list_incidents- list incidents with filters such asstatuses,urgencies,service_ids,team_ids,limit, andoffset.pagerduty_get_incident- fetch one incident byid.pagerduty_list_servicesandpagerduty_get_service- inspect services.pagerduty_list_teamsandpagerduty_get_team- inspect teams.pagerduty_get_current_user- verify the authenticated user.
Generated Operation Pattern
Path and query parameters use snake_case names. PagerDuty query parameters documented with [], such as statuses[], are exposed without brackets, such as statuses, and can be passed as arrays.
For write operations, pass the JSON payload as body. If you pass extra top-level arguments that are not path, query, or header parameters, the integration sends them as the JSON body.
local incidents = pagerduty.pagerduty_list_incidents({
statuses = { "triggered", "acknowledged" },
limit = 10
})
local incident = pagerduty.pagerduty_get_incident({
id = "Q0123456789ABC"
})
Scope Notes
This package covers PagerDuty’s REST OpenAPI schema. PagerDuty Events API, SCIM, and service-specific integration schemas are separate API families and are intentionally not mixed into this package.
Return values are the parsed PagerDuty JSON response for the operation. The integration does not unwrap collection fields, so agents should read the documented response key, such as incidents, services, teams, or user.
Raw agent markdown
# PagerDuty Lua Docs
Namespace: `pagerduty`
This integration is generated from PagerDuty's official REST OpenAPI schema and exposes 420 REST operations. Use it for incident response automation, service and team inventory, escalation policies, schedules, users, automation actions, analytics, status pages, maintenance windows, priorities, tags, and webhooks.
## Authentication
Configure a PagerDuty REST API token. Requests use `Authorization: Bearer <token>` and `Accept: application/vnd.pagerduty+json;version=2`.
## Common Tools
- `pagerduty_list_incidents` - list incidents with filters such as `statuses`, `urgencies`, `service_ids`, `team_ids`, `limit`, and `offset`.
- `pagerduty_get_incident` - fetch one incident by `id`.
- `pagerduty_list_services` and `pagerduty_get_service` - inspect services.
- `pagerduty_list_teams` and `pagerduty_get_team` - inspect teams.
- `pagerduty_get_current_user` - verify the authenticated user.
## Generated Operation Pattern
Path and query parameters use snake_case names. PagerDuty query parameters documented with `[]`, such as `statuses[]`, are exposed without brackets, such as `statuses`, and can be passed as arrays.
For write operations, pass the JSON payload as `body`. If you pass extra top-level arguments that are not path, query, or header parameters, the integration sends them as the JSON body.
```lua
local incidents = pagerduty.pagerduty_list_incidents({
statuses = { "triggered", "acknowledged" },
limit = 10
})
local incident = pagerduty.pagerduty_get_incident({
id = "Q0123456789ABC"
})
```
## Scope Notes
This package covers PagerDuty's REST OpenAPI schema. PagerDuty Events API, SCIM, and service-specific integration schemas are separate API families and are intentionally not mixed into this package.
Return values are the parsed PagerDuty JSON response for the operation. The integration does not unwrap collection fields, so agents should read the documented response key, such as `incidents`, `services`, `teams`, or `user`. local result = app.integrations.pagerduty.associate_trigger_and_service({})
print(result) Functions
associate_trigger_and_service Write
Associate a Trigger and Service Associate a Service with an existing Incident Workflow Trigger Scoped OAuth requires: `incident_workflows.write`
- Lua path
app.integrations.pagerduty.associate_trigger_and_service- Full name
pagerduty.pagerduty_associate_service_to_incident_workflow_trigger
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
cancel_responder_requests_incident Write
Cancel responder requests for an incident Cancel pending responder requests for the specified incident. This endpoint allows you to cancel responder requests for specified targets that are in a pending state. Only responders who have not yet joined or declined can be cancelled. This endpoint requires the account to have access to the [responder requests](https://support.pagerduty.com/main/docs/add-responders) feature. **Account Ability Requirement**: The account must have the `coordinated_responding` ability. Returns 402 Payment Required if the ability is missing. You can use the [List Abilities API](openapiv3.json/paths/~1abilities/get) to check account abilities. **State Constraints**: Only responders in the `pending` state can be cancelled. Responders who have already `joined` or `declined` are not affected (the result will indicate their current state). **User vs Escalation Policy Behavior**: - **Users**: Direct cancellation, updates state to `user_cancelled`, stops notifications - **Escalation Policies**: Stops the escalation process, updates state of all pending users from that escalation policy to `user_cancelled` and stops notifications **Result Values**: - `cancelled`: Successfully cancelled - `joined`: User already joined (not cancelled) - `declined`: User already declined (not cancelled) - `not_found`: Target not found or not part of any responder request Scoped OAuth requires: `incidents.write`
- Lua path
app.integrations.pagerduty.cancel_responder_requests_incident- Full name
pagerduty.pagerduty_cancel_incident_responder_request
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
convert_service_event_rules_into_event_orchestration_rules Write
Convert a Service's Event Rules into Event Orchestration Rules Convert this Service's Event Rules into functionally equivalent Event Orchestration Rules. Sending a request to this API endpoint has several effects: 1. Automatically creates Event Orchestration Rules for this Service that will behave identically as this Service's currently configured Event Rules. 2. Makes all existing Event Rules for this Service read-only. All future updates need to be made via the newly created Event Orchestration rules. Sending a request to this API endpoint will **not** change how future events will be processed. If past events for this Service have been evaluated via Event Rules then new events sent to this Service will also continue to be evaluated via the (now read-only) Event Rules. To change this Service so that new events start being evaluated via the newly created Event Orchestration Rules use the [Update the Service Orchestration active status for a Service API](https://developer.pagerduty.com/api-reference/855659be83d9e-update-the-service-orchestration-active-status-for-a-service). > ### End-of-life > Event Rules will end-of-life soon. We highly recommend that you use this API to [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.convert_service_event_rules_into_event_orchestration_rules- Full name
pagerduty.pagerduty_convert_service_event_rules_to_event_orchestration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
install_add Write
Install an Add-on for your account. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. Given a configuration containing a `src` parameter, that URL will be embedded in an `iframe` on a page that's available to users from a drop-down menu. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#add-ons) Scoped OAuth requires: `addons.write`
- Lua path
app.integrations.pagerduty.install_add- Full name
pagerduty.pagerduty_create_addon
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_automation_action Write
Create an Automation Action Create a Script, Process Automation, or Runbook Automation action
- Lua path
app.integrations.pagerduty.create_automation_action- Full name
pagerduty.pagerduty_create_automation_action
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_invocation Write
Create an Invocation Invokes an Action
- Lua path
app.integrations.pagerduty.create_invocation- Full name
pagerduty.pagerduty_create_automation_action_invocation
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
associate_automation_action_with_service Write
Associate an Automation Action with a service
- Lua path
app.integrations.pagerduty.associate_automation_action_with_service- Full name
pagerduty.pagerduty_create_automation_action_service_assocation
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
associate_automation_action_with_team Write
Associate an Automation Action with a team
- Lua path
app.integrations.pagerduty.associate_automation_action_with_team- Full name
pagerduty.pagerduty_create_automation_action_team_association
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_automation_action_runner Write
Create an Automation Action runner. Create a Process Automation or a Runbook Automation runner.
- Lua path
app.integrations.pagerduty.create_automation_action_runner- Full name
pagerduty.pagerduty_create_automation_actions_runner
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
associate_runner_with_team Write
Associate a runner with a team
- Lua path
app.integrations.pagerduty.associate_runner_with_team- Full name
pagerduty.pagerduty_create_automation_actions_runner_team_association
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_business_service Write
Create a Business Service Create a new Business Service. Business services model capabilities that span multiple technical services and that may be owned by several different teams. There is a limit of 5,000 business services per account. If the limit is reached, the API will respond with an error. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#business-services) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.create_business_service- Full name
pagerduty.pagerduty_create_business_service
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_business_service_account_subscription Write
Create Business Service Account Subscription Subscribe your Account to a Business Service. Scoped OAuth requires: `subscribers.write`
- Lua path
app.integrations.pagerduty.create_business_service_account_subscription- Full name
pagerduty.pagerduty_create_business_service_account_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_business_service_subscribers Write
Create Business Service Subscribers Subscribe the given entities to the given Business Service. Scoped OAuth requires: `subscribers.write`
- Lua path
app.integrations.pagerduty.create_business_service_subscribers- Full name
pagerduty.pagerduty_create_business_service_notification_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_cache_variable_global_event_orchestration Write
Create a Cache Variable for a Global Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`
- Lua path
app.integrations.pagerduty.create_cache_variable_global_event_orchestration- Full name
pagerduty.pagerduty_create_cache_var_on_global_orch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_cache_variable_service_event_orchestration Write
Create a Cache Variable for a Service Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.create_cache_variable_service_event_orchestration- Full name
pagerduty.pagerduty_create_cache_var_on_service_orch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_change_event Write
Create a Change Event Sending Change Events is documented as part of the V2 Events API. See [`Send Change Event`](https://developer.pagerduty.com/api-reference/b3A6Mjc0ODI2Ng-send-change-events-to-the-pager-duty-events-api).
- Lua path
app.integrations.pagerduty.create_change_event- Full name
pagerduty.pagerduty_create_change_event
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_field Write
Create a Field <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields/post) Creates a new Custom Field on the Base Incident Type, along with the Field Options if provided. \ An account may have up to 10 Fields. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.create_field- Full name
pagerduty.pagerduty_create_custom_fields_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_field_option Write
Create a Field Option <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields/{field_id}/field_options](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields~1{field_id}~1field_options/post) Create a new Field Option for a Custom Field on the Base Incident Type. Field Options may only be created for Fields that have `field_options`. A Field may have no more than 10 enabled options. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.create_field_option- Full name
pagerduty.pagerduty_create_custom_fields_field_option
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_custom_shifts Write
Create custom shifts <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Create one or more custom shifts for a schedule. Custom shifts are ad-hoc one-off coverage periods that exist outside of rotation events. Each custom shift requires exactly one assignment.
- Lua path
app.integrations.pagerduty.create_custom_shifts- Full name
pagerduty.pagerduty_create_custom_shifts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
assign_tags Write
Assign tags Assign existing or new tags. A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#tags) Scoped OAuth requires: `tags.write`
- Lua path
app.integrations.pagerduty.assign_tags- Full name
pagerduty.pagerduty_create_entity_type_by_id_change_tags
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_escalation_policy Write
Create an escalation policy Creates a new escalation policy. At least one escalation rule must be provided. Escalation policies define which user should be alerted at which time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#escalation-policies) Scoped OAuth requires: `escalation_policies.write`
- Lua path
app.integrations.pagerduty.create_escalation_policy- Full name
pagerduty.pagerduty_create_escalation_policy
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_event Write
Create an event <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Create a new event that defines when and how users are on-call within a rotation. **Constraints:** - Maximum 5 events per rotation - Events within a rotation cannot overlap - `effective_since` must be in the future (past values are clamped to now) - All users referenced in `assignment_strategy.members` must exist and belong to the account
- Lua path
app.integrations.pagerduty.create_event- Full name
pagerduty.pagerduty_create_event
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_extension Write
Create an extension Create a new Extension. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#extensions) Scoped OAuth requires: `extensions.write`
- Lua path
app.integrations.pagerduty.create_extension- Full name
pagerduty.pagerduty_create_extension
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_incident Write
Create an Incident Create an incident synchronously without a corresponding event from a monitoring service. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write` This API operation has operation specific rate limits. See the [Rate Limits](https://developer.pagerduty.com/docs/72d3b724589e3-rest-api-rate-limits) page for more information.
- Lua path
app.integrations.pagerduty.create_incident- Full name
pagerduty.pagerduty_create_incident
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_note_incident Write
Create a note on an incident Create a new note for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. A maximum of 2000 notes can be added to an incident. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write`
- Lua path
app.integrations.pagerduty.create_note_incident- Full name
pagerduty.pagerduty_create_incident_note
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
add_notification_subscribers Write
Add Notification Subscribers Subscribe the given entities to Incident Status Update Notifications. Scoped OAuth requires: `subscribers.write`
- Lua path
app.integrations.pagerduty.add_notification_subscribers- Full name
pagerduty.pagerduty_create_incident_notification_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_responder_request_incident Write
Create a responder request for an incident Send a new responder request for the specified incident. This endpoint requires the account to have access to the [responder requests](https://support.pagerduty.com/main/docs/add-responders) feature. **Account Ability Requirement**: The account must have the `coordinated_responding` ability. Returns 402 Payment Required if the ability is missing. You can use the [List Abilities API](openapiv3.json/paths/~1abilities/get) to check account abilities. A user or an escalation policy can be requested. The responder targets will be notified via their high urgency notification rules, until the target user has either accepted or declined the request. Previous responder requests for a given target can be cancelled (preventing them from further notifying or escalating), with the [Cancel Responder Requests](openapiv3.json/paths/~1incidents~1{id}~1responder_requests~1cancel/put) endpoint. Scoped OAuth requires: `incidents.write`
- Lua path
app.integrations.pagerduty.create_responder_request_incident- Full name
pagerduty.pagerduty_create_incident_responder_request
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
snooze_incident Write
Snooze an incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write`
- Lua path
app.integrations.pagerduty.snooze_incident- Full name
pagerduty.pagerduty_create_incident_snooze
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_status_update_incident Write
Create a status update on an incident Create a new status update for the specified incident. Optionally pass `subject` and `html_message` properties in the request body to override the email notification that gets sent. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write`
- Lua path
app.integrations.pagerduty.create_status_update_incident- Full name
pagerduty.pagerduty_create_incident_status_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_incident_type Write
Create an Incident Type Create a new incident type. Incident Types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidentType) Scoped OAuth requires: `incident_types.write`
- Lua path
app.integrations.pagerduty.create_incident_type- Full name
pagerduty.pagerduty_create_incident_type
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_custom_field_incident_type Write
Create a Custom Field for an Incident Type Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.create_custom_field_incident_type- Full name
pagerduty.pagerduty_create_incident_type_custom_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_field_option_custom_field Write
Create a Field Option for a Custom Field Create a field option for a custom field. Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.create_field_option_custom_field- Full name
pagerduty.pagerduty_create_incident_type_custom_field_field_options
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
start_incident_workflow_instance Write
Start an Incident Workflow Instance Start an Instance of an Incident Workflow. Sometimes referred to as "triggering a workflow on an incident." An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. Scoped OAuth requires: `incident_workflows:instances.write`
- Lua path
app.integrations.pagerduty.start_incident_workflow_instance- Full name
pagerduty.pagerduty_create_incident_workflow_instance
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_trigger Write
Create a Trigger Create new Incident Workflow Trigger Scoped OAuth requires: `incident_workflows.write`
- Lua path
app.integrations.pagerduty.create_trigger- Full name
pagerduty.pagerduty_create_incident_workflow_trigger
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_maintenance_window Write
Create a maintenance window Create a new maintenance window for the specified services. No new incidents will be created for a service that is in maintenance. A Maintenance Window is used to temporarily disable one or more Services for a set period of time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#maintenance-windows) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.create_maintenance_window- Full name
pagerduty.pagerduty_create_maintenance_window
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_oauth_client Write
Create an OAuth client Create a new OAuth client for webhook subscriptions. The client credentials will be validated by attempting to obtain an access token before creation. Requires admin or owner role permissions. Maximum of 10 OAuth clients per account.
- Lua path
app.integrations.pagerduty.create_oauth_client- Full name
pagerduty.pagerduty_create_oauth_client
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_or_update_post_postmortem Write
Create or Update a Post Postmortem Create or Update a Postmortem for a Post by Post ID. Scoped OAuth requires: `status_pages.write`
- Lua path
app.integrations.pagerduty.create_or_update_post_postmortem- Full name
pagerduty.pagerduty_create_or_update_status_page_postmortem
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_overrides Write
Create overrides <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Create one or more overrides for a schedule. An override temporarily replaces a scheduled on-call member with a different member for a specific time period. Each override must reference either a `rotation_id` or a `custom_shift_id` (not both). The overriding member must belong to the account. **Note:** The create response wraps the result in an `overrides` array. Single-resource endpoints (get, update) wrap in `override` (singular).
- Lua path
app.integrations.pagerduty.create_overrides- Full name
pagerduty.pagerduty_create_overrides
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_rotation Write
Create a rotation <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Create a new empty rotation for a schedule. After creating a rotation, add events to define the on-call pattern. **Note:** Rotations have no configuration of their own - all scheduling logic (recurrence, assignment strategy, members) is specified on events. The request body must be empty or `{}`.
- Lua path
app.integrations.pagerduty.create_rotation- Full name
pagerduty.pagerduty_create_rotation
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_ruleset Write
Create a Ruleset Create a new Ruleset. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Scoped OAuth requires: `event_rules.write`
- Lua path
app.integrations.pagerduty.create_ruleset- Full name
pagerduty.pagerduty_create_ruleset
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_event_rule Write
Create an Event Rule Create a new Event Rule. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead. Scoped OAuth requires: `event_rules.write`
- Lua path
app.integrations.pagerduty.create_event_rule- Full name
pagerduty.pagerduty_create_ruleset_event_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_schedule Write
Create a schedule Create a new on-call schedule. A Schedule determines the time periods that users are On-Call. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `schedules.write`
- Lua path
app.integrations.pagerduty.create_schedule- Full name
pagerduty.pagerduty_create_schedule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_one_or_more_overrides Write
Create one or more overrides, each for a specific user covering a specified time range. If you create an override on top of an existing override, the last created override will have priority. A Schedule determines the time periods that users are On-Call. Note: An older implementation of this endpoint only supported creating a single ocverride per request. That functionality is still supported, but deprecated and may be removed in the future. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `schedules.write`
- Lua path
app.integrations.pagerduty.create_one_or_more_overrides- Full name
pagerduty.pagerduty_create_schedule_override
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
preview_schedule Write
Preview a schedule Preview what an on-call schedule would look like without saving it. A Schedule determines the time periods that users are On-Call. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `schedules.write`
- Lua path
app.integrations.pagerduty.preview_schedule- Full name
pagerduty.pagerduty_create_schedule_preview
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_schedule Write
Create a schedule <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Create a new on-call schedule with basic metadata. Rotations and events must be added via separate API calls after creation. **Rejected fields:** `rotations` and `escalation_policies` are not accepted in the request body and will result in a 400 error.
- Lua path
app.integrations.pagerduty.create_schedule- Full name
pagerduty.pagerduty_create_schedule_v3
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_service Write
Create a service Create a new service. If `status` is included in the request, it must have a value of `active` when creating a new service. If a different status is required, make a second request to update the service. A service may represent an application, component, or team you wish to open incidents against. There is a limit of 25,000 services per account. If the limit is reached, the API will respond with an error. There is also a limit of 100,000 open Incidents per Service. If the limit is reached and `auto_resolve_timeout` is disabled (set to 0 or null), the `auto_resolve_timeout` property will automatically be set to 84600 (1 day). For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.create_service- Full name
pagerduty.pagerduty_create_service
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_field Write
Create a Field Creates a new Custom Field for Services, along with the Field Options if provided. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.create_field- Full name
pagerduty.pagerduty_create_service_custom_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_field_option Write
Create a Field Option Create a new option for the given field. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.create_field_option- Full name
pagerduty.pagerduty_create_service_custom_field_option
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
associate_service_dependencies Write
Associate service dependencies Create new dependencies between two services. Business services model capabilities that span multiple technical services and that may be owned by several different teams. A service can have a maximum of 2,000 dependencies with a depth limit of 100. If the limit is reached, the API will respond with an error. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#business-services) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.associate_service_dependencies- Full name
pagerduty.pagerduty_create_service_dependency
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_event_rule_service Write
Create an Event Rule on a Service Create a new Event Rule on a Service. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.create_event_rule_service- Full name
pagerduty.pagerduty_create_service_event_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_new_integration Write
Create a new integration belonging to a Service. A service may represent an application, component, or team you wish to open incidents against. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.create_new_integration- Full name
pagerduty.pagerduty_create_service_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_status_post Write
Create a Status Page Post Create a Post for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.write`
- Lua path
app.integrations.pagerduty.create_status_post- Full name
pagerduty.pagerduty_create_status_page_post
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_status_post_update Write
Create a Status Page Post Update Create a Post Update for a Post by Post ID. Scoped OAuth requires: `status_pages.write`
- Lua path
app.integrations.pagerduty.create_status_post_update- Full name
pagerduty.pagerduty_create_status_page_post_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_status_subscription Write
Create a Status Page Subscription Create a Subscription for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.write`
- Lua path
app.integrations.pagerduty.create_status_subscription- Full name
pagerduty.pagerduty_create_status_page_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_tag Write
Create a tag Create a Tag. A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#tags) Scoped OAuth requires: `tags.write`
- Lua path
app.integrations.pagerduty.create_tag- Full name
pagerduty.pagerduty_create_tags
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_team Write
Create a team Create a new Team. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.write`
- Lua path
app.integrations.pagerduty.create_team- Full name
pagerduty.pagerduty_create_team
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_team_notification_subscriptions Write
Create Team Notification Subscriptions Create new Notification Subscriptions for the given Team. Scoped OAuth requires: `subscribers.write`
- Lua path
app.integrations.pagerduty.create_team_notification_subscriptions- Full name
pagerduty.pagerduty_create_team_notification_subscriptions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_template Write
Create a template Create a new template Scoped OAuth requires: `templates.write`
- Lua path
app.integrations.pagerduty.create_template- Full name
pagerduty.pagerduty_create_template
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_user Write
Create a user Create a new user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`
- Lua path
app.integrations.pagerduty.create_user- Full name
pagerduty.pagerduty_create_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_user_contact_method Write
Create a user contact method Create a new contact method for the User. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.write`
- Lua path
app.integrations.pagerduty.create_user_contact_method- Full name
pagerduty.pagerduty_create_user_contact_method
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_user_handoff_notification_rule Write
Create a User Handoff Notification Rule Create a new Handoff Notification Rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`
- Lua path
app.integrations.pagerduty.create_user_handoff_notification_rule- Full name
pagerduty.pagerduty_create_user_handoff_notification_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_user_notification_rule Write
Create a user notification rule Create a new notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.write`
- Lua path
app.integrations.pagerduty.create_user_notification_rule- Full name
pagerduty.pagerduty_create_user_notification_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_notification_subcriptions Write
Create Notification Subcriptions Create new Notification Subscriptions for the given User. Scoped OAuth requires: `subscribers.write`
- Lua path
app.integrations.pagerduty.create_notification_subcriptions- Full name
pagerduty.pagerduty_create_user_notification_subscriptions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_user_status_update_notification_rule Write
Create a user status update notification rule Create a new status update notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`
- Lua path
app.integrations.pagerduty.create_user_status_update_notification_rule- Full name
pagerduty.pagerduty_create_user_status_update_notification_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_webhook_subscription Write
Create a webhook subscription Creates a new webhook subscription. For more information on webhook subscriptions and how they are used to configure v3 webhooks see the [Webhooks v3 Developer Documentation](https://developer.pagerduty.com/docs/webhooks/v3-overview/). Scoped OAuth requires: `webhook_subscriptions.write`
- Lua path
app.integrations.pagerduty.create_webhook_subscription- Full name
pagerduty.pagerduty_create_webhook_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_workflow_integration_connection Write
Create Workflow Integration Connection Create a new Workflow Integration Connection. Scoped OAuth requires: `workflow_integrations:connections.write`
- Lua path
app.integrations.pagerduty.create_workflow_integration_connection- Full name
pagerduty.pagerduty_create_workflow_integration_connection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_add Write
Delete an Add-on Remove an existing Add-on. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#add-ons) Scoped OAuth requires: `addons.write`
- Lua path
app.integrations.pagerduty.delete_add- Full name
pagerduty.pagerduty_delete_addon
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_alert_grouping_setting Write
Delete an Alert Grouping Setting Delete an existing Alert Grouping Setting. The settings part of Alert Grouper service allows us to create Alert Grouping Settings and configs that are required to be used during grouping of the alerts. Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.delete_alert_grouping_setting- Full name
pagerduty.pagerduty_delete_alert_grouping_setting
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_automation_action Write
Delete an Automation Action
- Lua path
app.integrations.pagerduty.delete_automation_action- Full name
pagerduty.pagerduty_delete_automation_action
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
disassociate_automation_action_from_service Write
Disassociate an Automation Action from a service
- Lua path
app.integrations.pagerduty.disassociate_automation_action_from_service- Full name
pagerduty.pagerduty_delete_automation_action_service_association
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
disassociate_automation_action_from_team Write
Disassociate an Automation Action from a team
- Lua path
app.integrations.pagerduty.disassociate_automation_action_from_team- Full name
pagerduty.pagerduty_delete_automation_action_team_association
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_automation_action_runner Write
Delete an Automation Action runner
- Lua path
app.integrations.pagerduty.delete_automation_action_runner- Full name
pagerduty.pagerduty_delete_automation_actions_runner
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
disassociate_runner_from_team Write
Disassociate a runner from a team Disassociates a runner from a team
- Lua path
app.integrations.pagerduty.disassociate_runner_from_team- Full name
pagerduty.pagerduty_delete_automation_actions_runner_team_association
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_business_service Write
Delete a Business Service Delete an existing Business Service. Once the service is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this service. Business services model capabilities that span multiple technical services and that may be owned by several different teams. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#business-services) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.delete_business_service- Full name
pagerduty.pagerduty_delete_business_service
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
deletes_account_level_priority_threshold_business_service_impact Write
Deletes the account-level priority threshold for Business Service impact Clears the Priority Threshold for the account. If the priority threshold is cleared, any Incident with a Priority set will be able to impact Business Services. Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.deletes_account_level_priority_threshold_business_service_impact- Full name
pagerduty.pagerduty_delete_business_service_priority_thresholds
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_cache_variable_global_event_orchestration Write
Delete a Cache Variable for a Global Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`
- Lua path
app.integrations.pagerduty.delete_cache_variable_global_event_orchestration- Full name
pagerduty.pagerduty_delete_cache_var_on_global_orch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_cache_variable_service_event_orchestration Write
Delete a Cache Variable for a Service Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.delete_cache_variable_service_event_orchestration- Full name
pagerduty.pagerduty_delete_cache_var_on_service_orch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_field Write
Delete a Field <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields/{field_id}](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields~1{field_id}/delete) Delete a Custom Field from the Base Incident Type. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.delete_field- Full name
pagerduty.pagerduty_delete_custom_fields_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_field_option Write
Delete a Field Option <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields/{field_id}/field_options/{field_option_id}](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields~1{field_id}~1field_options~1{field_option_id}/delete) Delete a Field Option for a Custom Field on the Base Incident Type. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.delete_field_option- Full name
pagerduty.pagerduty_delete_custom_fields_field_option
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_custom_shift Write
Delete a custom shift <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Delete a custom shift by ID. When the shift is not started, it deletes the shift entirely. If the shift is already started, it sets the end_time to now. It returns Bad Request when shift is already ended.
- Lua path
app.integrations.pagerduty.delete_custom_shift- Full name
pagerduty.pagerduty_delete_custom_shift
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_escalation_policy Write
Delete an escalation policy Deletes an existing escalation policy and rules. The escalation policy must not be in use by any services. Escalation policies define which user should be alerted at which time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#escalation-policies) Scoped OAuth requires: `escalation_policies.write`
- Lua path
app.integrations.pagerduty.delete_escalation_policy- Full name
pagerduty.pagerduty_delete_escalation_policy
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_event Write
Delete an event <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Delete an event from a rotation.
- Lua path
app.integrations.pagerduty.delete_event- Full name
pagerduty.pagerduty_delete_event
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_extension Write
Delete an extension Delete an existing extension. Once the extension is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this extension. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#extensions) Scoped OAuth requires: `extensions.write`
- Lua path
app.integrations.pagerduty.delete_extension- Full name
pagerduty.pagerduty_delete_extension
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_data_external_data_cache_variable_global_event_orchestration Write
Delete Data for an External Data Cache Variable on a Global Event Orchestration Delete data for an `external_data` type Cache Variable on a Global Event Orchestration Use External Data type Cache Variables to store string, number, or boolean values via a dedicated API endpoint. These stored values can then be used in conditions or actions in Event Orchestration rules. For more information see the [Knowledge Base](https://support.pagerduty.com/main/docs/event-orchestration-cache-variables) Scoped OAuth requires: `event_orchestrations.write`
- Lua path
app.integrations.pagerduty.delete_data_external_data_cache_variable_global_event_orchestration- Full name
pagerduty.pagerduty_delete_external_data_cache_var_data_on_global_orch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_data_external_data_cache_variable_service_event_orchestration Write
Delete Data for an External Data Cache Variable on a Service Event Orchestration Delete Data for an `external_data` type Cache Variable on a Service Event Orchestration. Use External Data type Cache Variables to store string, number, or boolean values via a dedicated API endpoint. These stored values can then be used in conditions or actions in Event Orchestration rules. For more information see the [Knowledge Base](https://support.pagerduty.com/main/docs/event-orchestration-cache-variables) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.delete_data_external_data_cache_variable_service_event_orchestration- Full name
pagerduty.pagerduty_delete_external_data_cache_var_data_on_service_orch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_note_incident Write
Delete a note on an incident Delete an existing note for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write`
- Lua path
app.integrations.pagerduty.delete_note_incident- Full name
pagerduty.pagerduty_delete_incident_note
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_custom_field_incident_type Write
Delete a Custom Field for an Incident Type Delete a custom field for an incident type. Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.delete_custom_field_incident_type- Full name
pagerduty.pagerduty_delete_incident_type_custom_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_field_option_custom_field Write
Delete a Field Option for a Custom Field Delete a field option for a custom field. Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.delete_field_option_custom_field- Full name
pagerduty.pagerduty_delete_incident_type_custom_field_field_option
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_incident_workflow Write
Delete an Incident Workflow Delete an existing Incident Workflow An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. Scoped OAuth requires: `incident_workflows.write`
- Lua path
app.integrations.pagerduty.delete_incident_workflow- Full name
pagerduty.pagerduty_delete_incident_workflow
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_trigger Write
Delete a Trigger Delete an existing Incident Workflow Trigger Scoped OAuth requires: `incident_workflows.write`
- Lua path
app.integrations.pagerduty.delete_trigger- Full name
pagerduty.pagerduty_delete_incident_workflow_trigger
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_or_end_maintenance_window Write
Delete or end a maintenance window Delete an existing maintenance window if it's in the future, or end it if it's currently on-going. If the maintenance window has already ended it cannot be deleted. A Maintenance Window is used to temporarily disable one or more Services for a set period of time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#maintenance-windows) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.delete_or_end_maintenance_window- Full name
pagerduty.pagerduty_delete_maintenance_window
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_oauth_client Write
Delete an OAuth client. This will also remove the OAuth client association from any webhook subscriptions using it. Requires admin or owner role permissions.
- Lua path
app.integrations.pagerduty.delete_oauth_client- Full name
pagerduty.pagerduty_delete_oauth_client
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_all_oauth_delegations Write
Delete all OAuth delegations as per provided query parameters. An OAuth delegation represents an instance of a user or account's authorization to an app (via OAuth) to access their PagerDuty account. Common apps include the PagerDuty mobile app, Slack, Microsoft Teams, and third-party apps. It also represents a user session in the PagerDuty web app. Deleting an OAuth delegation will revoke that instance of an app's access to that user or account. To grant access again, reauthorization/reauthentication will be required. This endpoint supports deleting mobile app OAuth delegations for a given user, which is equivalent to signing users out of the mobile app. It also supports deleting delegations of type web, which is equivalent to signing users out of the web app. This is a synchronous API. Scoped OAuth requires: `oauth_delegations.write`
- Lua path
app.integrations.pagerduty.delete_all_oauth_delegations- Full name
pagerduty.pagerduty_delete_oauth_delegations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_orchestration Write
Delete an Orchestration Delete a Global Event Orchestration. Once deleted, you will no longer be able to ingest events into PagerDuty using this Orchestration's Routing Key. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`
- Lua path
app.integrations.pagerduty.delete_orchestration- Full name
pagerduty.pagerduty_delete_orchestration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_integration_event_orchestration Write
Delete an Integration for an Event Orchestration Delete an Integration and its associated Routing Key. Once deleted, PagerDuty will drop all future events sent to PagerDuty using the Routing Key. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`
- Lua path
app.integrations.pagerduty.delete_integration_event_orchestration- Full name
pagerduty.pagerduty_delete_orchestration_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_override Write
Delete an override <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Delete an override by ID.
- Lua path
app.integrations.pagerduty.delete_override- Full name
pagerduty.pagerduty_delete_override
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_rotation Write
Delete a rotation <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Delete a rotation and all its events. On deletion, past events are preserved in the audit history, the current active event is truncated to the deletion time, and future events are removed.
- Lua path
app.integrations.pagerduty.delete_rotation- Full name
pagerduty.pagerduty_delete_rotation
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_ruleset Write
Delete a Ruleset. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Scoped OAuth requires: `event_rules.write`
- Lua path
app.integrations.pagerduty.delete_ruleset- Full name
pagerduty.pagerduty_delete_ruleset
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_event_rule Write
Delete an Event Rule. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Scoped OAuth requires: `event_rules.write`
- Lua path
app.integrations.pagerduty.delete_event_rule- Full name
pagerduty.pagerduty_delete_ruleset_event_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_schedule Write
Delete a schedule Delete an on-call schedule. A Schedule determines the time periods that users are On-Call. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `schedules.write`
- Lua path
app.integrations.pagerduty.delete_schedule- Full name
pagerduty.pagerduty_delete_schedule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_override Write
Delete an override Remove an override. You cannot remove a past override. If the override start time is before the current time, but the end time is after the current time, the override will be truncated to the current time. If the override is truncated, the status code will be 200 OK, as opposed to a 204 No Content for a successful delete. A Schedule determines the time periods that users are On-Call. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `schedules.write`
- Lua path
app.integrations.pagerduty.delete_override- Full name
pagerduty.pagerduty_delete_schedule_override
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_schedule Write
Delete a schedule <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Delete a schedule and all associated rotations and events. If the schedule is referenced by an active escalation policy, the deletion will be rejected.
- Lua path
app.integrations.pagerduty.delete_schedule- Full name
pagerduty.pagerduty_delete_schedule_v3
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_service Write
Delete a service Delete an existing service. Once the service is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this service. A service may represent an application, component, or team you wish to open incidents against. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.delete_service- Full name
pagerduty.pagerduty_delete_service
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_field Write
Delete a Field Delete a Custom Field from Services. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.delete_field- Full name
pagerduty.pagerduty_delete_service_custom_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_field_option Write
Delete a Field Option Delete a field option. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.delete_field_option- Full name
pagerduty.pagerduty_delete_service_custom_field_option
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
disassociate_service_dependencies Write
Disassociate service dependencies Disassociate dependencies between two services. Business services model capabilities that span multiple technical services and that may be owned by several different teams. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#business-services) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.disassociate_service_dependencies- Full name
pagerduty.pagerduty_delete_service_dependency
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_event_rule_from_service Write
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`
- Lua path
app.integrations.pagerduty.delete_event_rule_from_service- Full name
pagerduty.pagerduty_delete_service_event_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
dissociate_trigger_and_service Write
Dissociate a Trigger and Service Remove a an existing Service from an Incident Workflow Trigger Scoped OAuth requires: `incident_workflows.write`
- Lua path
app.integrations.pagerduty.dissociate_trigger_and_service- Full name
pagerduty.pagerduty_delete_service_from_incident_workflow_trigger
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_account_session_configurations Write
Delete an account's session configurations. Deletes the session configurations for a PagerDuty account that was previously set. The type parameter is required and specifies which configurations to delete. A single type ('mobile' or 'web') or comma-separated list may be passed in. Scoped OAuth requires: `session_configurations.write`
- Lua path
app.integrations.pagerduty.delete_account_session_configurations- Full name
pagerduty.pagerduty_delete_session_configurations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_sre_agent_memory Write
Delete an SRE Agent memory Permanently delete an SRE Agent memory. Scoped OAuth requires: `sre_agent.write`
- Lua path
app.integrations.pagerduty.delete_sre_agent_memory- Full name
pagerduty.pagerduty_delete_sre_memory
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_status_post Write
Delete a Status Page Post Delete a Post for a Status Page by Status Page ID and Post ID. Scoped OAuth requires: `status_pages.write`
- Lua path
app.integrations.pagerduty.delete_status_post- Full name
pagerduty.pagerduty_delete_status_page_post
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_status_post_update Write
Delete a Status Page Post Update Delete a Post Update for a Post by Post ID and Post Update ID. Scoped OAuth requires: `status_pages.write`
- Lua path
app.integrations.pagerduty.delete_status_post_update- Full name
pagerduty.pagerduty_delete_status_page_post_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_post_postmortem Write
Delete a Post Postmortem Delete a Postmortem for a Post by Post ID. Scoped OAuth requires: `status_pages.write`
- Lua path
app.integrations.pagerduty.delete_post_postmortem- Full name
pagerduty.pagerduty_delete_status_page_postmortem
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_status_subscription Write
Delete a Status Page Subscription Delete a Subscription for a Status Page by Status Page ID and Subscription ID. Scoped OAuth requires: `status_pages.write`
- Lua path
app.integrations.pagerduty.delete_status_subscription- Full name
pagerduty.pagerduty_delete_status_page_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_tag Write
Delete a tag Remove an existing Tag. A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#tags) Scoped OAuth requires: `tags.write`
- Lua path
app.integrations.pagerduty.delete_tag- Full name
pagerduty.pagerduty_delete_tag
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_team Write
Delete a team Remove an existing team. Succeeds only if the team has no associated Escalation Policies, Services, Schedules and Subteams. All associated unresovled incidents will be reassigned to another team (if specified) or will loose team association, thus becoming account-level (with visibility implications). Note that the incidents reassignment process is asynchronous and has no guarantee to complete before the API call return. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.write`
- Lua path
app.integrations.pagerduty.delete_team- Full name
pagerduty.pagerduty_delete_team
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
remove_escalation_policy_from_team Write
Remove an escalation policy from a team. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.write`
- Lua path
app.integrations.pagerduty.remove_escalation_policy_from_team- Full name
pagerduty.pagerduty_delete_team_escalation_policy
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
remove_user_from_team Write
Remove a user from a team. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.write`
- Lua path
app.integrations.pagerduty.remove_user_from_team- Full name
pagerduty.pagerduty_delete_team_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_template Write
Delete a template Delete a specific of templates on the account Scoped OAuth requires: `templates.write`
- Lua path
app.integrations.pagerduty.delete_template- Full name
pagerduty.pagerduty_delete_template
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_user Write
Delete a user Remove an existing user. Returns 400 if the user has assigned incidents unless your [pricing plan](https://www.pagerduty.com/pricing) has the `offboarding` feature and the account is [configured](https://support.pagerduty.com/docs/offboarding#section-additional-configurations) appropriately. Note that the incidents reassignment process is asynchronous and has no guarantee to complete before the api call return. [*Learn more about `offboarding` feature*](https://support.pagerduty.com/docs/offboarding). Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`
- Lua path
app.integrations.pagerduty.delete_user- Full name
pagerduty.pagerduty_delete_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_user_contact_method Write
Delete a user's contact method Remove a user's contact method. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.write`
- Lua path
app.integrations.pagerduty.delete_user_contact_method- Full name
pagerduty.pagerduty_delete_user_contact_method
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_user_handoff_notification_rule Write
Delete a User's Handoff Notification rule Remove a User's Handoff Notification Rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`
- Lua path
app.integrations.pagerduty.delete_user_handoff_notification_rule- Full name
pagerduty.pagerduty_delete_user_handoff_notification_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_user_notification_rule Write
Delete a user's notification rule Remove a user's notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.write`
- Lua path
app.integrations.pagerduty.delete_user_notification_rule- Full name
pagerduty.pagerduty_delete_user_notification_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_user_session Write
Delete a user's session <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated as OAuth token revocation is now synchronous. Please use the [DELETE /oauth_delegations endpoint](https://developer.pagerduty.com/api-reference/ad1161db75db1-delete-all-o-auth-delegations) instead. Delete a user's session. Beginning November 2021, user sessions no longer includes newly issued OAuth tokens. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:sessions.write`
- Lua path
app.integrations.pagerduty.delete_user_session- Full name
pagerduty.pagerduty_delete_user_session
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_all_user_sessions Write
Delete all user sessions <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated as OAuth token revocation is now synchronous. Please use the [DELETE /oauth_delegations endpoint](https://developer.pagerduty.com/api-reference/ad1161db75db1-delete-all-o-auth-delegations) instead. Delete all user sessions. Beginning November 2021, user sessions no longer includes newly issued OAuth tokens. If you are interested in deleting mobile app sessions, refer to the Delete OAuth Delegations endpoint. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:sessions.write`
- Lua path
app.integrations.pagerduty.delete_all_user_sessions- Full name
pagerduty.pagerduty_delete_user_sessions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_user_status_update_notification_rule Write
Delete a user's status update notification rule Remove a user's status update notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`
- Lua path
app.integrations.pagerduty.delete_user_status_update_notification_rule- Full name
pagerduty.pagerduty_delete_user_status_update_notification_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_webhook_subscription Write
Delete a webhook subscription Deletes a webhook subscription. Scoped OAuth requires: `webhook_subscriptions.write`
- Lua path
app.integrations.pagerduty.delete_webhook_subscription- Full name
pagerduty.pagerduty_delete_webhook_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_workflow_integration_connection Write
Delete Workflow Integration Connection Delete a Workflow Integration Connection. Scoped OAuth requires: `workflow_integrations:connections.write`
- Lua path
app.integrations.pagerduty.delete_workflow_integration_connection- Full name
pagerduty.pagerduty_delete_workflow_integration_connection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
enable_extension Write
Enable an extension that is temporarily disabled. (This API does not require a request body.) Extensions are representations of Extension Schema objects that are attached to Services. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#extensions) Scoped OAuth requires: `extensions.write`
- Lua path
app.integrations.pagerduty.enable_extension- Full name
pagerduty.pagerduty_enable_extension
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
enable_webhook_subscription Write
Enable a webhook subscription that is temporarily disabled. (This API does not require a request body.) Webhook subscriptions can become temporarily disabled when the subscription's delivery method is repeatedly rejected by the server. Scoped OAuth requires: `webhook_subscriptions.write`
- Lua path
app.integrations.pagerduty.enable_webhook_subscription- Full name
pagerduty.pagerduty_enable_webhook_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
test_ability Read
Test an ability Test whether your account has a given ability. "Abilities" describes your account's capabilities by feature name. For example `"teams"`. An ability may be available to your account based on things like your pricing plan or account state. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#abilities) Scoped OAuth requires: `abilities.read`
- Lua path
app.integrations.pagerduty.test_ability- Full name
pagerduty.pagerduty_get_ability
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_add Read
Get an Add-on Get details about an existing Add-on. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#add-ons) Scoped OAuth requires: `addons.read`
- Lua path
app.integrations.pagerduty.get_add- Full name
pagerduty.pagerduty_get_addon
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_alert_grouping_setting Read
Get an Alert Grouping Setting Get an existing Alert Grouping Setting. The settings part of Alert Grouper service allows us to create Alert Grouping Settings and configs that are required to be used during grouping of the alerts. Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.get_alert_grouping_setting- Full name
pagerduty.pagerduty_get_alert_grouping_setting
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_automation_actions Read
List Automation Actions Lists Automation Actions matching provided query params. The returned records are sorted by action name in alphabetical order. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set.
- Lua path
app.integrations.pagerduty.list_automation_actions- Full name
pagerduty.pagerduty_get_all_automation_actions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_raw_responses_from_single_incident Read
Get raw responses from a single incident Provides enriched responder data for a single incident. Example metrics include Time to Respond, Responder Type, and Response Status. See metric definitions below. <!-- theme: info --> > **Note:** 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`
- Lua path
app.integrations.pagerduty.get_raw_responses_from_single_incident- Full name
pagerduty.pagerduty_get_analytics_incident_responses_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_raw_data_multiple_incidents Write
Get raw data - multiple incidents Provides enriched incident data and metrics for multiple incidents. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#incidents-list). <!-- theme: info --> > A `team_ids` or `service_ids` filter is required for [user-level API keys](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or keys generated through an OAuth flow. Account-level API keys do not have this requirement. <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: `analytics.write`
- Lua path
app.integrations.pagerduty.get_raw_data_multiple_incidents- Full name
pagerduty.pagerduty_get_analytics_incidents
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_raw_data_single_incident Read
Get raw data - single incident Provides enriched incident data and metrics for a single incident. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#incidents-list). <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: `analytics.read`
- Lua path
app.integrations.pagerduty.get_raw_data_single_incident- Full name
pagerduty.pagerduty_get_analytics_incidents_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_aggregated_incident_data Write
Get aggregated incident data Provides aggregated enriched metrics for incidents. The provided metrics are aggregated by day, week, month using the aggregate_unit parameter, or for the entire period if no aggregate_unit is provided. <!-- theme: info --> > A `team_ids` or `service_ids` filter is required for [user-level API keys](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or keys generated through an OAuth flow. Account-level API keys do not have this requirement. <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: `analytics.write`
- Lua path
app.integrations.pagerduty.get_aggregated_incident_data- Full name
pagerduty.pagerduty_get_analytics_metrics_incidents_all
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_aggregated_escalation_policy_data Write
Get aggregated escalation policy data Provides aggregated metrics for incidents aggregated into units of time by escalation policy. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#escalation-policy-list). <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: `analytics.write`
- Lua path
app.integrations.pagerduty.get_aggregated_escalation_policy_data- Full name
pagerduty.pagerduty_get_analytics_metrics_incidents_escalation_policy
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_aggregated_metrics_all_escalation_policies Write
Get aggregated metrics for all escalation policies Provides aggregated metrics across all escalation policies. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#escalation-policy-list). <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: `analytics.write`
- Lua path
app.integrations.pagerduty.get_aggregated_metrics_all_escalation_policies- Full name
pagerduty.pagerduty_get_analytics_metrics_incidents_escalation_policy_all
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_aggregated_service_data Write
Get aggregated service data Provides aggregated metrics for incidents aggregated into units of time by service. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#services-list). Data can be aggregated by day, week or month in addition to by service, or provided just as a collection of aggregates for each service in the dataset for the entire period. If a unit is provided, each row in the returned dataset will include a 'range_start' timestamp. <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: `analytics.write`
- Lua path
app.integrations.pagerduty.get_aggregated_service_data- Full name
pagerduty.pagerduty_get_analytics_metrics_incidents_service
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_aggregated_metrics_all_services Write
Get aggregated metrics for all services Provides aggregated metrics across all services. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#services-list). <!-- theme: info --> > A `team_ids` or `service_ids` filter is required for [user-level API keys](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or keys generated through an OAuth flow. Account-level API keys do not have this requirement. <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: `analytics.write`
- Lua path
app.integrations.pagerduty.get_aggregated_metrics_all_services- Full name
pagerduty.pagerduty_get_analytics_metrics_incidents_service_all
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_aggregated_team_data Write
Get aggregated team data Provides aggregated metrics for incidents aggregated into units of time by team. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#teams-list). Data can be aggregated by day, week or month in addition to by team, or provided just as a collection of aggregates for each team in the dataset for the entire period. If a unit is provided, each row in the returned dataset will include a 'range_start' timestamp. <!-- theme: info --> > A `team_ids` or `service_ids` filter is required for [user-level API keys](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or keys generated through an OAuth flow. Account-level API keys do not have this requirement. <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: `analytics.write`
- Lua path
app.integrations.pagerduty.get_aggregated_team_data- Full name
pagerduty.pagerduty_get_analytics_metrics_incidents_team
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_aggregated_metrics_all_teams Write
Get aggregated metrics for all teams Provides aggregated metrics across all teams. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#teams-list). <!-- theme: info --> > A `team_ids` or `service_ids` filter is required for [user-level API keys](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or keys generated through an OAuth flow. Account-level API keys do not have this requirement. <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: `analytics.write`
- Lua path
app.integrations.pagerduty.get_aggregated_metrics_all_teams- Full name
pagerduty.pagerduty_get_analytics_metrics_incidents_team_all
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_aggregated_pd_advance_usage_data Write
Get aggregated PD Advance usage data Provides aggregated metrics for the usage of PD Advance. <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: `analytics.write`
- Lua path
app.integrations.pagerduty.get_aggregated_pd_advance_usage_data- Full name
pagerduty.pagerduty_get_analytics_metrics_pd_advance_usage_features
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_aggregated_metrics_all_responders Write
Get aggregated metrics for all responders Provides aggregated incident metrics for all selected responders. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#responders-list). <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: `analytics.write`
- Lua path
app.integrations.pagerduty.get_aggregated_metrics_all_responders- Full name
pagerduty.pagerduty_get_analytics_metrics_responders_all
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_responder_data_aggregated_by_team Write
Get responder data aggregated by team Provides incident metrics aggregated by responder. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#responders-list). <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: `analytics.write`
- Lua path
app.integrations.pagerduty.get_responder_data_aggregated_by_team- Full name
pagerduty.pagerduty_get_analytics_metrics_responders_team
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_aggregated_metrics_all_users Write
Get aggregated metrics for all users Provides aggregated metrics across all users within their account. This endpoint provides summary statistics about user activity and performance. <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: `analytics.write`
- Lua path
app.integrations.pagerduty.get_aggregated_metrics_all_users- Full name
pagerduty.pagerduty_get_analytics_metrics_users_all
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_raw_incidents_single_responder_id Write
Get raw incidents for a single responder_id Provides enriched incident data and metrics for a specific responder. Example metrics include Mean Seconds to Resolve, Mean Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#incidents-list). <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: `analytics.write`
- Lua path
app.integrations.pagerduty.get_raw_incidents_single_responder_id- Full name
pagerduty.pagerduty_get_analytics_responder_incidents
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_raw_user_analytics_data Write
Get raw user analytics data Allows users to retrieve a raw list of user analytics data within their account. This endpoint provides detailed data about user activity and account configuration. <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It takes up to 24 hours before new user data appears in the Analytics API. Scoped OAuth requires: `analytics.write`
- Lua path
app.integrations.pagerduty.get_raw_user_analytics_data- Full name
pagerduty.pagerduty_get_analytics_users
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_automation_action Read
Get an Automation Action
- Lua path
app.integrations.pagerduty.get_automation_action- Full name
pagerduty.pagerduty_get_automation_action
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_details_automation_action_service_relation Read
Get the details of an Automation Action / service relation Gets the details of a Automation Action / service relation
- Lua path
app.integrations.pagerduty.get_details_automation_action_service_relation- Full name
pagerduty.pagerduty_get_automation_actions_action_service_association
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_all_service_references_associated_with_automation_action Read
Get all service references associated with an Automation Action Gets all service references associated with an Automation Action
- Lua path
app.integrations.pagerduty.get_all_service_references_associated_with_automation_action- Full name
pagerduty.pagerduty_get_automation_actions_action_service_associations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_details_automation_action_team_relation Read
Get the details of an Automation Action / team relation Gets the details of an Automation Action / team relation
- Lua path
app.integrations.pagerduty.get_details_automation_action_team_relation- Full name
pagerduty.pagerduty_get_automation_actions_action_team_association
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_all_team_references_associated_with_automation_action Read
Get all team references associated with an Automation Action Gets all team references associated with an Automation Action
- Lua path
app.integrations.pagerduty.get_all_team_references_associated_with_automation_action- Full name
pagerduty.pagerduty_get_automation_actions_action_team_associations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_invocation Read
Get an Invocation Get an Automation Action Invocation
- Lua path
app.integrations.pagerduty.get_invocation- Full name
pagerduty.pagerduty_get_automation_actions_invocation
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_automation_action_runner Read
Get an Automation Action runner
- Lua path
app.integrations.pagerduty.get_automation_action_runner- Full name
pagerduty.pagerduty_get_automation_actions_runner
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_details_runner_team_relation Read
Get the details of a runner / team relation Gets the details of a runner / team relation
- Lua path
app.integrations.pagerduty.get_details_runner_team_relation- Full name
pagerduty.pagerduty_get_automation_actions_runner_team_association
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_all_team_references_associated_with_runner Read
Get all team references associated with a runner Gets all team references associated with a runner
- Lua path
app.integrations.pagerduty.get_all_team_references_associated_with_runner- Full name
pagerduty.pagerduty_get_automation_actions_runner_team_associations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_automation_action_runners Read
List Automation Action runners Lists Automation Action runners matching provided query params. The returned records are sorted by runner name in alphabetical order. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set.
- Lua path
app.integrations.pagerduty.list_automation_action_runners- Full name
pagerduty.pagerduty_get_automation_actions_runners
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_business_service Read
Get a Business Service Get details about an existing Business Service. Business services model capabilities that span multiple technical services and that may be owned by several different teams. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#business-services) Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.get_business_service- Full name
pagerduty.pagerduty_get_business_service
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_business_services_sorted_by_impacted_status Read
List Business Services sorted by impacted status Retrieve a list top-level Business Services sorted by highest Impact with `status` included. When called without the `ids[]` parameter, this endpoint does not return an exhaustive list of Business Services but rather provides access to the most impacted up to the limit of 200. The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name. To get impact information about a specific set of Business Services, use the `ids[]` parameter. Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.list_business_services_sorted_by_impacted_status- Full name
pagerduty.pagerduty_get_business_service_impacts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_global_priority_threshold_business_service_be_considered_impacted_by_incident Read
Get the global priority threshold for a Business Service to be considered impacted by an Incident Retrieves the priority threshold information for an account. Currently, there is a `global_threshold` that can be set for the account. Incidents that have a priority meeting or exceeding this threshold will be considered impacting on any Business Service that depends on the Service to which the Incident belongs. Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.get_global_priority_threshold_business_service_be_considered_impacted_by_incident- Full name
pagerduty.pagerduty_get_business_service_priority_thresholds
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_business_service_dependencies Read
Get Business Service dependencies Get all immediate dependencies of any Business Service. Business Services model capabilities that span multiple technical services and that may be owned by several different teams. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#business-services) Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.get_business_service_dependencies- Full name
pagerduty.pagerduty_get_business_service_service_dependencies
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_business_service_subscribers Read
List Business Service Subscribers Retrieve a list of Notification Subscribers on the Business Service. <!-- theme: warning --> > Users must be added through `POST /business_services/{id}/subscribers` to be returned from this endpoint. Scoped OAuth requires: `subscribers.read`
- Lua path
app.integrations.pagerduty.list_business_service_subscribers- Full name
pagerduty.pagerduty_get_business_service_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_supporting_business_services_given_business_service_id_sorted_by_impacted_status Read
List the supporting Business Services for the given Business Service Id, sorted by impacted status. Retrieve of Business Services that support the given Business Service sorted by highest Impact with `status` included. This endpoint does not return an exhaustive list of Business Services but rather provides access to the most impacted up to the limit of 200. The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name. To get impact information about a specific set of Business Services, use the `ids[]` parameter on the `/business_services/impacts` endpoint. Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.list_supporting_business_services_given_business_service_id_sorted_by_impacted_status- Full name
pagerduty.pagerduty_get_business_service_supporting_service_impacts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_impactors_affecting_business_services Read
List Impactors affecting Business Services Retrieve a list of Impactors for the top-level Business Services on the account. Impactors are currently limited to Incidents. This endpoint does not return an exhaustive list of Impactors but rather provides access to the highest priority Impactors for the Business Services in question up to the limit of 200. To get Impactors for a specific set of Business Services, use the `ids[]` parameter. The returned Impactors are sorted first by priority and secondarily by their creation date. Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.list_impactors_affecting_business_services- Full name
pagerduty.pagerduty_get_business_service_top_level_impactors
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_cache_variable_global_event_orchestration Read
Get a Cache Variable for a Global Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`
- Lua path
app.integrations.pagerduty.get_cache_variable_global_event_orchestration- Full name
pagerduty.pagerduty_get_cache_var_on_global_orch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_cache_variable_service_event_orchestration Read
Get a Cache Variable for a Service Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.get_cache_variable_service_event_orchestration- Full name
pagerduty.pagerduty_get_cache_var_on_service_orch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_change_event Read
Get a Change Event Get details about an existing Change Event. Scoped OAuth requires: `change_events.read`
- Lua path
app.integrations.pagerduty.get_change_event- Full name
pagerduty.pagerduty_get_change_event
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_current_user Read
Get the current user Get details about the current user. This endpoint can only be used with a [user-level API key](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or a key generated through an OAuth flow. This will not work if the request is made with an account-level access token. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users)
- Lua path
app.integrations.pagerduty.get_current_user- Full name
pagerduty.pagerduty_get_current_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_field Read
Get a Field <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields/{field_id}](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields~1{field_id}/get) Show detailed information about a Custom Field on the Base Incident Type. Scoped OAuth requires: `custom_fields.read`
- Lua path
app.integrations.pagerduty.get_field- Full name
pagerduty.pagerduty_get_custom_fields_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_custom_shift Read
Get a custom shift <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve a single custom shift by ID.
- Lua path
app.integrations.pagerduty.get_custom_shift- Full name
pagerduty.pagerduty_get_custom_shift
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_tags_entities Read
Get tags for entities Get related tags for Users, Teams or Escalation Policies. A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#tags) Scoped OAuth requires: `tags.read`
- Lua path
app.integrations.pagerduty.get_tags_entities- Full name
pagerduty.pagerduty_get_entity_type_by_id_tags
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_escalation_policy Read
Get an escalation policy Get information about an existing escalation policy and its rules. Escalation policies define which user should be alerted at which time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#escalation-policies) Scoped OAuth requires: `escalation_policies.read`
- Lua path
app.integrations.pagerduty.get_escalation_policy- Full name
pagerduty.pagerduty_get_escalation_policy
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_event Read
Get an event <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve a specific event by ID.
- Lua path
app.integrations.pagerduty.get_event- Full name
pagerduty.pagerduty_get_event
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_extension Read
Get an extension Get details about an existing extension. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#extensions) Scoped OAuth requires: `extensions.read`
- Lua path
app.integrations.pagerduty.get_extension- Full name
pagerduty.pagerduty_get_extension
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_extension_vendor Read
Get an extension vendor Get details about one specific extension vendor. A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#extension-schemas) Scoped OAuth requires: `extension_schemas.read`
- Lua path
app.integrations.pagerduty.get_extension_vendor- Full name
pagerduty.pagerduty_get_extension_schema
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_data_external_data_cache_variable_global_event_orchestration Read
Get Data for an External Data Cache Variable on a Global Event Orchestration Get the data for an `external_data` type Cache Variable on a Global Orchestration. Use External Data type Cache Variables to store string, number, or boolean values via a dedicated API endpoint. These stored values can then be used in conditions or actions in Event Orchestration rules. For more information see the [Knowledge Base](https://support.pagerduty.com/main/docs/event-orchestration-cache-variables) Scoped OAuth requires: `event_orchestrations.read`
- Lua path
app.integrations.pagerduty.get_data_external_data_cache_variable_global_event_orchestration- Full name
pagerduty.pagerduty_get_external_data_cache_var_data_on_global_orch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_data_external_data_cache_variable_service_event_orchestration Read
Get Data for an External Data Cache Variable on a Service Event Orchestration Get the data for an `external_data` type Cache Variable for a Service Event Orchestration. Use External Data type Cache Variables to store string, number, or boolean values via a dedicated API endpoint. These stored values can then be used in conditions or actions in Event Orchestration rules. For more information see the [Knowledge Base](https://support.pagerduty.com/main/docs/event-orchestration-cache-variables) Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.get_data_external_data_cache_variable_service_event_orchestration- Full name
pagerduty.pagerduty_get_external_data_cache_var_data_on_service_orch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_incident Read
Get an incident Show detailed information about an incident. Accepts either an incident id, or an incident number. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.read`
- Lua path
app.integrations.pagerduty.get_incident- Full name
pagerduty.pagerduty_get_incident
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_alert Read
Get an alert Show detailed information about an alert. Accepts an alert id. An incident represents a problem or an issue that needs to be addressed and resolved. When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.read`
- Lua path
app.integrations.pagerduty.get_alert- Full name
pagerduty.pagerduty_get_incident_alert
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_custom_field_values Read
Get Custom Field Values Get custom field values for an incident. <!-- theme: warning --> Scoped OAuth requires: `incidents.read`
- Lua path
app.integrations.pagerduty.get_custom_field_values- Full name
pagerduty.pagerduty_get_incident_field_values
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_business_services_impacted_by_given_incident Read
List Business Services impacted by the given Incident Retrieve a list of Business Services that are being impacted by the given Incident. Scoped OAuth requires: `incidents.read`
- Lua path
app.integrations.pagerduty.list_business_services_impacted_by_given_incident- Full name
pagerduty.pagerduty_get_incident_impacted_business_services
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_notification_subscribers Read
List Notification Subscribers Retrieve a list of Notification Subscribers on the Incident. <!-- theme: warning --> > Users must be added through `POST /incident/{id}/status_updates/subscribers` to be returned from this endpoint. Scoped OAuth requires: `subscribers.read`
- Lua path
app.integrations.pagerduty.list_notification_subscribers- Full name
pagerduty.pagerduty_get_incident_notification_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_incident_type Read
Get an Incident Type Get detailed information about a single incident type. Accepts either an incident type id, or an incident type name. Incident Types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incident) Scoped OAuth requires: `incident_types.read`
- Lua path
app.integrations.pagerduty.get_incident_type- Full name
pagerduty.pagerduty_get_incident_type
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_incident_type_custom_field Read
Get an Incident Type Custom Field Get a custom field for an incident type. Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types. Scoped OAuth requires: `custom_fields.read`
- Lua path
app.integrations.pagerduty.get_incident_type_custom_field- Full name
pagerduty.pagerduty_get_incident_type_custom_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_field_option_custom_field Read
Get a Field Option on a Custom Field Get a field option on a custom field Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types. Scoped OAuth requires: `custom_fields.read`
- Lua path
app.integrations.pagerduty.get_field_option_custom_field- Full name
pagerduty.pagerduty_get_incident_type_custom_field_field_options
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_incident_workflow Read
Get an Incident Workflow Get an existing Incident Workflow An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. Scoped OAuth requires: `incident_workflows.read`
- Lua path
app.integrations.pagerduty.get_incident_workflow- Full name
pagerduty.pagerduty_get_incident_workflow
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_action Read
Get an Action Get an Incident Workflow Action Scoped OAuth requires: `incident_workflows.read`
- Lua path
app.integrations.pagerduty.get_action- Full name
pagerduty.pagerduty_get_incident_workflow_action
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_trigger Read
Get a Trigger Retrieve an existing Incident Workflows Trigger Scoped OAuth requires: `incident_workflows.read`
- Lua path
app.integrations.pagerduty.get_trigger- Full name
pagerduty.pagerduty_get_incident_workflow_trigger
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_log_entry Read
Get a log entry Get details for a specific incident log entry. This method provides additional information you can use to get at raw event data. A log of all the events that happen to an Incident, and these are exposed as Log Entries. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#log-entries) Scoped OAuth requires: `incidents.read`
- Lua path
app.integrations.pagerduty.get_log_entry- Full name
pagerduty.pagerduty_get_log_entry
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_maintenance_window Read
Get a maintenance window Get an existing maintenance window. A Maintenance Window is used to temporarily disable one or more Services for a set period of time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#maintenance-windows) Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.get_maintenance_window- Full name
pagerduty.pagerduty_get_maintenance_window
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_oauth_client Read
Get an OAuth client Get details of a specific OAuth client by ID. Requires admin or owner role permissions.
- Lua path
app.integrations.pagerduty.get_oauth_client- Full name
pagerduty.pagerduty_get_oauth_client
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_oauth_delegations_revocation_requests_status Read
Get OAuth delegations revocation requests status <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated as OAuth token revocation is now synchronous. Please use the [DELETE /oauth_delegations endpoint](https://developer.pagerduty.com/api-reference/ad1161db75db1-delete-all-o-auth-delegations) instead. Get the status of all OAuth delegations revocation requests for this account, specifically how many requests are still pending. As all requests are now synchronous, no pending requests will be found. This endpoint is limited to account owners and admins. Scoped OAuth requires: `oauth_delegations.read`
- Lua path
app.integrations.pagerduty.get_oauth_delegations_revocation_requests_status- Full name
pagerduty.pagerduty_get_oauth_delegations_revocation_requests_status
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_service_orchestration_active_status_service Read
Get the Service Orchestration active status for a Service Get a Service Orchestration's active status. A Service Orchestration allows you to set an active status based on whether an event will be evaluated against a service orchestration path (true) or service ruleset (false). For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.get_service_orchestration_active_status_service- Full name
pagerduty.pagerduty_get_orch_active_status
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_global_orchestration_event_orchestration Read
Get the Global Orchestration for an Event Orchestration. Global Orchestration Rules allows you to create a set of Event Rules. These rules evaluate against all Events sent to an Event Orchestration. When a matching rule is found, it can modify and enhance the event and can route the event to another set of Global Rules within this Orchestration for further processing. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`
- Lua path
app.integrations.pagerduty.get_global_orchestration_event_orchestration- Full name
pagerduty.pagerduty_get_orch_path_global
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_router_event_orchestration Read
Get the Router for an Event Orchestration Get a Global Orchestration's Routing Rules. An Orchestration Router allows you to create a set of Event Rules. The Router evaluates Events you send to this Global Orchestration against each of its rules, one at a time, and routes the event to a specific Service based on the first rule that matches. If an event doesn't match any rules, it'll be sent to service specified in as the `catch_all` or the "Unrouted" Orchestration if no service is specified. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`
- Lua path
app.integrations.pagerduty.get_router_event_orchestration- Full name
pagerduty.pagerduty_get_orch_path_router
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_service_orchestration_service Read
Get the Service Orchestration for a Service Get a Service Orchestration. A Service Orchestration allows you to create a set of Event Rules. The Service Orchestration evaluates Events sent to this Service against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Service Orchestration for further processing. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.get_service_orchestration_service- Full name
pagerduty.pagerduty_get_orch_path_service
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_unrouted_orchestration_event_orchestration Read
Get the Unrouted Orchestration for an Event Orchestration Get a Global Event Orchestration's Rules for Unrouted events. An Unrouted Orchestration allows you to create a set of Event Rules that will be evaluated against all events that don't match any rules in the Global Orchestration's Router. Events that reach the Unrouted Orchestration will never be routed to a specific Service. The Unrouted Orchestration evaluates Events sent to it against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Unrouted Orchestration for further processing. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`
- Lua path
app.integrations.pagerduty.get_unrouted_orchestration_event_orchestration- Full name
pagerduty.pagerduty_get_orch_path_unrouted
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_orchestration Read
Get an Orchestration Get a Global Event Orchestration. Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`
- Lua path
app.integrations.pagerduty.get_orchestration- Full name
pagerduty.pagerduty_get_orchestration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_integration_event_orchestration Read
Get an Integration for an Event Orchestration Get an Integration associated with this Event Orchestrations. You can use the Routing Key from this Integration to send events to PagerDuty! For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`
- Lua path
app.integrations.pagerduty.get_integration_event_orchestration- Full name
pagerduty.pagerduty_get_orchestration_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_outlier_incident Read
Get Outlier Incident Gets Outlier Incident information for a given Incident on its Service. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#outlier-incident) Scoped OAuth requires: `incidents.read`
- Lua path
app.integrations.pagerduty.get_outlier_incident- Full name
pagerduty.pagerduty_get_outlier_incident
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_override Read
Get an override <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve a single override by ID.
- Lua path
app.integrations.pagerduty.get_override- Full name
pagerduty.pagerduty_get_override
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_past_incidents Read
Get Past Incidents Past Incidents returns Incidents within the past 6 months that have similar metadata and were generated on the same Service as the parent Incident. By default, 5 Past Incidents are returned. Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#past_incidents) Scoped OAuth requires: `incidents.read`
- Lua path
app.integrations.pagerduty.get_past_incidents- Full name
pagerduty.pagerduty_get_past_incidents
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_paused_incident_reporting_alerts Read
Get Paused Incident Reporting on Alerts Returns the 5 most recent alerts that were triggered after being paused and the 5 most recent alerts that were resolved after being paused for a given reporting period (maximum 6 months lookback period). Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#paused-incident-reports) Scoped OAuth requires: `incidents.read`
- Lua path
app.integrations.pagerduty.get_paused_incident_reporting_alerts- Full name
pagerduty.pagerduty_get_paused_incident_report_alerts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_paused_incident_reporting_counts Read
Get Paused Incident Reporting counts Returns reporting counts for paused Incident usage for a given reporting period (maximum 6 months lookback period). Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#paused-incident-reports) Scoped OAuth requires: `incidents.read`
- Lua path
app.integrations.pagerduty.get_paused_incident_reporting_counts- Full name
pagerduty.pagerduty_get_paused_incident_report_counts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_status_post_update Read
Get a Status Page Post Update Get a Post Update for a Post by Post ID and Post Update ID. Scoped OAuth requires: `status_pages.read`
- Lua path
app.integrations.pagerduty.get_status_post_update- Full name
pagerduty.pagerduty_get_post_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_post_postmortem Read
Get a Post Postmortem Get a Postmortem for a Post by Post ID. Scoped OAuth requires: `status_pages.read`
- Lua path
app.integrations.pagerduty.get_post_postmortem- Full name
pagerduty.pagerduty_get_postmortem
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_rotation Read
Get a rotation <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve a rotation by ID including all its events.
- Lua path
app.integrations.pagerduty.get_rotation- Full name
pagerduty.pagerduty_get_rotation
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_ruleset Read
Get a Ruleset. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Scoped OAuth requires: `event_rules.read`
- Lua path
app.integrations.pagerduty.get_ruleset- Full name
pagerduty.pagerduty_get_ruleset
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_event_rule Read
Get an Event Rule. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead. Scoped OAuth requires: `event_rules.read`
- Lua path
app.integrations.pagerduty.get_event_rule- Full name
pagerduty.pagerduty_get_ruleset_event_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_schedule Read
Get a schedule Show detailed information about a schedule, including entries for each layer. Scoped OAuth requires: `schedules.read`
- Lua path
app.integrations.pagerduty.get_schedule- Full name
pagerduty.pagerduty_get_schedule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_schedule Read
Get a schedule <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve a schedule by ID including rotations and events. Optionally include the computed final schedule for a time range. Use `include[]=final_schedule` to get computed on-call assignments. Use `since` and `until` to specify the time range.
- Lua path
app.integrations.pagerduty.get_schedule- Full name
pagerduty.pagerduty_get_schedule_v3
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_service Read
Get a service Get details about an existing service. A service may represent an application, component, or team you wish to open incidents against. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.get_service- Full name
pagerduty.pagerduty_get_service
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_field Read
Get a Field Show detailed information about a Custom Field for Services. Scoped OAuth requires: `custom_fields.read`
- Lua path
app.integrations.pagerduty.get_field- Full name
pagerduty.pagerduty_get_service_custom_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_field_option Read
Get a Field Option Get a field option for a given field. Scoped OAuth requires: `custom_fields.read`
- Lua path
app.integrations.pagerduty.get_field_option- Full name
pagerduty.pagerduty_get_service_custom_field_option
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_custom_field_values Read
Get Custom Field Values Get custom field values for a service. Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.get_custom_field_values- Full name
pagerduty.pagerduty_get_service_custom_field_values
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_event_rule_from_service Read
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`
- Lua path
app.integrations.pagerduty.get_event_rule_from_service- Full name
pagerduty.pagerduty_get_service_event_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
view_integration Read
View an integration Get details about an integration belonging to a service. A service may represent an application, component, or team you wish to open incidents against. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.view_integration- Full name
pagerduty.pagerduty_get_service_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_account_session_configurations Read
Get an account's session configurations Retrieves session configurations for a PagerDuty account. Returns an array containing the requested configurations. If a specific type is requested, the array contains one item. If no type is specified, the array contains all available configurations (mobile and web). If no configurations exist, a 404 Not Found error will be returned. A Session Configuration needs to be created before it can be retrieved and used. Scoped OAuth requires: `session_configurations.read`
- Lua path
app.integrations.pagerduty.get_account_session_configurations- Full name
pagerduty.pagerduty_get_session_configurations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_single_status_dashboard_by_id Read
Get a single Status Dashboard by `id` Get a Status Dashboard by its PagerDuty `id`. Scoped OAuth requires: `status_dashboards.read`
- Lua path
app.integrations.pagerduty.get_single_status_dashboard_by_id- Full name
pagerduty.pagerduty_get_status_dashboard_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_single_status_dashboard_by_url_slug Read
Get a single Status Dashboard by `url_slug` Get a Status Dashboard by its PagerDuty `url_slug`. A `url_slug` is a human-readable reference for a custom Status Dashboard that may be created or changed in the UI. It will generally be a `dash-separated-string-like-this`. Scoped OAuth requires: `status_dashboards.read`
- Lua path
app.integrations.pagerduty.get_single_status_dashboard_by_url_slug- Full name
pagerduty.pagerduty_get_status_dashboard_by_url_slug
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_impacted_business_services_status_dashboard_by_id Read
Get impacted Business Services for a Status Dashboard by `id`. Get impacted Business Services for a Status Dashboard by `id` This endpoint does not return an exhaustive list of Business Services but rather provides access to the most impacted on the specified Status Dashboard up to the limit of 200. The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name. To get Impact information about a specific Business Service on the Status Dashboard that does not appear in the Impact-sorted response, use the `ids[]` parameter on the `/business_services/impacts` endpoint. Scoped OAuth requires: `status_dashboards.read`
- Lua path
app.integrations.pagerduty.get_impacted_business_services_status_dashboard_by_id- Full name
pagerduty.pagerduty_get_status_dashboard_service_impacts_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_impacted_business_services_status_dashboard_by_url_slug Read
Get impacted Business Services for a Status Dashboard by `url_slug` Get Business Service Impacts for the Business Services on a Status Dashboard by its `url_slug`. A `url_slug` is a human-readable reference for a custom Status Dashboard that may be created or changed in the UI. It will generally be a `dash-separated-string-like-this`. This endpoint does not return an exhaustive list of Business Services but rather provides access to the most impacted on the Status Dashboard up to the limit of 200. The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name. To get impact information about a specific Business Service on the Status Dashboard that does not appear in the Impact-sored response, use the `ids[]` parameter on the `/business_services/impacts` endpoint. Scoped OAuth requires: `status_dashboards.read`
- Lua path
app.integrations.pagerduty.get_impacted_business_services_status_dashboard_by_url_slug- Full name
pagerduty.pagerduty_get_status_dashboard_service_impacts_by_url_slug
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_status_impact Read
Get a Status Page Impact Get an Impact for a Status Page by Status Page ID and Impact ID. Scoped OAuth requires: `status_pages.read`
- Lua path
app.integrations.pagerduty.get_status_impact- Full name
pagerduty.pagerduty_get_status_page_impact
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_status_post Read
Get a Status Page Post Get a Post for a Status Page by Status Page ID and Post ID. Scoped OAuth requires: `status_pages.read`
- Lua path
app.integrations.pagerduty.get_status_post- Full name
pagerduty.pagerduty_get_status_page_post
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_status_service Read
Get a Status Page Service Get a Service for a Status Page by Status Page ID and Service ID. Scoped OAuth requires: `status_pages.read`
- Lua path
app.integrations.pagerduty.get_status_service- Full name
pagerduty.pagerduty_get_status_page_service
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_status_severity Read
Get a Status Page Severity Get a Severity for a Status Page by Status Page ID and Severity ID. Scoped OAuth requires: `status_pages.read`
- Lua path
app.integrations.pagerduty.get_status_severity- Full name
pagerduty.pagerduty_get_status_page_severity
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_status_status Read
Get a Status Page Status Get a Status for a Status Page by Status Page ID and Status ID. Scoped OAuth requires: `status_pages.read`
- Lua path
app.integrations.pagerduty.get_status_status- Full name
pagerduty.pagerduty_get_status_page_status
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_status_subscription Read
Get a Status Page Subscription Get a Subscription for a Status Page by Status Page ID and Subscription ID. Scoped OAuth requires: `status_pages.read`
- Lua path
app.integrations.pagerduty.get_status_subscription- Full name
pagerduty.pagerduty_get_status_page_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_tag Read
Get a tag Get details about an existing Tag. A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#tags) Scoped OAuth requires: `tags.read`
- Lua path
app.integrations.pagerduty.get_tag- Full name
pagerduty.pagerduty_get_tag
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_connected_entities Read
Get connected entities Get related Users, Teams or Escalation Policies for the Tag. A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#tags) Scoped OAuth requires: `tags.read`
- Lua path
app.integrations.pagerduty.get_connected_entities- Full name
pagerduty.pagerduty_get_tags_by_entity_type
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_team Read
Get a team Get details about an existing team. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.read`
- Lua path
app.integrations.pagerduty.get_team- Full name
pagerduty.pagerduty_get_team
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_team_notification_subscriptions Read
List Team Notification Subscriptions Retrieve a list of Notification Subscriptions the given Team has. <!-- theme: warning --> > Teams must be added through `POST /teams/{id}/notification_subscriptions` to be returned from this endpoint. Scoped OAuth requires: `subscribers.read`
- Lua path
app.integrations.pagerduty.list_team_notification_subscriptions- Full name
pagerduty.pagerduty_get_team_notification_subscriptions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_technical_service_dependencies Read
Get technical service dependencies Get all immediate dependencies of any technical service. Technical services are also known as `services`. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.get_technical_service_dependencies- Full name
pagerduty.pagerduty_get_technical_service_service_dependencies
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_template Read
Get a template Get a single template on the account Scoped OAuth requires: `templates.read`
- Lua path
app.integrations.pagerduty.get_template- Full name
pagerduty.pagerduty_get_template
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_template_fields Read
List template fields Get a list of fields that can be used on the account templates. Scoped OAuth requires: `templates.read`
- Lua path
app.integrations.pagerduty.list_template_fields- Full name
pagerduty.pagerduty_get_template_fields
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_templates Read
List templates Get a list of all the template on an account Scoped OAuth requires: `templates.read`
- Lua path
app.integrations.pagerduty.list_templates- Full name
pagerduty.pagerduty_get_templates
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_user Read
Get a user Get details about an existing user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.read`
- Lua path
app.integrations.pagerduty.get_user- Full name
pagerduty.pagerduty_get_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_user_contact_method Read
Get a user's contact method Get details about a User's contact method. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.read`
- Lua path
app.integrations.pagerduty.get_user_contact_method- Full name
pagerduty.pagerduty_get_user_contact_method
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_user_contact_methods Read
List a user's contact methods List contact methods of your PagerDuty user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.read`
- Lua path
app.integrations.pagerduty.list_user_contact_methods- Full name
pagerduty.pagerduty_get_user_contact_methods
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_user_delegation Read
Get a user's delegation Get details about a specific OAuth delegation. This endpoint replaces the deprecated `/users/{id}/sessions/{session_id}` endpoint. **Required OAuth Scope:** For Scoped OAuth requests, this operation requires the `oauth_delegations.read` scope. Scoped OAuth requires: `oauth_delegations.read`
- Lua path
app.integrations.pagerduty.get_user_delegation- Full name
pagerduty.pagerduty_get_user_delegation
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_user_handoff_notification_rule Read
Get a user's handoff notification rule Get details about a User's Handoff Notification Rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.read`
- Lua path
app.integrations.pagerduty.get_user_handoff_notification_rule- Full name
pagerduty.pagerduty_get_user_handoff_notifiaction_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_user_handoff_notification_rules Read
List a User's Handoff Notification Rules List Handoff Notification Rules of your PagerDuty User. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.read`
- Lua path
app.integrations.pagerduty.list_user_handoff_notification_rules- Full name
pagerduty.pagerduty_get_user_handoff_notification_rules
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_license_allocated_user Read
Get the License allocated to a User Scoped OAuth requires: `licenses.read`
- Lua path
app.integrations.pagerduty.get_license_allocated_user- Full name
pagerduty.pagerduty_get_user_license
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_user_notification_rule Read
Get a user's notification rule Get details about a user's notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.read`
- Lua path
app.integrations.pagerduty.get_user_notification_rule- Full name
pagerduty.pagerduty_get_user_notification_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_user_notification_rules Read
List a user's notification rules List notification rules of your PagerDuty user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.read`
- Lua path
app.integrations.pagerduty.list_user_notification_rules- Full name
pagerduty.pagerduty_get_user_notification_rules
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_notification_subscriptions Read
List Notification Subscriptions Retrieve a list of Notification Subscriptions the given User has. <!-- theme: warning --> > Users must be added through `POST /users/{id}/notification_subscriptions` to be returned from this endpoint. Scoped OAuth requires: `subscribers.read`
- Lua path
app.integrations.pagerduty.list_notification_subscriptions- Full name
pagerduty.pagerduty_get_user_notification_subscriptions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_user_session Read
Get a user's session <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated, please use the [Get OAuth Delegation endpoint](https://developer.pagerduty.com/api-reference//e3c7cd550aa2b-get-a-user-oauth-delegation) instead. Get details about a user's session. Beginning November 2021, user sessions no longer includes newly issued OAuth tokens. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:sessions.read`
- Lua path
app.integrations.pagerduty.get_user_session- Full name
pagerduty.pagerduty_get_user_session
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_user_active_sessions Read
List a user's active sessions <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated, please use the [List OAuth Delegations endpoint](https://developer.pagerduty.com/api-reference/fc03ba9dffd1f-list-user-oauth-delegations) instead. List active sessions of a PagerDuty user. Beginning November 2021, active sessions no longer includes newly issued OAuth tokens. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:sessions.read`
- Lua path
app.integrations.pagerduty.list_user_active_sessions- Full name
pagerduty.pagerduty_get_user_sessions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_user_status_update_notification_rule Read
Get a user's status update notification rule Get details about a user's status update notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.read`
- Lua path
app.integrations.pagerduty.get_user_status_update_notification_rule- Full name
pagerduty.pagerduty_get_user_status_update_notification_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_user_status_update_notification_rules Read
List a user's status update notification rules List status update notification rules of your PagerDuty user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.read`
- Lua path
app.integrations.pagerduty.list_user_status_update_notification_rules- Full name
pagerduty.pagerduty_get_user_status_update_notification_rules
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_vendor Read
Get a vendor Get details about one specific vendor. A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#vendors) Scoped OAuth requires: `vendors.read`
- Lua path
app.integrations.pagerduty.get_vendor- Full name
pagerduty.pagerduty_get_vendor
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_webhook_subscription Read
Get a webhook subscription Gets details about an existing webhook subscription. Scoped OAuth requires: `webhook_subscriptions.read`
- Lua path
app.integrations.pagerduty.get_webhook_subscription- Full name
pagerduty.pagerduty_get_webhook_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_workflow_integration Read
Get Workflow Integration Get details about a Workflow Integration. Scoped OAuth requires: `workflow_integrations.read`
- Lua path
app.integrations.pagerduty.get_workflow_integration- Full name
pagerduty.pagerduty_get_workflow_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_workflow_integration_connection Read
Get Workflow Integration Connection Get details about a Workflow Integration Connection. Scoped OAuth requires: `workflow_integrations:connections.read`
- Lua path
app.integrations.pagerduty.get_workflow_integration_connection- Full name
pagerduty.pagerduty_get_workflow_integration_connection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_abilities Read
List abilities List all of your account's abilities, by name. "Abilities" describes your account's capabilities by feature name. For example `"teams"`. An ability may be available to your account based on things like your pricing plan or account state. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#abilities) Scoped OAuth requires: `abilities.read`
- Lua path
app.integrations.pagerduty.list_abilities- Full name
pagerduty.pagerduty_list_abilities
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_installed_add_ons Read
List installed Add-ons List all of the Add-ons installed on your account. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#add-ons) Scoped OAuth requires: `addons.read`
- Lua path
app.integrations.pagerduty.list_installed_add_ons- Full name
pagerduty.pagerduty_list_addon
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_alert_grouping_settings Read
List alert grouping settings List all of your alert grouping settings including both single service settings and global content based settings. The settings part of Alert Grouper service allows us to create Alert Grouping Settings and configs that are required to be used during grouping of the alerts. Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.list_alert_grouping_settings- Full name
pagerduty.pagerduty_list_alert_grouping_settings
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_audit_records Read
List audit records List audit trail records matching provided query params or default criteria. The returned records are sorted by the `execution_time` from newest to oldest. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set. Only admins, account owners, or global API tokens on PagerDuty account [pricing plans](https://www.pagerduty.com/pricing) with the "Audit Trail" feature can access this endpoint. For other role based access to audit records by resource ID, see the resource's API documentation. For more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/). Scoped OAuth requires: `audit_records.read`
- Lua path
app.integrations.pagerduty.list_audit_records- Full name
pagerduty.pagerduty_list_audit_records
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_invocations Read
List Invocations
- Lua path
app.integrations.pagerduty.list_invocations- Full name
pagerduty.pagerduty_list_automation_action_invocations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_business_services Read
List Business Services List existing Business Services. Business services model capabilities that span multiple technical services and that may be owned by several different teams. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#business-services) Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.list_business_services- Full name
pagerduty.pagerduty_list_business_services
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_cache_variables_global_event_orchestration Read
List Cache Variables for a Global Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`
- Lua path
app.integrations.pagerduty.list_cache_variables_global_event_orchestration- Full name
pagerduty.pagerduty_list_cache_var_on_global_orch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_cache_variables_service_event_orchestration Read
List Cache Variables for a Service Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.list_cache_variables_service_event_orchestration- Full name
pagerduty.pagerduty_list_cache_var_on_service_orch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_change_events Read
List Change Events List all of the existing Change Events. Scoped OAuth requires: `change_events.read`
- Lua path
app.integrations.pagerduty.list_change_events- Full name
pagerduty.pagerduty_list_change_events
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_field_options Read
List Field Options <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields/{field_id}/field_options](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields~1{field_id}~1field_options/get) List all enabled Field Options for a Custom Field on the Base Incident Type. Scoped OAuth requires: `custom_fields.read`
- Lua path
app.integrations.pagerduty.list_field_options- Full name
pagerduty.pagerduty_list_custom_fields_field_options
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_fields Read
List Fields <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields/get) List Custom Fields on the Base Incident Type. Scoped OAuth requires: `custom_fields.read`
- Lua path
app.integrations.pagerduty.list_fields- Full name
pagerduty.pagerduty_list_custom_fields_fields
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_custom_shifts Read
List custom shifts <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve custom shifts for a schedule within a time range. **`since` and `until` are required.**
- Lua path
app.integrations.pagerduty.list_custom_shifts- Full name
pagerduty.pagerduty_list_custom_shifts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_escalation_policies Read
List escalation policies List all of the existing escalation policies. Escalation policies define which user should be alerted at which time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#escalation-policies) Scoped OAuth requires: `escalation_policies.read`
- Lua path
app.integrations.pagerduty.list_escalation_policies- Full name
pagerduty.pagerduty_list_escalation_policies
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_audit_records_escalation_policy Read
List audit records for an escalation policy The returned records are sorted by the `execution_time` from newest to oldest. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set. For more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/). Scoped OAuth requires: `audit_records.read`
- Lua path
app.integrations.pagerduty.list_audit_records_escalation_policy- Full name
pagerduty.pagerduty_list_escalation_policy_audit_records
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_enablements_event_orchestration Read
List Enablements for an Event Orchestration List all feature enablement settings for an Event Orchestration. Currently, only the `aiops` enablement is supported. For any account with the AIOps product addon, every Event Orchestration will have AIOps features enabled by default. **Warning conditions**: - If the account is not entitled to use AIOps features, a warning will be returned alongside the enablement data. Scoped OAuth requires: `event_orchestrations.read`
- Lua path
app.integrations.pagerduty.list_enablements_event_orchestration- Full name
pagerduty.pagerduty_list_event_orchestration_feature_enablements
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_event_orchestrations Read
List Event Orchestrations List all Global Event Orchestrations on an Account. Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`
- Lua path
app.integrations.pagerduty.list_event_orchestrations- Full name
pagerduty.pagerduty_list_event_orchestrations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_events Read
List events <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve all events for a rotation, ordered by start time.
- Lua path
app.integrations.pagerduty.list_events- Full name
pagerduty.pagerduty_list_events
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_extension_schemas Read
List extension schemas List all extension schemas. A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#extension-schemas) Scoped OAuth requires: `extension_schemas.read`
- Lua path
app.integrations.pagerduty.list_extension_schemas- Full name
pagerduty.pagerduty_list_extension_schemas
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_extensions Read
List extensions List existing extensions. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#extensions) Scoped OAuth requires: `extensions.read`
- Lua path
app.integrations.pagerduty.list_extensions- Full name
pagerduty.pagerduty_list_extensions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_alerts_incident Read
List alerts for an incident List alerts for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.read`
- Lua path
app.integrations.pagerduty.list_alerts_incident- Full name
pagerduty.pagerduty_list_incident_alerts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_log_entries_incident Read
List log entries for an incident List log entries for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. A Log Entry are a record of all events on your account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.read`
- Lua path
app.integrations.pagerduty.list_log_entries_incident- Full name
pagerduty.pagerduty_list_incident_log_entries
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_notes_incident Read
List notes for an incident List existing notes for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.read`
- Lua path
app.integrations.pagerduty.list_notes_incident- Full name
pagerduty.pagerduty_list_incident_notes
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_field_options_custom_field Read
List Field Options on a Custom Field List field options for a custom field. Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types. Scoped OAuth requires: `custom_fields.read`
- Lua path
app.integrations.pagerduty.list_field_options_custom_field- Full name
pagerduty.pagerduty_list_incident_type_custom_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_incident_type_custom_fields Read
List Incident Type Custom Fields List the custom fields for an incident type. Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types. Scoped OAuth requires: `custom_fields.read`
- Lua path
app.integrations.pagerduty.list_incident_type_custom_fields- Full name
pagerduty.pagerduty_list_incident_type_custom_fields
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_incident_types Read
List incident types List the available incident types Incident Types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. These can be filtered by enabled or disabled types. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidentType) Scoped OAuth requires: `incident_types.read`
- Lua path
app.integrations.pagerduty.list_incident_types- Full name
pagerduty.pagerduty_list_incident_types
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_actions Read
List Actions List Incident Workflow Actions Scoped OAuth requires: `incident_workflows.read`
- Lua path
app.integrations.pagerduty.list_actions- Full name
pagerduty.pagerduty_list_incident_workflow_actions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_triggers Read
List Triggers List existing Incident Workflow Triggers Scoped OAuth requires: `incident_workflows.read`
- Lua path
app.integrations.pagerduty.list_triggers- Full name
pagerduty.pagerduty_list_incident_workflow_triggers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_incident_workflows Read
List Incident Workflows List existing Incident Workflows. This is the best method to use to list all Incident Workflows in your account. If your use case requires listing Incident Workflows associated with a particular Service, you can use the "List Triggers" method to find Incident Workflows configured to start for Incidents in a given Service. An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. Scoped OAuth requires: `incident_workflows.read`
- Lua path
app.integrations.pagerduty.list_incident_workflows- Full name
pagerduty.pagerduty_list_incident_workflows
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_incidents Read
List incidents List existing incidents. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.read`
- Lua path
app.integrations.pagerduty.list_incidents- Full name
pagerduty.pagerduty_list_incidents
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_license_allocations Read
List License Allocations List the Licenses allocated to Users within your Account Scoped OAuth requires: `licenses.read`
- Lua path
app.integrations.pagerduty.list_license_allocations- Full name
pagerduty.pagerduty_list_license_allocations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_licenses Read
List Licenses List the Licenses associated with your Account Scoped OAuth requires: `licenses.read`
- Lua path
app.integrations.pagerduty.list_licenses- Full name
pagerduty.pagerduty_list_licenses
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_log_entries Read
List log entries List all of the incident log entries across the entire account. A log of all the events that happen to an Incident, and these are exposed as Log Entries. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#log-entries) Scoped OAuth requires: `incidents.read`
- Lua path
app.integrations.pagerduty.list_log_entries- Full name
pagerduty.pagerduty_list_log_entries
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_maintenance_windows Read
List maintenance windows List existing maintenance windows, optionally filtered by service and/or team, or whether they are from the past, present or future. A Maintenance Window is used to temporarily disable one or more Services for a set period of time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#maintenance-windows) Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.list_maintenance_windows- Full name
pagerduty.pagerduty_list_maintenance_windows
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_notifications Read
List notifications for a given time range, optionally filtered by type (sms_notification, email_notification, phone_notification, or push_notification). A Notification is created when an Incident is triggered or escalated. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#notifications) Scoped OAuth requires: `users:notifications.read`
- Lua path
app.integrations.pagerduty.list_notifications- Full name
pagerduty.pagerduty_list_notifications
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_oauth_clients Read
List OAuth clients List all OAuth clients for webhook subscriptions. Maximum of 10 clients per account. Requires admin or owner role permissions.
- Lua path
app.integrations.pagerduty.list_oauth_clients- Full name
pagerduty.pagerduty_list_oauth_clients
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_all_calls Read
List all of the on-calls List the on-call entries during a given time range. An on-call represents a contiguous unit of time for which a User will be on call for a given Escalation Policy and Escalation Rules. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#on-calls) Scoped OAuth requires: `oncalls.read` This API operation has operation specific rate limits. See the [Rate Limits](https://developer.pagerduty.com/docs/72d3b724589e3-rest-api-rate-limits) page for more information.
- Lua path
app.integrations.pagerduty.list_all_calls- Full name
pagerduty.pagerduty_list_on_calls
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_integrations_event_orchestration Read
List Integrations for an Event Orchestration List the Integrations associated with this Event Orchestrations. You can use a Routing Key from these Integrations to send events to PagerDuty! For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`
- Lua path
app.integrations.pagerduty.list_integrations_event_orchestration- Full name
pagerduty.pagerduty_list_orchestration_integrations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_overrides Read
List overrides <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve overrides for a schedule within a time range. **`since` and `until` are required.**
- Lua path
app.integrations.pagerduty.list_overrides- Full name
pagerduty.pagerduty_list_overrides
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_priorities Read
List priorities List existing priorities, in order (most to least severe). A priority is a label representing the importance and impact of an incident. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#priorities) Scoped OAuth requires: `priorities.read`
- Lua path
app.integrations.pagerduty.list_priorities- Full name
pagerduty.pagerduty_list_priorities
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_resource_standards_scores Read
List a resource's standards scores List standards applied to a specific resource Scoped OAuth requires: `standards.read`
- Lua path
app.integrations.pagerduty.list_resource_standards_scores- Full name
pagerduty.pagerduty_list_resource_standards
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_resources_standards_scores Read
List resources' standards scores List standards applied to a set of resources Scoped OAuth requires: `standards.read`
- Lua path
app.integrations.pagerduty.list_resources_standards_scores- Full name
pagerduty.pagerduty_list_resource_standards_many_services
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_rotations Read
List rotations <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve all rotations for a schedule.
- Lua path
app.integrations.pagerduty.list_rotations- Full name
pagerduty.pagerduty_list_rotations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_event_rules Read
List Event Rules List all Event Rules on a Ruleset. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead. Scoped OAuth requires: `event_rules.read`
- Lua path
app.integrations.pagerduty.list_event_rules- Full name
pagerduty.pagerduty_list_ruleset_event_rules
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_rulesets Read
List Rulesets List all Rulesets <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Scoped OAuth requires: `event_rules.read`
- Lua path
app.integrations.pagerduty.list_rulesets- Full name
pagerduty.pagerduty_list_rulesets
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_overrides Read
List overrides for a given time range. A Schedule determines the time periods that users are On-Call. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `schedules.read`
- Lua path
app.integrations.pagerduty.list_overrides- Full name
pagerduty.pagerduty_list_schedule_overrides
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_users_call Read
List users on call. List all of the users on call in a given schedule for a given time range. A Schedule determines the time periods that users are On-Call. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `users.read`
- Lua path
app.integrations.pagerduty.list_users_call- Full name
pagerduty.pagerduty_list_schedule_users
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_schedules Read
List schedules List the on-call schedules. A Schedule determines the time periods that users are On-Call. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `schedules.read`
- Lua path
app.integrations.pagerduty.list_schedules- Full name
pagerduty.pagerduty_list_schedules
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_audit_records_schedule Read
List audit records for a schedule The returned records are sorted by the `execution_time` from newest to oldest. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set. For more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/). Scoped OAuth requires: `audit_records.read`
- Lua path
app.integrations.pagerduty.list_audit_records_schedule- Full name
pagerduty.pagerduty_list_schedules_audit_records
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_audit_records_schedule Read
List audit records for a schedule <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). The returned records are sorted by the `execution_time` from newest to oldest. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set. For more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/). Scoped OAuth requires: `audit_records.read`
- Lua path
app.integrations.pagerduty.list_audit_records_schedule- Full name
pagerduty.pagerduty_list_schedules_audit_records_v3
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_schedules Read
List schedules <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve a paginated list of schedule references. Returns lightweight objects without embedded rotations or events. Each result is filtered by the caller's read permission; schedules the caller cannot read are silently excluded.
- Lua path
app.integrations.pagerduty.list_schedules- Full name
pagerduty.pagerduty_list_schedules_v3
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_audit_records_service Read
List audit records for a service The returned records are sorted by the `execution_time` from newest to oldest. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set. For more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/). Scoped OAuth requires: `audit_records.read`
- Lua path
app.integrations.pagerduty.list_audit_records_service- Full name
pagerduty.pagerduty_list_service_audit_records
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_change_events_service Read
List Change Events for a service List all of the existing Change Events for a service. Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.list_change_events_service- Full name
pagerduty.pagerduty_list_service_change_events
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_field_options Read
List Field Options List all options for a given field. Scoped OAuth requires: `custom_fields.read`
- Lua path
app.integrations.pagerduty.list_field_options- Full name
pagerduty.pagerduty_list_service_custom_field_options
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_fields Read
List Fields List Custom Fields available for Services. Scoped OAuth requires: `custom_fields.read`
- Lua path
app.integrations.pagerduty.list_fields- Full name
pagerduty.pagerduty_list_service_custom_fields
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_service_event_rules Read
List Service's Event Rules List Event Rules on a Service. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.list_service_event_rules- Full name
pagerduty.pagerduty_list_service_event_rules
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_enablements_service Read
Get Enablements for a Service List all feature enablement settings for a service. Currently, only the `aiops` enablement is supported. For any account with the AIOps product addon, every service will have AIOps features enabled by default. **Warning conditions**: - If the account is not entitled to use AIOps features, a warning will be returned alongside the enablement data. Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.get_enablements_service- Full name
pagerduty.pagerduty_list_service_feature_enablements
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_services Read
List services List existing Services. A service may represent an application, component, or team you wish to open incidents against. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.read`
- Lua path
app.integrations.pagerduty.list_services- Full name
pagerduty.pagerduty_list_services
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_sre_agent_memories Read
List SRE Agent memories Search SRE Agent memories for the account. Memories are knowledge learned by the SRE Agent, including service runbooks, service profiles, incident playbooks, and incident summaries. Filter by service ID, incident ID, or memory type to retrieve relevant memories. Scoped OAuth requires: `incident.read`
- Lua path
app.integrations.pagerduty.list_sre_agent_memories- Full name
pagerduty.pagerduty_list_sre_memories
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_standards Read
List Standards Get all standards of an account. Scoped OAuth requires: `standards.read`
- Lua path
app.integrations.pagerduty.list_standards- Full name
pagerduty.pagerduty_list_standards
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_status_dashboards Read
List Status Dashboards Get all your account's custom Status Dashboard views. Scoped OAuth requires: `status_dashboards.read`
- Lua path
app.integrations.pagerduty.list_status_dashboards- Full name
pagerduty.pagerduty_list_status_dashboards
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_status_impacts Read
List Status Page Impacts List Impacts for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.read`
- Lua path
app.integrations.pagerduty.list_status_impacts- Full name
pagerduty.pagerduty_list_status_page_impacts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_status_post_updates Read
List Status Page Post Updates List Post Updates for a Status Page by Status Page ID and Post ID. Scoped OAuth requires: `status_pages.read`
- Lua path
app.integrations.pagerduty.list_status_post_updates- Full name
pagerduty.pagerduty_list_status_page_post_updates
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_status_posts Read
List Status Page Posts List Posts for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.read`
- Lua path
app.integrations.pagerduty.list_status_posts- Full name
pagerduty.pagerduty_list_status_page_posts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_status_services Read
List Status Page Services List Services for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.read`
- Lua path
app.integrations.pagerduty.list_status_services- Full name
pagerduty.pagerduty_list_status_page_services
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_status_severities Read
List Status Page Severities List Severities for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.read`
- Lua path
app.integrations.pagerduty.list_status_severities- Full name
pagerduty.pagerduty_list_status_page_severities
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_status_statuses Read
List Status Page Statuses List Statuses for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.read`
- Lua path
app.integrations.pagerduty.list_status_statuses- Full name
pagerduty.pagerduty_list_status_page_statuses
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_status_subscriptions Read
List Status Page Subscriptions List Subscriptions for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.read`
- Lua path
app.integrations.pagerduty.list_status_subscriptions- Full name
pagerduty.pagerduty_list_status_page_subscriptions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_status Read
List Status Pages. Scoped OAuth requires: `status_pages.read`
- Lua path
app.integrations.pagerduty.list_status- Full name
pagerduty.pagerduty_list_status_pages
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_tags Read
List tags List all of your account's tags. A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#tags) Scoped OAuth requires: `tags.read`
- Lua path
app.integrations.pagerduty.list_tags- Full name
pagerduty.pagerduty_list_tags
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_members_team Read
List members of a team Get information about members on a team. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.read`
- Lua path
app.integrations.pagerduty.list_members_team- Full name
pagerduty.pagerduty_list_team_users
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_teams Read
List teams of your PagerDuty account, optionally filtered by a search query. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.read`
- Lua path
app.integrations.pagerduty.list_teams- Full name
pagerduty.pagerduty_list_teams
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_audit_records_team Read
List audit records for a team The returned records are sorted by the `execution_time` from newest to oldest. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set. For more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/). Scoped OAuth requires: `audit_records.read`
- Lua path
app.integrations.pagerduty.list_audit_records_team- Full name
pagerduty.pagerduty_list_teams_audit_records
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_user_delegations Read
List a user's delegations Get a list of OAuth delegations for a specific user. This endpoint replaces the deprecated `/users/{id}/sessions` endpoint. **Required OAuth Scope:** For Scoped OAuth requests, this operation requires the `oauth_delegations.read` scope. Scoped OAuth requires: `oauth_delegations.read`
- Lua path
app.integrations.pagerduty.list_user_delegations- Full name
pagerduty.pagerduty_list_user_delegations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_users Read
List users of your PagerDuty account, optionally filtered by a search query. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.read`
- Lua path
app.integrations.pagerduty.list_users- Full name
pagerduty.pagerduty_list_users
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_audit_records_user Read
List audit records for a user The response will include audit records with changes that are made to the identified user not changes made by the identified user. The returned records are sorted by the `execution_time` from newest to oldest. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set. For more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/). Scoped OAuth requires: `audit_records.read`
- Lua path
app.integrations.pagerduty.list_audit_records_user- Full name
pagerduty.pagerduty_list_users_audit_records
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_vendors Read
List vendors List all vendors. A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#vendors) Scoped OAuth requires: `vendors.read`
- Lua path
app.integrations.pagerduty.list_vendors- Full name
pagerduty.pagerduty_list_vendors
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_webhook_subscriptions Read
List webhook subscriptions List existing webhook subscriptions. The `filter_type` and `filter_id` query parameters may be used to only show subscriptions for a particular _service_ or _team_. For more information on webhook subscriptions and how they are used to configure v3 webhooks see the [Webhooks v3 Developer Documentation](https://developer.pagerduty.com/docs/webhooks/v3-overview/). Scoped OAuth requires: `webhook_subscriptions.read`
- Lua path
app.integrations.pagerduty.list_webhook_subscriptions- Full name
pagerduty.pagerduty_list_webhook_subscriptions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_all_workflow_integration_connections Read
List all Workflow Integration Connections. Scoped OAuth requires: `workflow_integrations:connections.read`
- Lua path
app.integrations.pagerduty.list_all_workflow_integration_connections- Full name
pagerduty.pagerduty_list_workflow_integration_connections
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_workflow_integration_connections Read
List Workflow Integration Connections List all Workflow Integration Connections for a specific Workflow Integration. Scoped OAuth requires: `workflow_integrations:connections.read`
- Lua path
app.integrations.pagerduty.list_workflow_integration_connections- Full name
pagerduty.pagerduty_list_workflow_integration_connections_by_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_workflow_integrations Read
List Workflow Integrations List available Workflow Integrations. Scoped OAuth requires: `workflow_integrations.read`
- Lua path
app.integrations.pagerduty.list_workflow_integrations- Full name
pagerduty.pagerduty_list_workflow_integrations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
merge_incidents Write
Merge incidents Merge a list of source incidents into the target [incident](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents). After the merge is performed the target incident will contain the source incidents' [alerts](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#alerts), and the source incidents will be resolved. Only incidents that have alerts or incidents that were created manually in the UI can be merged. Open incidents cannot be merged into a resolved incident. An incident cannot have more than 1000 alerts. The server will return an error if merging the source incidents will result in the target incident having more than 1000 alerts. Scoped OAuth requires: `incidents.write`
- Lua path
app.integrations.pagerduty.merge_incidents- Full name
pagerduty.pagerduty_merge_incidents
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
migrate_integration_from_one_event_orchestration_another Write
Migrate an Integration from one Event Orchestration to another Move an Integration and its Routing Key from the Event Orchestration specified in the request payload, to the Event Orchestration specified in the request URL. Any future events sent to this Integration's Routing Key will be processed by this Event Orchestration's Rules. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`
- Lua path
app.integrations.pagerduty.migrate_integration_from_one_event_orchestration_another- Full name
pagerduty.pagerduty_migrate_orchestration_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_alert_grouping_setting Write
Create an Alert Grouping Setting Create a new Alert Grouping Setting. The settings part of Alert Grouper service allows us to create Alert Grouping Settings and configs that are required to be used during grouping of the alerts. This endpoint will be used to create an instance of AlertGroupingSettings for either one service or many services that are in the alert group setting. Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.create_alert_grouping_setting- Full name
pagerduty.pagerduty_post_alert_grouping_settings
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_incident_workflow Write
Create an Incident Workflow Create a new Incident Workflow An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. Scoped OAuth requires: `incident_workflows.write`
- Lua path
app.integrations.pagerduty.create_incident_workflow- Full name
pagerduty.pagerduty_post_incident_workflow
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_orchestration Write
Create an Orchestration Create a Global Event Orchestration. Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`
- Lua path
app.integrations.pagerduty.create_orchestration- Full name
pagerduty.pagerduty_post_orchestration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_integration_event_orchestration Write
Create an Integration for an Event Orchestration Create an Integration associated with this Event Orchestration. You can then use the Routing Key from this new Integration to send events to PagerDuty! For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`
- Lua path
app.integrations.pagerduty.create_integration_event_orchestration- Full name
pagerduty.pagerduty_post_orchestration_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_alert_grouping_setting Write
Update an Alert Grouping Setting. The settings part of Alert Grouper service allows us to create Alert Grouping Settings and configs that are required to be used during grouping of the alerts. if `services` are not provided in the request, then the existing services will not be removed from the setting. Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.update_alert_grouping_setting- Full name
pagerduty.pagerduty_put_alert_grouping_setting
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
set_account_level_priority_threshold_business_service_impact Write
Set the Account-level priority threshold for Business Service impact. Set the Account-level priority threshold for Business Service. Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.set_account_level_priority_threshold_business_service_impact- Full name
pagerduty.pagerduty_put_business_service_priority_thresholds
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
manually_change_incident_impact_business_service Write
Manually change an Incident's Impact on a Business Service. Change Impact of an Incident on a Business Service. Scoped OAuth requires: `incidents.write`
- Lua path
app.integrations.pagerduty.manually_change_incident_impact_business_service- Full name
pagerduty.pagerduty_put_incident_manual_business_service_association
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_incident_workflow Write
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`
- Lua path
app.integrations.pagerduty.update_incident_workflow- Full name
pagerduty.pagerduty_put_incident_workflow
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_business_service_account_subscription Write
Delete Business Service Account Subscription Unsubscribe your Account from a Business Service. Scoped OAuth requires: `subscribers.write`
- Lua path
app.integrations.pagerduty.delete_business_service_account_subscription- Full name
pagerduty.pagerduty_remove_business_service_account_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
remove_business_service_subscribers Write
Remove Business Service Subscribers Unsubscribes the matching Subscribers from a Business Service. Scoped OAuth requires: `subscribers.write`
- Lua path
app.integrations.pagerduty.remove_business_service_subscribers- Full name
pagerduty.pagerduty_remove_business_service_notification_subscriber
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
remove_notification_subscriber Write
Remove Notification Subscriber Unsubscribes the matching Subscribers from Incident Status Update Notifications. Scoped OAuth requires: `subscribers.write`
- Lua path
app.integrations.pagerduty.remove_notification_subscriber- Full name
pagerduty.pagerduty_remove_incident_notification_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
remove_team_notification_subscriptions Write
Unsubscribe the given Team from Notifications on the matching Subscribable entities. Scoped OAuth requires: `subscribers.write`
- Lua path
app.integrations.pagerduty.remove_team_notification_subscriptions- Full name
pagerduty.pagerduty_remove_team_notification_subscriptions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
render_template Write
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`
- Lua path
app.integrations.pagerduty.render_template- Full name
pagerduty.pagerduty_render_template
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_custom_field_values Write
Update Custom Field Values Set custom field values for an incident. Scoped OAuth requires: `incidents.write`
- Lua path
app.integrations.pagerduty.update_custom_field_values- Full name
pagerduty.pagerduty_set_incident_field_values
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
test_webhook_subscription Write
Test a webhook subscription. Fires a test event against the webhook subscription. If properly configured, this will deliver the `pagey.ping` webhook event to the destination. Scoped OAuth requires: `webhook_subscriptions.write`
- Lua path
app.integrations.pagerduty.test_webhook_subscription- Full name
pagerduty.pagerduty_test_webhook_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
remove_notification_subscriptions Write
Remove Notification Subscriptions Unsubscribe the given User from Notifications on the matching Subscribable entities. Scoped OAuth requires: `subscribers.write`
- Lua path
app.integrations.pagerduty.remove_notification_subscriptions- Full name
pagerduty.pagerduty_unsubscribe_user_notification_subscriptions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_add Write
Update an Add-on Update an existing Add-on. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. Given a configuration containing a `src` parameter, that URL will be embedded in an `iframe` on a page that's available to users from a drop-down menu. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#add-ons) Scoped OAuth requires: `addons.write`
- Lua path
app.integrations.pagerduty.update_add- Full name
pagerduty.pagerduty_update_addon
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_automation_action Write
Update an Automation Action Updates an Automation Action
- Lua path
app.integrations.pagerduty.update_automation_action- Full name
pagerduty.pagerduty_update_automation_action
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_automation_action_runner Write
Update an Automation Action runner
- Lua path
app.integrations.pagerduty.update_automation_action_runner- Full name
pagerduty.pagerduty_update_automation_actions_runner
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_business_service Write
Update a Business Service Update an existing Business Service. NOTE that this endpoint also accepts the PATCH verb. Business services model capabilities that span multiple technical services and that may be owned by several different teams. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#business-services) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.update_business_service- Full name
pagerduty.pagerduty_update_business_service
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_cache_variable_global_event_orchestration Write
Update a Cache Variable for a Global Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`
- Lua path
app.integrations.pagerduty.update_cache_variable_global_event_orchestration- Full name
pagerduty.pagerduty_update_cache_var_on_global_orch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_cache_variable_service_event_orchestration Write
Update a Cache Variable for a Service Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.update_cache_variable_service_event_orchestration- Full name
pagerduty.pagerduty_update_cache_var_on_service_orch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_change_event Write
Update a Change Event Update an existing Change Event Scoped OAuth requires: `change_events.write`
- Lua path
app.integrations.pagerduty.update_change_event- Full name
pagerduty.pagerduty_update_change_event
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_field Write
Update a Field <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields/{field_id}](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields~1{field_id}/put) Update a Custom Field on the Base Incident Type. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.update_field- Full name
pagerduty.pagerduty_update_custom_fields_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_field_option Write
Update a Field Option <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields/{field_id}/field_options/{field_option_id}](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields~1{field_id}~1field_options~1{field_option_id}/put) Update a Field Option for a Custom Field on the Base Incident Type. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.update_field_option- Full name
pagerduty.pagerduty_update_custom_fields_field_option
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_custom_shift Write
Update a custom shift <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Update an existing custom shift. If the shift has already started, only `end_time` can be modified.
- Lua path
app.integrations.pagerduty.update_custom_shift- Full name
pagerduty.pagerduty_update_custom_shift
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_escalation_policy Write
Update an escalation policy Updates an existing escalation policy and rules. Escalation policies define which user should be alerted at which time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#escalation-policies) Scoped OAuth requires: `escalation_policies.write`
- Lua path
app.integrations.pagerduty.update_escalation_policy- Full name
pagerduty.pagerduty_update_escalation_policy
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_event Write
Update an event <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Update an existing event. **Restrictions based on event timing:** - **Past events** (effective_until in the past): Cannot be modified - **Active events** (currently producing shifts): Can only update `effective_until` - **Future events** (effective_since in the future): All fields can be updated
- Lua path
app.integrations.pagerduty.update_event- Full name
pagerduty.pagerduty_update_event
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_enablement_event_orchestration Write
Update an Enablement for an Event Orchestration Update the feature enablement setting for a specific product addon on an Event Orchestration. This setting controls enabling or disabling the set of features contained within the addon. Currently, only `aiops` is supported as a valid feature enablement. **Warning conditions**: - If the account is not entitled to use AIOps features, the setting will be updated, but a warning will be returned. Scoped OAuth requires: `event_orchestrations.write`
- Lua path
app.integrations.pagerduty.update_enablement_event_orchestration- Full name
pagerduty.pagerduty_update_event_orchestration_feature_enablements
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_extension Write
Update an extension Update an existing extension. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#extensions) Scoped OAuth requires: `extensions.write`
- Lua path
app.integrations.pagerduty.update_extension- Full name
pagerduty.pagerduty_update_extension
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_data_external_data_cache_variable_global_event_orchestration Write
Update Data for an External Data Cache Variable on a Global Event Orchestration Update data for an `external_data` type Cache Variable on a Global Event Orchestration Use External Data type Cache Variables to store string, number, or boolean values via a dedicated API endpoint. These stored values can then be used in conditions or actions in Event Orchestration rules. For more information see the [Knowledge Base](https://support.pagerduty.com/main/docs/event-orchestration-cache-variables) Scoped OAuth requires: `event_orchestrations.write`
- Lua path
app.integrations.pagerduty.update_data_external_data_cache_variable_global_event_orchestration- Full name
pagerduty.pagerduty_update_external_data_cache_var_data_on_global_orch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_data_external_data_cache_variable_service_event_orchestration Write
Update Data for an External Data Cache Variable on a Service Event Orchestration Update the data for an `external_data` type Cache Variable on a Service Event Orchestration. Use External Data type Cache Variables to store string, number, or boolean values via a dedicated API endpoint. These stored values can then be used in conditions or actions in Event Orchestration rules. For more information see the [Knowledge Base](https://support.pagerduty.com/main/docs/event-orchestration-cache-variables) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.update_data_external_data_cache_variable_service_event_orchestration- Full name
pagerduty.pagerduty_update_external_data_cache_var_data_on_service_orch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_incident Write
Update an incident Acknowledge, resolve, escalate or reassign an incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write`
- Lua path
app.integrations.pagerduty.update_incident- Full name
pagerduty.pagerduty_update_incident
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_alert Write
Update an alert Resolve an alert or associate an alert with a new parent incident. An incident represents a problem or an issue that needs to be addressed and resolved. When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write`
- Lua path
app.integrations.pagerduty.update_alert- Full name
pagerduty.pagerduty_update_incident_alert
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
manage_alerts Write
Manage alerts Resolve multiple alerts or associate them with different incidents. An incident represents a problem or an issue that needs to be addressed and resolved. An alert represents a digital signal that was emitted to PagerDuty by the monitoring systems that detected or identified the issue. A maximum of 250 alerts may be updated at a time. If more than this number of alerts are given, the API will respond with status 413 (Request Entity Too Large). For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write`
- Lua path
app.integrations.pagerduty.manage_alerts- Full name
pagerduty.pagerduty_update_incident_alerts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_note_incident Write
Update a note on an incident Update an existing note for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write`
- Lua path
app.integrations.pagerduty.update_note_incident- Full name
pagerduty.pagerduty_update_incident_note
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_incident_type Write
Update an Incident Type. Incident Types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incident) Scoped OAuth requires: `incident_types.write`
- Lua path
app.integrations.pagerduty.update_incident_type- Full name
pagerduty.pagerduty_update_incident_type
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_custom_field_incident_type Write
Update a Custom Field for an Incident Type Update a custom field for an incident type. Field Options can also be updated within the same call. Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.update_custom_field_incident_type- Full name
pagerduty.pagerduty_update_incident_type_custom_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_field_option_custom_field Write
Update a Field Option for a Custom Field Update a field option for a custom field. Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.update_field_option_custom_field- Full name
pagerduty.pagerduty_update_incident_type_custom_field_field_option
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_trigger Write
Update a Trigger Update an existing Incident Workflow Trigger Scoped OAuth requires: `incident_workflows.write`
- Lua path
app.integrations.pagerduty.update_trigger- Full name
pagerduty.pagerduty_update_incident_workflow_trigger
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
manage_incidents Write
Manage incidents Acknowledge, resolve, escalate or reassign one or more incidents. An incident represents a problem or an issue that needs to be addressed and resolved. A maximum of 250 incidents may be updated at a time. If more than this number of incidents are given, the API will respond with status 413 (Request Entity Too Large). For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write` This API operation has operation specific rate limits. See the [Rate Limits](https://developer.pagerduty.com/docs/72d3b724589e3-rest-api-rate-limits) page for more information.
- Lua path
app.integrations.pagerduty.manage_incidents- Full name
pagerduty.pagerduty_update_incidents
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_log_entry_channel_information Write
Update log entry channel information. Update an existing incident log entry channel. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#log-entries) Scoped OAuth requires: `incidents.write`
- Lua path
app.integrations.pagerduty.update_log_entry_channel_information- Full name
pagerduty.pagerduty_update_log_entry_channel
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_maintenance_window Write
Update a maintenance window Update an existing maintenance window. A Maintenance Window is used to temporarily disable one or more Services for a set period of time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#maintenance-windows) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.update_maintenance_window- Full name
pagerduty.pagerduty_update_maintenance_window
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_oauth_client Write
Update an OAuth client Update an existing OAuth client. Any change will trigger token validation with the OAuth server. Requires admin or owner role permissions.
- Lua path
app.integrations.pagerduty.update_oauth_client- Full name
pagerduty.pagerduty_update_oauth_client
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_service_orchestration_active_status_service Write
Update the Service Orchestration active status for a Service Update a Service Orchestration's active status. A Service Orchestration allows you to set an active status based on whether an event will be evaluated against a service orchestration path (true) or service ruleset (false). For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.update_service_orchestration_active_status_service- Full name
pagerduty.pagerduty_update_orch_active_status
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_global_orchestration_event_orchestration Write
Update the Global Orchestration for an Event Orchestration. Global Orchestration Rules allows you to create a set of Event Rules. These rules evaluate against all Events sent to an Event Orchestration. When a matching rule is found, it can modify and enhance the event and can route the event to another set of Global Rules within this Orchestration for further processing. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`
- Lua path
app.integrations.pagerduty.update_global_orchestration_event_orchestration- Full name
pagerduty.pagerduty_update_orch_path_global
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_router_event_orchestration Write
Update the Router for an Event Orchestration Update a Global Orchestration's Routing Rules. An Orchestration Router allows you to create a set of Event Rules. The Router evaluates Events you send to this Global Orchestration against each of its rules, one at a time, and routes the event to a specific Service based on the first rule that matches. If an event doesn't match any rules, it'll be sent to service specified in as the `catch_all` or the "Unrouted" Orchestration if no service is specified. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`
- Lua path
app.integrations.pagerduty.update_router_event_orchestration- Full name
pagerduty.pagerduty_update_orch_path_router
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_service_orchestration_service Write
Update the Service Orchestration for a Service Update a Service Orchestration. A Service Orchestration allows you to create a set of Event Rules. The Service Orchestration evaluates Events sent to this Service against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Service Orchestration for further processing. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.update_service_orchestration_service- Full name
pagerduty.pagerduty_update_orch_path_service
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_unrouted_orchestration_event_orchestration Write
Update the Unrouted Orchestration for an Event Orchestration Update a Global Event Orchestration's Rules for Unrouted events. An Unrouted Orchestration allows you to create a set of Event Rules that will be evaluated against all events that don't match any rules in the Global Orchestration's Router. Events that reach the Unrouted Orchestration will never be routed to a specific Service. The Unrouted Orchestration evaluates Events sent to it against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Unrouted Orchestration for further processing. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`
- Lua path
app.integrations.pagerduty.update_unrouted_orchestration_event_orchestration- Full name
pagerduty.pagerduty_update_orch_path_unrouted
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_orchestration Write
Update an Orchestration Update a Global Event Orchestration. Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`
- Lua path
app.integrations.pagerduty.update_orchestration- Full name
pagerduty.pagerduty_update_orchestration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_integration_event_orchestration Write
Update an Integration for an Event Orchestration Update an Integration associated with this Event Orchestrations. You can use the Routing Key from this Integration to send events to PagerDuty! For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`
- Lua path
app.integrations.pagerduty.update_integration_event_orchestration- Full name
pagerduty.pagerduty_update_orchestration_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_override Write
Update an override <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Update an existing override.
- Lua path
app.integrations.pagerduty.update_override- Full name
pagerduty.pagerduty_update_override
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_ruleset Write
Update a Ruleset. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Scoped OAuth requires: `event_rules.write`
- Lua path
app.integrations.pagerduty.update_ruleset- Full name
pagerduty.pagerduty_update_ruleset
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_event_rule Write
Update an Event Rule. Note that the endpoint supports partial updates, so any number of the writable fields can be provided. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead. Scoped OAuth requires: `event_rules.write`
- Lua path
app.integrations.pagerduty.update_event_rule- Full name
pagerduty.pagerduty_update_ruleset_event_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_schedule Write
Update a schedule Update an existing on-call schedule. A Schedule determines the time periods that users are On-Call. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `schedules.write`
- Lua path
app.integrations.pagerduty.update_schedule- Full name
pagerduty.pagerduty_update_schedule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_schedule Write
Update a schedule <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. You must pass the `X-EARLY-ACCESS: flexible-schedules-early-access` header on every request. <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Update schedule metadata (name, description, time zone). All fields are optional - only provided fields are updated. To modify rotations or events, use their respective endpoints. **Rejected fields:** `rotations` and `escalation_policies` are not accepted and will result in a 400 error.
- Lua path
app.integrations.pagerduty.update_schedule- Full name
pagerduty.pagerduty_update_schedule_v3
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_service Write
Update a service Update an existing service. A service may represent an application, component, or team you wish to open incidents against. There is a limit of 100,000 open Incidents per Service. If the limit is reached and you disable `auto_resolve_timeout` (set to 0 or null), the API will respond with an error. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.update_service- Full name
pagerduty.pagerduty_update_service
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_field Write
Update a Field Update a Custom Field for Services. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.update_field- Full name
pagerduty.pagerduty_update_service_custom_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_field_option Write
Update a Field Option Update a field option for a given field. Scoped OAuth requires: `custom_fields.write`
- Lua path
app.integrations.pagerduty.update_field_option- Full name
pagerduty.pagerduty_update_service_custom_field_option
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_custom_field_values Write
Update Custom Field Values Set custom field values for a service. Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.update_custom_field_values- Full name
pagerduty.pagerduty_update_service_custom_field_values
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_event_rule_service Write
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`
- Lua path
app.integrations.pagerduty.update_event_rule_service- Full name
pagerduty.pagerduty_update_service_event_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_enablement_service Write
Update an Enablement for a Service Update the feature enablement setting for a specific product addon on a service. This setting controls enabling or disabling the set of features contained within the addon. Currently, only `aiops` is supported as a valid feature enablement. **Warning conditions**: - If the account is not entitled to use AIOps features, the setting will be updated, but a warning will be returned. Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.update_enablement_service- Full name
pagerduty.pagerduty_update_service_feature_enablement
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_existing_integration Write
Update an existing integration Update an integration belonging to a Service. A service may represent an application, component, or team you wish to open incidents against. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.write`
- Lua path
app.integrations.pagerduty.update_existing_integration- Full name
pagerduty.pagerduty_update_service_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
configure_account_session_configurations Write
Configure an account's session configurations Creates or updates session configurations for a PagerDuty Account. The configurations will take effect immediately for new sessions, while existing sessions for the specified `types` are immediately revoked. Scoped OAuth requires: `session_configurations.write`
- Lua path
app.integrations.pagerduty.configure_account_session_configurations- Full name
pagerduty.pagerduty_update_session_configurations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_sre_agent_memory Write
Update an SRE Agent memory Update an existing SRE Agent memory. Scoped OAuth requires: `sre_agent.write`
- Lua path
app.integrations.pagerduty.update_sre_agent_memory- Full name
pagerduty.pagerduty_update_sre_memory
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_standard Write
Update a standard Updates a standard Scoped OAuth requires: `standards.write`
- Lua path
app.integrations.pagerduty.update_standard- Full name
pagerduty.pagerduty_update_standard
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_status_post Write
Update a Status Page Post Update a Post for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.write`
- Lua path
app.integrations.pagerduty.update_status_post- Full name
pagerduty.pagerduty_update_status_page_post
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_status_post_update Write
Update a Status Page Post Update Update a Post Update for a Post by Post ID and Post Update ID. Scoped OAuth requires: `status_pages.write`
- Lua path
app.integrations.pagerduty.update_status_post_update- Full name
pagerduty.pagerduty_update_status_page_post_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_team Write
Update a team Update an existing team. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.write`
- Lua path
app.integrations.pagerduty.update_team- Full name
pagerduty.pagerduty_update_team
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
add_escalation_policy_team Write
Add an escalation policy to a team. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.write`
- Lua path
app.integrations.pagerduty.add_escalation_policy_team- Full name
pagerduty.pagerduty_update_team_escalation_policy
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
add_user_team Write
Add a user to a team. Attempting to add a user with the `read_only_user` role will return a 400 error. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.write`
- Lua path
app.integrations.pagerduty.add_user_team- Full name
pagerduty.pagerduty_update_team_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_template Write
Update a template Update an existing template Scoped OAuth requires: `templates.write`
- Lua path
app.integrations.pagerduty.update_template- Full name
pagerduty.pagerduty_update_template
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_user Write
Update a user Update an existing user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`
- Lua path
app.integrations.pagerduty.update_user- Full name
pagerduty.pagerduty_update_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_user_contact_method Write
Update a user's contact method Update a User's contact method. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.write`
- Lua path
app.integrations.pagerduty.update_user_contact_method- Full name
pagerduty.pagerduty_update_user_contact_method
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_user_handoff_notification_rule Write
Update a User's Handoff Notification Rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`
- Lua path
app.integrations.pagerduty.update_user_handoff_notification_rule- Full name
pagerduty.pagerduty_update_user_handoff_notification
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_user_notification_rule Write
Update a user's notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.write`
- Lua path
app.integrations.pagerduty.update_user_notification_rule- Full name
pagerduty.pagerduty_update_user_notification_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_user_status_update_notification_rule Write
Update a user's status update notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`
- Lua path
app.integrations.pagerduty.update_user_status_update_notification_rule- Full name
pagerduty.pagerduty_update_user_status_update_notification_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_webhook_subscription Write
Update a webhook subscription Updates an existing webhook subscription. Only the fields being updated need to be included on the request. This operation does not support updating the `delivery_method` of the webhook subscription. Scoped OAuth requires: `webhook_subscriptions.write`
- Lua path
app.integrations.pagerduty.update_webhook_subscription- Full name
pagerduty.pagerduty_update_webhook_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_workflow_integration_connection Write
Update Workflow Integration Connection Update an existing Workflow Integration Connection. Scoped OAuth requires: `workflow_integrations:connections.write`
- Lua path
app.integrations.pagerduty.update_workflow_integration_connection- Full name
pagerduty.pagerduty_update_workflow_integration_connection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||