PagerDuty API
Tools that enable LLMs to interact directly with the Pagerduty API.
PagerDuty's API toolkit empowers developers to seamlessly integrate and manage incident response workflows through a variety of automated tools. Designed for interaction with the PagerDuty API, it facilitates comprehensive insight into incident management and team coordination.
Capabilities:
- Integrates and manages incident workflows, actions, and teams efficiently.
- Automates alert notifications, service integrations, and escalation policies.
- Enables customization of incident types and field options for enhanced filtering.
- Supports detailed analytics and metrics retrieval for incident performance.
OAuth:
- Provider: PagerDuty
- Scopes:
services.write,incident_workflows.write,users.write, among others.
Secrets: None required.
Available tools(374)
| Tool name | Description | Secrets | |
|---|---|---|---|
Create a cache variable for a service event orchestration.
Use this tool to create a cache variable within a service event orchestration on PagerDuty. Cache variables store event data that can be used in orchestration rules for conditions or actions. Requires OAuth with `services.write` scope. | |||
Add an escalation policy to a team.
This tool adds an escalation policy to a specified team within an organization. It is useful for managing team response structures and assigning appropriate escalation policies to teams. Users should have 'teams.write' permissions to perform this update. | |||
Add a new note to a specific incident.
Use this tool to attach a note to an existing incident when documenting updates or additional information is necessary. Ideal for tracking the progress of resolving an issue.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Create a new option for a custom field in PagerDuty services.
This tool is used to create a new option for a specified custom field in the PagerDuty services. It should be called when you want to extend the available options for a specific field. Requires `custom_fields.write` OAuth scope.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a user to a specified team on PagerDuty.
This tool adds a user to a specified team using PagerDuty. It should be called when you need to integrate a user within a team structure in an organization. Note that attempting to add a user with a 'read_only_user' role will result in an error. OAuth scope 'teams.write' is required. | |||
Assign tags to PagerDuty entities like policies, teams, or users.
Assign or update tags for Escalation Policies, Teams, or Users in PagerDuty to facilitate filtering and organization. Use this tool to manage tags efficiently.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Associate an Automation Action with a service.
This tool is used to associate a specified Automation Action with a service in PagerDuty. Call this tool when you need to link an action to a service for automation purposes.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Associate an Automation Action with a team.
Use this tool to link a specific automation action to a designated team in PagerDuty. It should be called when there's a need to establish or update the association between an existing action and a team.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Associate a runner with a specified team.
This tool allows you to associate a specific runner with a team in PagerDuty. Use it when you need to link automation actions runners to teams.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Associate a service with an existing incident workflow trigger.
This tool associates a specific service with an existing incident workflow trigger in PagerDuty. It requires OAuth permission `incident_workflows.write`. Use this tool when you need to link a service to a workflow trigger for better incident management.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Check if your account has a specific ability.
Use this tool to test whether your PagerDuty account has a specific ability or feature available. An ability can depend on factors like your pricing plan or account state, and this tool helps determine availability. | |||
Clear priority thresholds for business services.
This tool clears the priority thresholds for business services in the account, allowing any incident with a priority to impact them. It requires `services.write` OAuth scope. | |||
Convert service event rules to orchestration rules.
Use this tool to convert a service's event rules into equivalent event orchestration rules. This process makes existing event rules read-only, with future updates needing orchestration rules. This tool is vital for migrating as event rules will soon be deprecated. | |||
Create a new Alert Grouping Setting in PagerDuty.
This tool allows the creation of new Alert Grouping Settings for one or multiple services within the PagerDuty platform. It is used to define configurations in the Alert Grouper service. Requires 'services.write' OAuth scope.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Create a new alert or incident template.
Use this tool to create a new template in PagerDuty, which can be used for alerts or incidents. Requires OAuth with `templates.write` scope. | |||
Create a script, process, or runbook automation action.
This tool creates an automation action such as a script, process automation, or runbook automation action in PagerDuty. Call this when you need to automate or manage workflows.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Create a Process or Runbook Automation runner.
Use this tool to create a new Process Automation or Runbook Automation runner in PagerDuty.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Create a new business service in PagerDuty.
Use this tool to create a new business service, which represents capabilities spanning multiple technical services, possibly owned by various teams. Make sure not to exceed the account limit of 5,000 business services. | |||
Create a cache variable for global event orchestration rules.
This tool creates a cache variable within a global event orchestration on PagerDuty. Cache variables are useful for storing event data that can be utilized in orchestration rules for conditions or actions. Ideal for managing and automating event-driven processes. | |||
Create a custom field option for incidents.
This tool creates a field option for a custom field in incidents, allowing users to extend incident data with custom options. It supports additional context, customized filtering, search, and analytics.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Create a new escalation policy in PagerDuty.
Use this tool to create a new escalation policy on PagerDuty. Escalation policies are used to determine which users are alerted and when. At least one escalation rule must be included. Requires OAuth scope: 'escalation_policies.write'.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Create an integration for event orchestration in PagerDuty.
This tool creates an integration associated with a specified event orchestration in PagerDuty. Use this to obtain a Routing Key for sending events. Requires `event_orchestrations.write` permission.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Create a new event rule within a ruleset.
This tool creates a new event rule in a specified ruleset in PagerDuty. It should be called when you need to set up routing actions based on event content. Note: functionalities related to rulesets and event rules will be deprecated soon. Consider migrating to Event Orchestration.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Create a Global Event Orchestration in PagerDuty.
This tool allows you to create a Global Event Orchestration, defining Global Rules and Router Rules for event processing and routing based on event content.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Create a handoff notification rule for PagerDuty users.
This tool allows you to create a new handoff notification rule for users in PagerDuty. It should be called when you need to set a notification rule for on-call handoff events for a specific user. Requires `users.write` OAuth scope.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
|
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
PagerdutyApi.AddCacheVariableToServiceEvent
Create a cache variable for a service event orchestration. Use this tool to create a cache variable within a service event orchestration on PagerDuty. Cache variables store event data that can be used in orchestration rules for conditions or actions. Requires OAuth with `services.write` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_identifier | string | Required | The ID of the service for which the cache variable is being created. This should be a string representing the unique identifier of the service. |
Requirements
Output
json— Response from the API endpoint 'createCacheVarOnServiceOrch'.PagerdutyApi.AddEscalationPolicyToTeam
Add an escalation policy to a team. This tool adds an escalation policy to a specified team within an organization. It is useful for managing team response structures and assigning appropriate escalation policies to teams. Users should have 'teams.write' permissions to perform this update.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
escalation_policy_id | string | Required | The ID of the escalation policy to be added to the team. Ensure it is a valid policy ID within your organization. |
team_resource_id | string | Required | The unique identifier for the team resource to update with an escalation policy. |
Requirements
Output
json— Response from the API endpoint 'updateTeamEscalationPolicy'.PagerdutyApi.AddIncidentNote
Add a new note to a specific incident. Use this tool to attach a note to an existing incident when documenting updates or additional information is necessary. Ideal for tracking the progress of resolving an issue. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_id | string | Optional | The unique identifier of the incident to which the note will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
user_email_address | string | Optional | The email address of a valid user associated with the account making the request. This must be an email registered with the PagerDuty account. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createIncidentNote'.PagerdutyApi.AddServiceFieldOption
Create a new option for a custom field in PagerDuty services. This tool is used to create a new option for a specified custom field in the PagerDuty services. It should be called when you want to extend the available options for a specific field. Requires `custom_fields.write` OAuth scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
field_identifier | string | Optional | The unique identifier for the custom field where the new option will be added. This is required to specify which field you are modifying. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createServiceCustomFieldOption'.PagerdutyApi.AddUserToTeam
Add a user to a specified team on PagerDuty. This tool adds a user to a specified team using PagerDuty. It should be called when you need to integrate a user within a team structure in an organization. Note that attempting to add a user with a 'read_only_user' role will result in an error. OAuth scope 'teams.write' is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_id | string | Required | The ID of the team to which the user will be added. |
user_id | string | Required | The unique identifier for the user to be added to the team. This ID should match a user already present in the system. |
user_role_on_team | string | Optional | Specify the role of the user on the team. Allowed values are 'observer', 'responder', or 'manager'. |
Requirements
Output
json— Response from the API endpoint 'updateTeamUser'.PagerdutyApi.AssignTagsToPagerdutyEntity
Assign tags to PagerDuty entities like policies, teams, or users. Assign or update tags for Escalation Policies, Teams, or Users in PagerDuty to facilitate filtering and organization. Use this tool to manage tags efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
entity_type | string | Optional | Specify the entity type to tag. Options: 'users', 'teams', 'escalation_policies'. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
resource_id | string | Optional | The unique identifier of the PagerDuty entity to assign tags to. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createEntityTypeByIdChangeTags'.PagerdutyApi.AssociateAutomationActionWithService
Associate an Automation Action with a service. This tool is used to associate a specified Automation Action with a service in PagerDuty. Call this tool when you need to link an action to a service for automation purposes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier of the resource to be associated with the service. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createAutomationActionServiceAssocation'.PagerdutyApi.AssociateAutomationActionWithTeam
Associate an Automation Action with a team. Use this tool to link a specific automation action to a designated team in PagerDuty. It should be called when there's a need to establish or update the association between an existing action and a team. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier of the resource to be associated with a team. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createAutomationActionTeamAssociation'.PagerdutyApi.AssociateRunnerWithTeam
Associate a runner with a specified team. This tool allows you to associate a specific runner with a team in PagerDuty. Use it when you need to link automation actions runners to teams. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | Unique identifier for the resource to associate a runner with a team in PagerDuty. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createAutomationActionsRunnerTeamAssociation'.PagerdutyApi.AssociateServiceToIncidentWorkflowTrigger
Associate a service with an existing incident workflow trigger. This tool associates a specific service with an existing incident workflow trigger in PagerDuty. It requires OAuth permission `incident_workflows.write`. Use this tool when you need to link a service to a workflow trigger for better incident management. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier of the resource to associate with the incident workflow trigger. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'associateServiceToIncidentWorkflowTrigger'.PagerdutyApi.CheckAbilityStatus
Check if your account has a specific ability. Use this tool to test whether your PagerDuty account has a specific ability or feature available. An ability can depend on factors like your pricing plan or account state, and this tool helps determine availability.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique ID of the resource or ability to check on your account. |
Requirements
Output
json— Response from the API endpoint 'getAbility'.PagerdutyApi.ClearBusinessServicePriorityThresholds
Clear priority thresholds for business services. This tool clears the priority thresholds for business services in the account, allowing any incident with a priority to impact them. It requires `services.write` OAuth scope.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'deleteBusinessServicePriorityThresholds'.PagerdutyApi.ConvertServiceEventRules
Convert service event rules to orchestration rules. Use this tool to convert a service's event rules into equivalent event orchestration rules. This process makes existing event rules read-only, with future updates needing orchestration rules. This tool is vital for migrating as event rules will soon be deprecated.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the service to be converted. This is required to specify which service's event rules need to be converted to orchestration rules. |
Requirements
Output
json— Response from the API endpoint 'convertServiceEventRulesToEventOrchestration'.PagerdutyApi.CreateAlertGroupingSetting
Create a new Alert Grouping Setting in PagerDuty. This tool allows the creation of new Alert Grouping Settings for one or multiple services within the PagerDuty platform. It is used to define configurations in the Alert Grouper service. Requires 'services.write' OAuth scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postAlertGroupingSettings'.PagerdutyApi.CreateAlertTemplate
Create a new alert or incident template. Use this tool to create a new template in PagerDuty, which can be used for alerts or incidents. Requires OAuth with `templates.write` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
email_body_html | string | Optional | The HTML body content for the email message to be sent as part of the template. |
email_subject | string | Optional | The subject line for the email template, which will appear as the email's subject. |
short_message_template | string | Optional | The short message for the template, used in SMS, Push notifications, Slack, etc. |
template_description | string | Optional | Provide a brief description of the template, outlining its purpose and use case. |
template_name | string | Optional | The name for the new template to be created in PagerDuty. |
template_type | string | Optional | The type of template. Currently, only 'status_update' is supported. |
Requirements
Output
json— Response from the API endpoint 'createTemplate'.PagerdutyApi.CreateAutomationAction
Create a script, process, or runbook automation action. This tool creates an automation action such as a script, process automation, or runbook automation action in PagerDuty. Call this when you need to automate or manage workflows. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createAutomationAction'.PagerdutyApi.CreateAutomationRunner
Create a Process or Runbook Automation runner. Use this tool to create a new Process Automation or Runbook Automation runner in PagerDuty. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createAutomationActionsRunner'.PagerdutyApi.CreateBusinessService
Create a new business service in PagerDuty. Use this tool to create a new business service, which represents capabilities spanning multiple technical services, possibly owned by various teams. Make sure not to exceed the account limit of 5,000 business services.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
business_service_description | string | Optional | Provide a description for the Business Service. This should clearly outline the service's purpose and scope. |
business_service_name | string | Optional | The name of the Business Service to be created. |
business_service_owner | string | Optional | The owner or point of contact for the business service. |
team_id | string | Optional | The unique identifier for the team associated with the business service. |
Requirements
Output
json— Response from the API endpoint 'createBusinessService'.PagerdutyApi.CreateCacheVariableEventOrchestration
Create a cache variable for global event orchestration rules. This tool creates a cache variable within a global event orchestration on PagerDuty. Cache variables are useful for storing event data that can be utilized in orchestration rules for conditions or actions. Ideal for managing and automating event-driven processes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_orchestration_id | string | Required | The ID of an Event Orchestration for which the cache variable is to be created. |
Requirements
Output
json— Response from the API endpoint 'createCacheVarOnGlobalOrch'.PagerdutyApi.CreateCustomFieldOption
Create a custom field option for incidents. This tool creates a field option for a custom field in incidents, allowing users to extend incident data with custom options. It supports additional context, customized filtering, search, and analytics. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_type_id_or_name | string | Optional | The ID or name of the incident type for which the custom field option will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
field_id | string | Optional | The unique identifier for the custom field to which the option will be added. This should be a string that specifies the field within the incident type. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createIncidentTypeCustomFieldFieldOptions'.PagerdutyApi.CreateEscalationPolicy
Create a new escalation policy in PagerDuty. Use this tool to create a new escalation policy on PagerDuty. Escalation policies are used to determine which users are alerted and when. At least one escalation rule must be included. Requires OAuth scope: 'escalation_policies.write'. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
change_tracking_user_email | string | Optional | The optional email address of a user for change tracking. Must be associated with the account making the request. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createEscalationPolicy'.PagerdutyApi.CreateEventIntegration
Create an integration for event orchestration in PagerDuty. This tool creates an integration associated with a specified event orchestration in PagerDuty. Use this to obtain a Routing Key for sending events. Requires `event_orchestrations.write` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
event_orchestration_id | string | Optional | The unique identifier for the Event Orchestration within PagerDuty. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postOrchestrationIntegration'.PagerdutyApi.CreateEventRule
Create a new event rule within a ruleset. This tool creates a new event rule in a specified ruleset in PagerDuty. It should be called when you need to set up routing actions based on event content. Note: functionalities related to rulesets and event rules will be deprecated soon. Consider migrating to Event Orchestration. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier for the resource (ruleset) in which the event rule will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createRulesetEventRule'.PagerdutyApi.CreateGlobalEventOrchestration
Create a Global Event Orchestration in PagerDuty. This tool allows you to create a Global Event Orchestration, defining Global Rules and Router Rules for event processing and routing based on event content. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postOrchestration'.PagerdutyApi.CreateHandoffNotificationRule
Create a handoff notification rule for PagerDuty users. This tool allows you to create a new handoff notification rule for users in PagerDuty. It should be called when you need to set a notification rule for on-call handoff events for a specific user. Requires `users.write` OAuth scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier for the user or resource for which the handoff notification rule will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createUserHandoffNotificationRule'.PagerdutyApi.CreateIncident
Create an incident in PagerDuty. Use this tool to create an incident in PagerDuty when there is a problem or issue that needs attention and resolution. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
user_email | string | Optional | The email address of a valid user associated with the account making the request. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createIncident'.PagerdutyApi.CreateIncidentResponderRequest
Send a responder request for a specified incident. This tool allows you to send a new responder request for a specific incident that needs attention and resolution. It should be called whenever additional assistance is required to address an ongoing issue. Proper OAuth scope is required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_id | string | Optional | The unique identifier for the incident requiring a responder request. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
user_email | string | Optional | The email address of a valid user associated with the account making the request. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createIncidentResponderRequest'.PagerdutyApi.CreateIncidentType
Create a new incident type in PagerDuty to categorize incidents. Use this tool to create a new incident type in PagerDuty, allowing categorization by type, such as security incidents, major incidents, or fraud incidents. This helps organize and respond to different kinds of incidents effectively. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createIncidentType'.PagerdutyApi.CreateIncidentTypeCustomField
Create a custom field for a specific incident type. This tool creates a custom field for a specified incident type on PagerDuty, allowing users to extend incidents with their own data to enhance filtering, search, and analytics. It requires `custom_fields.write` OAuth scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_type_id_or_name | string | Optional | The ID or name of the incident type for which the custom field is created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createIncidentTypeCustomField'.PagerdutyApi.CreateIncidentWorkflow
Create a new incident workflow to automate actions. This tool creates a new incident workflow, consisting of steps and triggers to execute automated actions for an incident. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postIncidentWorkflow'.PagerdutyApi.CreateIncidentWorkflowTrigger
Initiate a new PagerDuty incident workflow trigger. Use this tool to start a new incident workflow trigger in PagerDuty. It requires appropriate OAuth permissions (`incident_workflows.write`). Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createIncidentWorkflowTrigger'.PagerdutyApi.CreateMaintenanceWindow
Create a maintenance window for specified services. This tool is used to create a maintenance window during which specified services are temporarily disabled to prevent new incidents from being created. Useful when upgrading systems or performing maintenance. Requires OAuth permission: `services.write`. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
user_email | string | Optional | The email address of a valid user associated with the account making the request. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createMaintenanceWindow'.PagerdutyApi.CreateNewService
Create a new service for incident management. Use this tool to create a new service within an account for incident management, representing an application, component, or team. Ensure the status is set to 'active' during creation. This tool is essential for managing services and handling incidents efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createService'.PagerdutyApi.CreateNewTeam
Create a new team with users and escalation policies. This tool should be called to create a new team within an organization in PagerDuty. A team includes a collection of users and escalation policies. Requires proper OAuth scope for execution. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createTeam'.PagerdutyApi.CreateOauthClient
Create a new OAuth client for webhook subscriptions. Creates an OAuth client for webhook subscriptions, with validation of client credentials. Requires admin or owner permissions and allows up to 10 clients per account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
oauth_client_id | string | Required | The OAuth client ID provided by the OAuth server. |
oauth_client_name | string | Required | A human-readable name for the OAuth client. It is used to identify the client in a user-friendly manner. |
oauth_client_secret | string | Required | The client secret provided by the OAuth server for the OAuth client. |
oauth_grant_type | string | Required | The OAuth grant type. Currently, only 'client_credentials' is supported. |
oauth_token_endpoint_url | string | Required | The URL for the OAuth token endpoint required to obtain an access token. |
oauth_scopes_requested | string | Optional | The OAuth scopes requested for this client. |
Requirements
Output
json— Response from the API endpoint 'createOauthClient'.PagerdutyApi.CreateOnCallSchedule
Create a new on-call schedule for users. This tool is used to create a new on-call schedule, specifying the time periods when users are on call. Use it when you need to establish or update on-call rotations for team members. Requires appropriate permissions (`schedules.write`). Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
allow_overflow | boolean | Optional | Set to true to allow on-call schedule entries to extend beyond date range bounds. Defaults to false. This results in longer schedule entries that encompass the full day if applicable. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createSchedule'.PagerdutyApi.CreatePagerdutyUser
Create a new user in PagerDuty for account interaction. Use this tool to create a new user in a PagerDuty account. Users can interact with incidents and other data. Requires appropriate OAuth permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
requester_email | string | Optional | The email of a valid user associated with the account making the request. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createUser'.PagerdutyApi.CreateRuleset
Create a new ruleset to manage event routing. Use this tool to create a new ruleset for routing events and defining event rules. Note: Rulesets and Event Rules will soon reach end-of-life; consider migrating to Event Orchestration for enhanced features. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createRuleset'.PagerdutyApi.CreateScheduleOverride
Create schedule overrides for specific users and time ranges. This tool creates one or more schedule overrides for specific users covering specified time periods. Overrides are used to manage on-call schedules. It should be called when you need to modify or assign on-call duties temporarily, ensuring the latest override has priority if overlapping occurs. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier for the schedule resource to which the override will be applied. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createScheduleOverride'.PagerdutyApi.CreateServiceCustomField
Create a new custom field for services. This tool is used to create a new custom field for services in PagerDuty, including field options if provided. It is useful when you need to add custom metadata or specifications to a service. Requires custom_fields.write permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createServiceCustomField'.PagerdutyApi.CreateServiceDependency
Creates dependencies between two services in PagerDuty. Use this tool to establish new relationships between business or technical services on PagerDuty. It manages dependencies with constraints on the number of relations and depth. Useful for modeling complex service architectures across teams. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createServiceDependency'.PagerdutyApi.CreateServiceEventRule
Create a new Event Rule on a Service in PagerDuty. This tool creates a new Event Rule for a specified service in PagerDuty. It should be called when you need to set up or manage event rules for monitoring and alerting within a service. Note that rulesets and event rules will be deprecated, so consider migrating to Event Orchestration. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
service_resource_id | string | Optional | The unique ID of the service resource where the event rule will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createServiceEventRule'.PagerdutyApi.CreateServiceExtension
Create a new extension for a service in PagerDuty. This tool is used to create a new extension in PagerDuty, representing an Extension Schema object attached to a service. It should be called when you need to add or register a new extension to enhance a service's functionality. Requires scoped OAuth: `extensions.write`. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createExtension'.PagerdutyApi.CreateServiceIntegration
Create a new integration for a specific service. Use this tool to create a new integration for a service, which can represent an application, component, or team. This action is relevant when you need to establish connections that allow incident management for that service. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The ID of the resource to create an integration for. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createServiceIntegration'.PagerdutyApi.CreateStatusPagePost
Create a status page post using a specific page ID. This tool is used to create a post on a status page identified by its ID. Useful for updating status pages with the latest information. Requires `status_pages.write` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
status_page_id | string | Optional | The unique identifier for the status page to which the post will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createStatusPagePost'.PagerdutyApi.CreateStatusPagePostmortem
Create a postmortem for a status page post. Use this tool to generate a detailed postmortem for a specific status page post using its post ID. Requires appropriate access permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique ID of the resource for which the postmortem is being created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
status_page_post_id | string | Optional | The unique identifier of the status page post for which the postmortem is being created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createStatusPagePostmortem'.PagerdutyApi.CreateStatusPagePostUpdate
Create a post update for a specific status page post. This tool creates an update for a post on a status page by providing the post ID. Use it to communicate changes or progress in ongoing incidents or updates. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier of the resource you are targeting. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
status_page_post_id | string | Optional | The ID of the Status Page Post for which the update is created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createStatusPagePostUpdate'.PagerdutyApi.CreateStatusPageSubscription
Subscribe to a status page by ID. Use this tool to create a subscription for a specific status page using its ID. Requires appropriate OAuth permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
status_page_id | string | Optional | The ID of the status page to subscribe to. This string is used to identify the specific page. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createStatusPageSubscription'.PagerdutyApi.CreateTag
Create a tag for filtering in PagerDuty. This tool is used to create a new tag in PagerDuty. Tags can be applied to escalation policies, teams, or users to facilitate filtering. Use this tool when you need to organize or categorize these entities by tags. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createTags'.PagerdutyApi.CreateTeamNotificationSubscriptions
Create notification subscriptions for a specified team. Use this tool to create new notification subscriptions for a given team by specifying the team's ID. Requires appropriate OAuth permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
team_id | string | Optional | The ID of the team for which you want to create notification subscriptions. This is a required identifier. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createTeamNotificationSubscriptions'.PagerdutyApi.CreateUserContactMethod
Create a new contact method for a PagerDuty user. This tool creates a new contact method for a specified user in PagerDuty. It's useful for updating user profiles with additional ways to be contacted regarding incidents and other important account interactions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
user_id | string | Optional | The unique identifier of the user for whom the contact method is being created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createUserContactMethod'.PagerdutyApi.CreateUserNotificationRule
Create a new user notification rule in PagerDuty. Use this tool to create a new notification rule for a user in a PagerDuty account, allowing interaction with incidents and data. Requires OAuth permission: `users:contact_methods.write`. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
user_resource_id | string | Optional | The unique ID of the user resource for which the notification rule is being created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createUserNotificationRule'.PagerdutyApi.CreateUserNotificationSubscriptions
Create new notification subscriptions for a user. This tool is used to create new notification subscriptions for a specified user on PagerDuty. It requires scoped OAuth with the `subscribers.write` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier of the resource for which to create notification subscriptions. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createUserNotificationSubscriptions'.PagerdutyApi.CreateUserStatusUpdateNotificationRule
Create a new status update notification rule for a user. This tool allows you to create a new status update notification rule for a user in a PagerDuty account. It should be called when you need to set up or modify how a user is notified about status updates. Requires 'users.write' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
user_id | string | Optional | The unique identifier of the user resource for creating the notification rule. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createUserStatusUpdateNotificationRule'.PagerdutyApi.CreateWebhookSubscription
Create a new webhook subscription in PagerDuty. This tool is used to create a new webhook subscription on PagerDuty. It should be invoked when you need to configure or integrate with v3 webhooks. Requires proper OAuth permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createWebhookSubscription'.PagerdutyApi.CreateWorkflowIntegrationConnection
Create a new workflow integration connection in PagerDuty. Use this tool to create a new connection for a specified workflow integration in PagerDuty. Requires appropriate OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
workflow_integration_id | string | Required | The ID of the Workflow Integration to create a connection for. |
Requirements
Output
json— Response from the API endpoint 'createWorkflowIntegrationConnection'.PagerdutyApi.DeleteAlertGroupingSetting
Delete an existing alert grouping setting. Use this tool to delete a specific alert grouping setting in the PagerDuty service. This action is utilized when you need to remove configurations used during the grouping of alerts. Requires appropriate OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
alert_grouping_setting_id | string | Required | The ID of the alert grouping setting to be deleted. This identifies the specific resource in PagerDuty. |
Requirements
Output
json— Response from the API endpoint 'deleteAlertGroupingSetting'.PagerdutyApi.DeleteAutomationAction
Delete an automation action by ID. This tool deletes a specified automation action in PagerDuty using its unique ID. Use when you need to remove an existing automation action from the system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique ID of the automation action to be deleted. Required for identifying the specific resource. |
Requirements
Output
json— Response from the API endpoint 'deleteAutomationAction'.PagerdutyApi.DeleteAutomationActionRunner
Delete an Automation Action runner by ID. Use this tool to delete an existing Automation Action runner in PagerDuty by providing its ID. It should be called when you need to remove a runner and no longer require it for automation tasks.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
runner_id | string | Required | The unique ID of the Automation Action runner to delete. |
Requirements
Output
json— Response from the API endpoint 'deleteAutomationActionsRunner'.PagerdutyApi.DeleteBusinessService
Delete an existing Business Service in PagerDuty. This tool deletes a specified Business Service in PagerDuty. Once deleted, the service will not be accessible from the web UI, and new incidents cannot be created for it. Call this tool when you need to remove a business service that spans technical services and is owned by multiple teams.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
business_service_id | string | Required | The unique identifier of the Business Service to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteBusinessService'.PagerdutyApi.DeleteCacheVariableGlobalEvent
Delete a cache variable for a global event orchestration. This tool deletes a cache variable from a specified global event orchestration. Cache variables store event data, which can be used in orchestration rules. Use this tool when you need to remove such variables from global event configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cache_variable_id | string | Required | The unique identifier of the cache variable to delete. |
event_orchestration_id | string | Required | The unique identifier for the event orchestration from which the cache variable will be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteCacheVarOnGlobalOrch'.PagerdutyApi.DeleteCustomFieldOption
Delete a custom field option for an incident type. Use this tool to delete a specific field option from a custom field in PagerDuty. This is useful for managing and organizing custom fields associated with different incident types. Requires appropriate OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
field_identifier | string | Required | The unique identifier of the custom field from which the option will be deleted. |
field_option_id | string | Required | The ID of the field option to be deleted. This is required for identifying which option to remove from the custom field. |
incident_type_identifier | string | Required | The ID or name of the incident type for which the custom field option should be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteIncidentTypeCustomFieldFieldOption'.PagerdutyApi.DeleteEscalationPolicy
Delete an existing escalation policy from PagerDuty. Use this tool when you need to delete an existing escalation policy that is not in use by any services. Escalation policies define alert sequences for users. Ensure you have the necessary permissions (`escalation_policies.write`).
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
escalation_policy_id | string | Required | The ID of the escalation policy to be deleted. Ensure the policy is not in use by any services and that you have the required permissions. |
Requirements
Output
json— Response from the API endpoint 'deleteEscalationPolicy'.PagerdutyApi.DeleteEventOrchestration
Delete a Global Event Orchestration on PagerDuty. This tool deletes a specified Global Event Orchestration, preventing further event ingestion using the orchestration's routing key. Use when you need to remove an orchestration from PagerDuty.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_orchestration_id | string | Required | The ID of the Global Event Orchestration to delete. |
Requirements
Output
json— Response from the API endpoint 'deleteOrchestration'.PagerdutyApi.DeleteEventRule
Delete an event rule from a specified ruleset. Use this tool to delete an event rule within a specified ruleset on PagerDuty. This function should be called when you need to remove a rule that defines specific actions for routing events. Note that rulesets and event rules will be phased out soon, and migration to Event Orchestration is recommended.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_rule_id | string | Required | The unique identifier of the Event Rule to be deleted. |
resource_id | string | Required | The unique identifier of the resource (ruleset) to delete the event rule from. |
Requirements
Output
json— Response from the API endpoint 'deleteRulesetEventRule'.PagerdutyApi.DeleteExtension
Delete an existing extension in PagerDuty. This tool deletes an existing extension in PagerDuty, making it inaccessible from the web UI and preventing new incidents from being created for this extension.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the extension to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteExtension'.PagerdutyApi.DeleteExternalDataCacheVariable
Deletes external data cache variable for event orchestration. Use this tool to delete data stored in an external data type cache variable within a global event orchestration. This action affects the cache variables used in conditions or actions in event orchestration rules. Requires appropriate OAuth permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cache_variable_id | string | Required | The ID of the cache variable to delete within the event orchestration. |
event_orchestration_id | string | Required | The unique identifier for the Event Orchestration to target for cache variable deletion. |
Requirements
Output
json— Response from the API endpoint 'deleteExternalDataCacheVarDataOnGlobalOrch'.PagerdutyApi.DeleteIncidentTypeCustomField
Delete a custom field for a specified incident type. Use this tool to delete a custom field from a specific incident type, enhancing filtering, search, or analytics flexibility. Ensure you have the necessary OAuth scope: `custom_fields.write`.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
field_id | string | Required | The unique identifier of the custom field to be deleted. |
incident_type_id_or_name | string | Required | The ID or name of the specific incident type to delete a custom field from. |
Requirements
Output
json— Response from the API endpoint 'deleteIncidentTypeCustomField'.PagerdutyApi.DeleteIncidentWorkflow
Deletes an existing incident workflow in PagerDuty. Use this tool to delete an incident workflow from PagerDuty. An incident workflow is a sequence of steps and triggers for automating actions for a specific incident. This tool requires scoped OAuth with `incident_workflows.write`.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the incident workflow to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteIncidentWorkflow'.PagerdutyApi.DeleteIncidentWorkflowTrigger
Deletes an existing incident workflow trigger using its ID. Use this tool to delete an existing incident workflow trigger by specifying its ID. Requires authorized access for deletion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_workflow_trigger_id | string | Required | The unique identifier of the incident workflow trigger to delete. |
Requirements
Output
json— Response from the API endpoint 'deleteIncidentWorkflowTrigger'.PagerdutyApi.DeleteIntegrationRoutingKey
Delete an integration and its associated routing key. Use this tool to delete an integration and its associated routing key in PagerDuty. Once deleted, all future events sent using the routing key will be dropped. Requires specific OAuth permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_orchestration_id | string | Required | The identifier for the Event Orchestration to be deleted. |
integration_id | string | Required | The unique ID of the integration to be deleted. This is necessary to identify which integration and its routing key should be removed. |
Requirements
Output
json— Response from the API endpoint 'deleteOrchestrationIntegration'.PagerdutyApi.DeleteMaintenanceWindow
Delete or end a maintenance window in PagerDuty. Use this tool to delete an existing maintenance window if it is scheduled for the future, or to end it if it is currently ongoing in PagerDuty. It cannot delete a maintenance window that has already ended.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
maintenance_window_id | string | Required | The unique identifier for the maintenance window to delete or end. |
Requirements
Output
json— Response from the API endpoint 'deleteMaintenanceWindow'.PagerdutyApi.DeleteOauthClient
Delete an OAuth client from webhook subscriptions. This tool deletes an OAuth client and removes its association from any webhook subscriptions using it. It requires admin or owner role permissions to execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the OAuth client to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteOauthClient'.PagerdutyApi.DeleteOauthDelegations
Revoke OAuth app access for a user or account. Use this tool to delete all OAuth delegations, revoking app access for specified users or accounts on PagerDuty. This action requires reauthorization to regain access.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
delegation_type | string | Required | Specify the OAuth delegation type(s) to target: 'mobile' for mobile app or 'web' for web app sign-out. Multiple types can be separated by commas, for example, 'mobile,web'. |
user_identifier | string | Required | The unique ID of the user whose OAuth delegations will be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteOauthDelegations'.PagerdutyApi.DeletePagerdutySessionConfigurations
Delete session configurations for a PagerDuty account. This tool deletes specific session configurations ('mobile' or 'web') for a PagerDuty account. It should be called when there's a need to remove these configurations. The tool requires the 'session-configurations-early-access' header for early access and scoped OAuth with `session_configurations.write` permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
session_configuration_type | string | Required | Specify 'mobile', 'web', or a comma-separated list of both to define which session configurations to delete. |
Requirements
Output
json— Response from the API endpoint 'deleteSessionConfigurations'.PagerdutyApi.DeletePostmortem
Deletes a postmortem from a status page post by ID. Use this tool to remove a postmortem linked to a specific status page post using the post's ID. This operation requires scoped OAuth with `status_pages.write` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the resource to delete. |
status_page_post_id | string | Required | The unique identifier for the status page post whose postmortem you want to delete. |
Requirements
Output
json— Response from the API endpoint 'deleteStatusPagePostmortem'.PagerdutyApi.DeleteRuleset
Delete an existing ruleset in PagerDuty. Use this tool to delete a specified ruleset in PagerDuty. Note that rulesets and event rules are nearing end-of-life, and it's recommended to migrate to Event Orchestration for enhanced features. Ensure you have the appropriate OAuth scope: 'event_rules.write'.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ruleset_id | string | Required | The unique identifier of the ruleset to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteRuleset'.PagerdutyApi.DeleteSchedule
Delete an on-call schedule. Use this tool to delete an on-call schedule, which defines when users are on call. This action requires scoped OAuth with 'schedules.write' permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
schedule_id | string | Required | The unique identifier for the schedule to delete. |
Requirements
Output
json— Response from the API endpoint 'deleteSchedule'.PagerdutyApi.DeleteScheduleOverride
Remove or truncate an on-call schedule override. Use this tool to remove a schedule override if it hasn't started, or truncate it if it's currently active. Overrides with start times before now but end times in the future are shortened to the current time. Successful deletion returns a 204 status, while truncation returns a 200 status.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
override_id | string | Required | The unique identifier for the schedule override to be deleted or truncated. |
resource_id | string | Required | The unique identifier for the schedule to remove or truncate the override from. |
Requirements
Output
json— Response from the API endpoint 'deleteScheduleOverride'.PagerdutyApi.DeleteService
Remove a service to prevent new incident creation. Use this tool to delete an existing service from PagerDuty. Once deleted, the service will no longer be accessible via the web UI, and new incidents cannot be created for it. Typically used for applications, components, or teams no longer needing incident management.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_id | string | Required | The unique ID of the service to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteService'.PagerdutyApi.DeleteServiceCacheVariable
Delete a cache variable for a service event orchestration. Use this tool to delete a cache variable associated with a service event orchestration. This operation helps manage event data by removing unnecessary or outdated cache variables connected to event orchestration rules. Ensure scoped OAuth with `services.write` is enabled.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cache_variable_id | string | Required | The unique identifier for the cache variable to be deleted in the service event orchestration. |
service_identifier | string | Required | The unique identifier for the service related to the event orchestration. |
Requirements
Output
json— Response from the API endpoint 'deleteCacheVarOnServiceOrch'.PagerdutyApi.DeleteServiceCustomField
Deletes a custom field from a service. Use this tool to delete a custom field from a service in PagerDuty. This action requires 'custom_fields.write' permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
field_id | string | Required | The ID of the custom field you want to delete from the service. |
Requirements
Output
json— Response from the API endpoint 'deleteServiceCustomField'.PagerdutyApi.DeleteServiceCustomFieldOption
Delete a custom field option from a service. Use this tool to remove a specific custom field option associated with a service in PagerDuty. This is useful when you need to manage or update service configurations by deleting unnecessary or outdated options.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
field_identifier | string | Required | The ID of the field to be deleted from the service. |
field_option_id | string | Required | The unique identifier for the custom field option to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteServiceCustomFieldOption'.PagerdutyApi.DeleteServiceEventRule
Delete an event rule from a service in PagerDuty. Use this tool to delete a specific event rule from a service using its service and rule IDs. Note that event rules will soon be deprecated, and migration to Event Orchestration is recommended.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_rule_id | string | Required | The ID of the Event Rule to be deleted. Use this to specify which rule to remove. |
service_id | string | Required | The unique identifier of the service resource from which to delete the event rule. |
Requirements
Output
json— Response from the API endpoint 'deleteServiceEventRule'.PagerdutyApi.DeleteStatusPagePost
Delete a post from a status page using its ID. Use this tool to delete a specific post from a status page by providing the status page ID and post ID. Requires appropriate OAuth permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status_page_id | string | Required | The unique identifier for the status page from which the post will be deleted. |
status_page_post_id | string | Required | The unique identifier for the Status Page Post to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteStatusPagePost'.PagerdutyApi.DeleteStatusPagePostUpdate
Delete a specific post update on PagerDuty. Use this tool to delete a post update for a specific post on PagerDuty's status page by providing the post ID and post update ID. Requires appropriate OAuth permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique ID of the resource to be deleted. |
status_page_post_id | string | Required | The ID of the Status Page Post to identify the specific post. |
status_page_post_update_id | string | Required | The unique ID of the status page post update to delete. |
Requirements
Output
json— Response from the API endpoint 'deleteStatusPagePostUpdate'.PagerdutyApi.DeleteStatusPageSubscription
Delete a status page subscription by ID. Use this tool to delete a subscription for a specific status page by providing the status page ID and subscription ID. It requires the 'status_pages.write' permission with scoped OAuth.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the status page resource to delete the subscription from. |
status_page_subscription_id | string | Required | The unique identifier for the specific status page subscription to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteStatusPageSubscription'.PagerdutyApi.DeleteTeamInPagerduty
Delete an existing team in PagerDuty. This tool removes an existing team in PagerDuty if it has no associated Escalation Policies, Services, Schedules, and Subteams. Unresolved incidents will be reassigned or become account-level.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_id | string | Required | The unique identifier of the team to be deleted in PagerDuty. |
reassignment_team_id | string | Optional | The ID of the team to reassign unresolved incidents. If omitted, incidents will become account-level. |
Requirements
Output
json— Response from the API endpoint 'deleteTeam'.PagerdutyApi.DeleteTemplate
Delete a specific template on the PagerDuty account. Use this tool to delete a specified template from the account. Appropriate for managing and maintaining template resources in PagerDuty. Requires "templates.write" OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
template_id | string | Required | The ID of the template resource to delete from the PagerDuty account. Required for deletion. |
Requirements
Output
json— Response from the API endpoint 'deleteTemplate'.PagerdutyApi.DeleteUserHandoffNotificationRule
Remove a handoff notification rule for a PagerDuty user. Use this tool to delete a specific on-call handoff notification rule for a user in a PagerDuty account. Requires appropriate OAuth permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
oncall_handoff_notification_rule_id | string | Required | The unique ID of the on-call handoff notification rule to be deleted for the user. |
user_resource_id | string | Required | The ID of the user resource to delete the handoff notification rule from. Required for identifying the user. |
Requirements
Output
json— Response from the API endpoint 'deleteUserHandoffNotificationRule'.PagerdutyApi.DeleteWebhookSubscription
Delete a webhook subscription in PagerDuty. Use this tool to delete a webhook subscription in PagerDuty when it is no longer needed. Ensure you have the necessary OAuth scope (`webhook_subscriptions.write`) to perform this operation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier for the webhook subscription to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteWebhookSubscription'.PagerdutyApi.DeleteWorkflowIntegrationConnection
Delete a Workflow Integration Connection on PagerDuty. Use this tool to remove a specific workflow integration connection from PagerDuty. Ideal for scenarios where you need to manage or clean up integration settings. Requires appropriate OAuth permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier for the resource to be deleted. |
workflow_integration_id | string | Required | The unique ID of the Workflow Integration to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteWorkflowIntegrationConnection'.PagerdutyApi.DisassociateAutomationActionFromService
Disassociate an Automation Action from a service. Use this tool to remove the association between an Automation Action and a specific service in PagerDuty. Call this tool when you need to unlink an action from a service for organizational or operational purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the resource to disassociate. |
service_id | string | Required | The unique identifier of the service to be disassociated from the automation action. This should be provided as a string. |
Requirements
Output
json— Response from the API endpoint 'deleteAutomationActionServiceAssociation'.PagerdutyApi.DisassociateAutomationActionFromTeam
Disassociate an automation action from a team in PagerDuty. Use this tool to disassociate a specified automation action from a specific team in PagerDuty. Useful for removing team associations with automation actions when they are no longer needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The ID of the automation action to disassociate from the team. |
team_id | string | Required | The unique identifier of the team to be disassociated from an automation action. |
Requirements
Output
json— Response from the API endpoint 'deleteAutomationActionTeamAssociation'.PagerdutyApi.DisassociateRunnerFromTeam
Disassociate a runner from a team in PagerDuty. Call this tool to remove the association between a runner and a team within the PagerDuty platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique ID of the resource to be disassociated from the team. This is required to identify the runner. |
team_id | string | Required | The unique identifier for the team from which the runner will be disassociated. |
Requirements
Output
json— Response from the API endpoint 'deleteAutomationActionsRunnerTeamAssociation'.PagerdutyApi.EnablePagerdutyExtension
Enable a disabled extension on PagerDuty. Use this tool to enable an extension on PagerDuty that is currently disabled. This is useful for reactivating an extension connected to a service without requiring additional input data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique ID of the PagerDuty extension to enable. |
Requirements
Output
json— Response from the API endpoint 'enableExtension'.PagerdutyApi.EnableWebhookSubscription
Enable a temporarily disabled webhook subscription. Use this tool to enable a webhook subscription that has been temporarily disabled due to repeated delivery method rejections by the server.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier for the webhook subscription to be enabled. |
Requirements
Output
json— Response from the API endpoint 'enableWebhookSubscription'.PagerdutyApi.FetchIncidentLogs
Retrieve all incident log entries across the account. This tool lists all the incident log entries, detailing events that occur for each incident across the entire account. Useful for tracking and analyzing incident-related activities.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
additional_models_to_include | string | Optional | Specify additional models to include in the response, such as incidents, services, channels, or teams. |
include_total_in_pagination | boolean | Optional | Set to true to populate the total field in pagination responses. Set to false for faster response times. |
pagination_offset | integer | Optional | Offset to start pagination in search results. Used for navigating through large datasets. |
render_results_in_time_zone | string | Optional | Time zone for rendering results. Defaults to the account time zone if not specified. |
results_per_page | integer | Optional | Specifies the number of results returned per page. |
return_important_changes_only | boolean | Optional | If true, return only the most important changes to the incident in log entries. |
search_end_date | string | Optional | The end date for the search range. Specify in YYYY-MM-DD format. |
start_date_range | string | Optional | Specify the start date for the search range. Format: YYYY-MM-DD. |
team_ids | array<string> | Optional | Array of team IDs to filter log entries. Requires 'teams' ability on the account. |
Requirements
Output
json— Response from the API endpoint 'listLogEntries'.PagerdutyApi.FetchIncidentMetrics
Get aggregated metrics across all escalation policies. This tool retrieves aggregated metrics related to escalation policies, including Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metrics are updated periodically and may take up to 24 hours to reflect new incidents. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'getAnalyticsMetricsIncidentsEscalationPolicyAll'.PagerdutyApi.FetchResponderTeamMetrics
Fetch incident metrics for team responders. This tool provides aggregated incident metrics for responders on a team, such as Seconds to Resolve and Sleep Hour Interruptions. It should be called when detailed performance insights are needed for team members handling incidents. Metrics are updated periodically. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'getAnalyticsMetricsRespondersTeam'.PagerdutyApi.GetAccountAbilities
Retrieve your account's available abilities by feature name. Use this tool to get a list of the features or capabilities available on your account, such as 'teams'. The availability of these abilities may depend on factors like your pricing plan or account status.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listAbilities'.PagerdutyApi.GetAccountStandards
Retrieve all standards of an account. Use this tool to get a comprehensive list of standards associated with a PagerDuty account. Useful for understanding the compliance and operational guidelines in place. Requires OAuth scope: `standards.read`.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
active_standards_only | boolean | Optional | Set to true to include only active standards. Set to false to include both active and inactive standards. |
resource_type_filter | string | Optional | Specify the type of resource to filter standards. Must be 'technical_service'. |
Requirements
Output
json— Response from the API endpoint 'listStandards'.PagerdutyApi.GetAddonDetails
Retrieve detailed information about a PagerDuty add-on. This tool retrieves details about a specific add-on within PagerDuty. Add-ons are extensions that add new functionality to PagerDuty's UI. Use this tool when you need information about a particular add-on. Requires `addons.read` OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
addon_id | string | Required | The unique ID of the PagerDuty add-on to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'getAddon'.PagerdutyApi.GetAggregatedIncidentMetrics
Retrieve aggregated incident metrics across all services. This tool provides aggregated metrics for incidents such as resolution time, engagement time, and more, across all services in PagerDuty. Requires `team_ids` or `service_ids` filter for certain API keys. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'getAnalyticsMetricsIncidentsServiceAll'.PagerdutyApi.GetAlertGroupingSetting
Retrieve an existing alert grouping setting. Use this tool to get details of a specific alert grouping setting. It is useful when you need to understand or verify the configuration of alert grouping within the PagerDuty service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier for the alert grouping setting you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getAlertGroupingSetting'.PagerdutyApi.GetAnalyticsMetricsForAllTeams
Fetches aggregated incident metrics across all teams. This tool provides aggregated metrics for incidents across all teams, including metrics like Seconds to Resolve and Sleep Hour Interruptions. Ideal for understanding team performance and incident impacts. Ensure to use team_ids or service_ids filters with user-level API keys unless using account-level keys. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'getAnalyticsMetricsIncidentsTeamAll'.PagerdutyApi.GetAnalyticsMetricsPdAdvanceUsage
Retrieve aggregated metrics for PD Advance usage. This tool provides aggregated metrics for the usage of PD Advance. It should be called when you need insights or reports about PD Advance features usage. Note that analytics data is updated periodically and may take up to 24 hours to reflect new incidents. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'getAnalyticsMetricsPdAdvanceUsageFeatures'.PagerdutyApi.GetAutomationAction
Retrieve details of a specific automation action. This tool is used to get details of a specific automation action by its ID in PagerDuty.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier for the automation action to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getAutomationAction'.PagerdutyApi.GetAutomationActionInvocation
Retrieve details of an automation action invocation. This tool is used to obtain detailed information about a specific automation action invocation by its ID. Call this tool when you need to track or review an action performed through PagerDuty's automation services.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the automation action resource to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getAutomationActionsInvocation'.PagerdutyApi.GetAutomationActionRunner
Retrieve details of an Automation Action runner by ID. This tool fetches information about a specific Automation Action runner from PagerDuty based on the provided ID. Use it to get runner details when managing or monitoring automation actions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier for the Automation Action runner to retrieve details. |
Requirements
Output
json— Response from the API endpoint 'getAutomationActionsRunner'.PagerdutyApi.GetAutomationActionServiceAssociation
Retrieve details of an Automation Action and service relation. Call this tool to get information about the relationship between a specific Automation Action and a service on PagerDuty.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The ID of the resource to retrieve details about. This identifies the specific Automation Action. |
service_identifier | string | Required | The unique identifier for the service to retrieve its relation with the Automation Action. |
Requirements
Output
json— Response from the API endpoint 'getAutomationActionsActionServiceAssociation'.PagerdutyApi.GetAutomationActionTeamAssociation
Retrieve details of an Automation Action and team relationship. This tool retrieves the details of a relationship between a specific Automation Action and a team within PagerDuty. It should be called when you need to understand or verify the association details between an action and a team.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique ID of the resource (Automation Action) to retrieve details for. |
team_id | string | Required | The unique identifier for the team associated with the Automation Action. |
Requirements
Output
json— Response from the API endpoint 'getAutomationActionsActionTeamAssociation'.PagerdutyApi.GetBusinessServiceDependencies
Retrieve immediate dependencies of a Business Service. This tool retrieves all immediate dependencies of a specified Business Service in PagerDuty. It models capabilities that span multiple technical services and may be owned by various teams. Appropriate for understanding service dependencies in a business context.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_id | string | Required | The ID of the Business Service to retrieve its dependencies. |
Requirements
Output
json— Response from the API endpoint 'getBusinessServiceServiceDependencies'.PagerdutyApi.GetBusinessServiceDetails
Retrieve details about a specific Business Service. This tool retrieves comprehensive details about a Business Service in PagerDuty, which models capabilities across technical services and teams.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
business_service_id | string | Required | The ID of the business service to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'getBusinessService'.PagerdutyApi.GetBusinessServiceImpacts
Get top-level Business Services sorted by highest impact. Retrieve the most impacted Business Services, up to 200, with their status. The service list is sorted by impact, recency, and name. For specific services, use the `ids[]` parameter. Requires 'services.read' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
business_service_ids | string | Optional | A list of specific Business Service IDs to retrieve impact information for. |
include_additional_fields | string | Optional | Specify additional fields to include, such as 'services.highest_impacting_priority' or 'total_impacted_count'. |
Requirements
Output
json— Response from the API endpoint 'getBusinessServiceImpacts'.PagerdutyApi.GetBusinessServiceSubscribers
Retrieve notification subscribers of a business service. Fetches a list of notification subscribers for a specified business service. Use this tool when you need to find out who is subscribed to notifications for a particular service. Ensure users were added as subscribers via the appropriate POST method.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
business_service_id | string | Required | The unique identifier for the business service to retrieve subscribers. |
Requirements
Output
json— Response from the API endpoint 'getBusinessServiceSubscribers'.PagerdutyApi.GetCacheVariableGlobalEvent
Retrieve a cache variable for a global event orchestration. This tool retrieves a cache variable associated with a global event orchestration. It is useful for accessing stored event data that can be utilized in orchestration rules. Appropriate for cases where event orchestration data is required for condition or action setups.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cache_variable_identifier | string | Required | The unique identifier for a Cache Variable in a global event orchestration. |
event_orchestration_id | string | Required | The ID of the event orchestration to retrieve the cache variable from. |
Requirements
Output
json— Response from the API endpoint 'getCacheVarOnGlobalOrch'.PagerdutyApi.GetChangeEventDetails
Retrieve detailed information about a Change Event. Use this tool to get details about a specific Change Event by providing its ID. Useful for tracking or analyzing changes in your system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
change_event_id | string | Required | The unique identifier of the Change Event to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'getChangeEvent'.PagerdutyApi.GetCurrentUserDetails
Retrieves details about the current PagerDuty user. This tool fetches information about the current user logged into PagerDuty. It requires a user-level API key or an OAuth-generated key. Utilize this tool to obtain user details such as permissions and membership within the PagerDuty account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
additional_models_to_include | string | Optional | Specifies additional models, such as contact methods or teams, to include in the response. Options: contact_methods, notification_rules, teams, subdomains. |
Requirements
Output
json— Response from the API endpoint 'getCurrentUser'.PagerdutyApi.GetCustomFieldOption
Retrieve a specific custom field option for an incident type. This tool retrieves details of a specific field option within a custom field for a given incident type in PagerDuty. Custom fields allow users to extend incidents with custom data for filtering, search, and analytics. Use this tool when you need to access a particular field option of a custom field associated with an incident type.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
field_id | string | Required | The ID of the custom field for which the field option details are retrieved. This ID specifies the field within the incident type. |
field_option_id | string | Required | The unique identifier for the field option within a custom field. Used to retrieve specific option details. |
incident_type_identifier | string | Required | The ID or name of the incident type for which the custom field option is to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'getIncidentTypeCustomFieldFieldOptions'.PagerdutyApi.GetCustomFieldValues
Retrieve custom field values for a specific incident. This tool is used to obtain custom field values for a given incident on PagerDuty. It should be called when you need detailed field information about a specific incident using its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_id | string | Required | The unique identifier for the incident whose custom field values are being requested. |
Requirements
Output
json— Response from the API endpoint 'getIncidentFieldValues'.PagerdutyApi.GetEnrichedIncidentData
Retrieve enriched incident metrics for a specific incident. This tool provides enriched incident data including metrics like Seconds to Resolve, Seconds to Engage, and Snoozed Seconds. Suitable for analyzing incident performance and response times. Data is updated periodically and may take up to 24 hours to reflect new incidents.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_id | string | Required | The unique identifier for the incident to retrieve analytics for. |
Requirements
Output
json— Response from the API endpoint 'getAnalyticsIncidentsById'.PagerdutyApi.GetEscalationPolicy
Retrieve details of an escalation policy and its rules. Use this tool to get information about a specific escalation policy, including which users are alerted and when. This is useful for understanding alert management configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the escalation policy to retrieve. |
include_models | string | Optional | Specify additional models to include in the response, such as services, teams, or targets. |
Requirements
Output
json— Response from the API endpoint 'getEscalationPolicy'.PagerdutyApi.GetEscalationPolicyAuditRecords
Retrieve audit records for a specific escalation policy. This tool fetches the audit records of a specified escalation policy from newest to oldest. It is useful for tracking changes and understanding historical actions related to escalation policies in PagerDuty. Ensure OAuth scope 'audit_records.read' is granted.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | Identifier for the escalation policy to retrieve audit records for. |
end_date_of_search | string | Optional | The end date of the search range. Defaults to now if not specified. Cannot exceed 31 days after the start date. |
next_cursor | string | Optional | A string used to fetch the next set of results. Obtain from the `next_cursor` of the previous request. If empty, it starts from the beginning of the result set. |
result_limit | integer | Optional | Specifies the maximum number of audit records to return. It's the smaller of the provided limit or the API's max size. |
start_date_for_audit_search | string | Optional | The start date for the audit record search. If not specified, defaults to 24 hours ago. |
Requirements
Output
json— Response from the API endpoint 'listEscalationPolicyAuditRecords'.PagerdutyApi.GetEscalationPolicyMetrics
Get aggregated incident metrics by escalation policy. This tool provides aggregated metrics for incidents categorized by escalation policy. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. It's useful for analyzing response times and interruptions based on policy. Note that data updates can take up to 24 hours. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'getAnalyticsMetricsIncidentsEscalationPolicy'.PagerdutyApi.GetEventRule
Retrieve details of an event rule from a ruleset. Use this tool to get information about a specific event rule within a ruleset on PagerDuty. Note that rulesets and event rules will be phased out soon, and migrating to Event Orchestration is recommended. This tool requires event_rules.read OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_rule_id | string | Required | The ID of the Event Rule to retrieve from a ruleset. |
resource_id | string | Required | The unique ID of the resource to retrieve details for. This is required to specify which resource's event rule details are needed. |
Requirements
Output
json— Response from the API endpoint 'getRulesetEventRule'.PagerdutyApi.GetEventRuleFromService
Retrieve an event rule from a specified service. This tool retrieves details of a specific event rule from a given service in PagerDuty. It is important to migrate to Event Orchestration for enhanced features.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_rule_id | string | Required | The ID of the event rule to retrieve from the specified service. |
resource_id | string | Required | The unique identifier of the service resource to retrieve the event rule for. |
Requirements
Output
json— Response from the API endpoint 'getServiceEventRule'.PagerdutyApi.GetExtensionDetails
Retrieve details about a specific extension on PagerDuty. Use this tool to obtain information about an existing extension associated with a service in PagerDuty. Useful for understanding extension configurations and their properties.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the extension resource to retrieve details for. |
include_additional_details | string | Optional | Specify additional details to include, such as 'extension_schemas', 'extension_objects', or 'temporarily_disabled'. |
Requirements
Output
json— Response from the API endpoint 'getExtension'.PagerdutyApi.GetExtensionVendorDetails
Retrieve details of a specific PagerDuty extension vendor. Use this tool to get detailed information about a particular extension vendor in PagerDuty, such as Generic Webhook, Slack, or ServiceNow. This can help in understanding the capabilities and characteristics of a specific vendor.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier for the extension vendor resource. |
Requirements
Output
json— Response from the API endpoint 'getExtensionSchema'.PagerdutyApi.GetExternalDataCacheVar
Retrieve external data Cache Variable data from Global Orchestration. Use this tool to obtain the data for an external data type Cache Variable on a Global Orchestration. These variables store string, number, or boolean values, which can be used in event orchestration conditions or actions. Requires `event_orchestrations.read` OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cache_variable_id | string | Required | Provide the ID of the Cache Variable whose data you want to retrieve. |
event_orchestration_id | string | Required | The unique identifier of an Event Orchestration to retrieve its cache variable data. |
Requirements
Output
json— Response from the API endpoint 'getExternalDataCacheVarDataOnGlobalOrch'.PagerdutyApi.GetGlobalEventOrchestration
Retrieve details of a Global Event Orchestration by ID. Fetches information about a specific Global Event Orchestration including its Global Rules and Router Rules, allowing you to understand how events are processed and routed based on their content.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_orchestration_id | string | Required | The unique identifier for the Event Orchestration to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'getOrchestration'.PagerdutyApi.GetGlobalOrchestrationRoutingRules
Retrieve Global Orchestration's routing rules from PagerDuty. This tool retrieves the routing rules for a specified Global Orchestration in PagerDuty. It evaluates events against these rules to determine routing to a specific service. If no rules match, events are sent to a default service or an "Unrouted" Orchestration. This is useful for understanding event pathways and ensuring proper event management and routing.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_orchestration_id | string | Required | The ID of the Event Orchestration to retrieve routing rules for. |
Requirements
Output
json— Response from the API endpoint 'getOrchPathRouter'.PagerdutyApi.GetGlobalOrchestrationRules
Retrieve global orchestration rules for an event. This tool fetches the global orchestration rules for a specified event orchestration, which contains a set of event rules applicable to all incoming events. These rules can modify, enhance, and route the event for further processing.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_orchestration_id | string | Required | The ID of the specific Event Orchestration to retrieve rules for. |
Requirements
Output
json— Response from the API endpoint 'getOrchPathGlobal'.PagerdutyApi.GetImpactedBusinessServices
Retrieve business services impacted by an incident. This tool retrieves a list of business services that are being impacted by a specified incident in PagerDuty. It should be called when you need to understand which business services are affected by a particular incident using the incident ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_id | string | Required | The ID of the incident to retrieve impacted business services for. |
Requirements
Output
json— Response from the API endpoint 'getIncidentImpactedBusinessServices'.PagerdutyApi.GetImpactedServicesDashboard
Get most impacted Business Services for a Status Dashboard. Use this tool to retrieve the most impacted Business Services for a specific Status Dashboard by ID. It returns a list sorted by impact level, recency, and name, up to a limit of 200 services.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status_dashboard_id | string | Required | The ID of the Status Dashboard to fetch impacted Business Services for. |
include_additional_fields | string | Optional | Specify additional fields to include, like highest impacting priority or total impacted count. Use values: 'services.highest_impacting_priority' or 'total_impacted_count'. |
Requirements
Output
json— Response from the API endpoint 'getStatusDashboardServiceImpactsById'.PagerdutyApi.GetIncidentAlertDetails
Retrieve detailed information about a specific alert. This tool provides detailed information about an alert using its alert ID. It is used when there is a need to know more about a particular problem or issue represented by an alert in PagerDuty.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
alert_identifier | string | Required | The unique identifier of the alert to retrieve details for. |
resource_id | string | Required | The unique identifier for the resource. This ID is used to fetch specific alert details in PagerDuty. |
Requirements
Output
json— Response from the API endpoint 'getIncidentAlert'.PagerdutyApi.GetIncidentAnalytics
Fetch enriched incident metrics and data from PagerDuty Analytics. Use this tool to retrieve detailed metrics and data for multiple incidents, such as Seconds to Resolve and Sleep Hour Interruptions. A `team_ids` or `service_ids` filter is needed for certain API keys. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'getAnalyticsIncidents'.PagerdutyApi.GetIncidentAnalyticsMetrics
Retrieve aggregated incident metrics by service over time. This tool provides aggregated metrics for PagerDuty incidents, such as Seconds to Resolve and Sleep Hour Interruptions, aggregated by service and time units like day, week, or month. It helps users analyze incident management performance over specified periods. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'getAnalyticsMetricsIncidentsService'.PagerdutyApi.GetIncidentDetails
Retrieve detailed information about a PagerDuty incident. Use this tool to get comprehensive details of a specific incident by providing its ID or number, helping to address and resolve issues effectively.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_id | string | Required | The unique identifier for the specific incident. Include either the incident ID or number to retrieve details. |
include_details | string | Optional | List of additional incident details to include, such as 'acknowledgers', 'agents', 'assignees', etc. |
Requirements
Output
json— Response from the API endpoint 'getIncident'.PagerdutyApi.GetIncidentLogEntryDetails
Retrieve detailed information about a specific incident log entry. This tool is used to obtain detailed information for a specific incident log entry from PagerDuty. It is useful for accessing raw event data related to incidents. This action requires the 'incidents.read' OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the incident log entry to retrieve details for. |
additional_models_to_include | string | Optional | List of additional models like 'incidents', 'services', 'channels', or 'teams' to include in the response. |
render_results_in_time_zone | string | Optional | Specify the time zone for rendering the results. Defaults to the account's time zone if not provided. |
Requirements
Output
json— Response from the API endpoint 'getLogEntry'.PagerdutyApi.GetIncidentMetrics
Retrieve aggregated metrics for PagerDuty incidents. This tool provides aggregated enriched metrics for incidents in PagerDuty. It allows aggregation by day, week, or month, or for the entire specified period. A filter with `team_ids` or `service_ids` is required for user-level API keys. Use this tool to analyze incident trends and performance over time. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'getAnalyticsMetricsIncidentsAll'.PagerdutyApi.GetIncidentNotificationSubscribers
Retrieve a list of notification subscribers for an incident. This tool retrieves the list of users subscribed to receive notifications for a specific incident. It should be called when you need to know who is subscribed to an incident's updates. Note: Users must be added through another endpoint to appear here. Requires appropriate OAuth permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_id | string | Required | The unique identifier of the incident resource. |
Requirements
Output
json— Response from the API endpoint 'getIncidentNotificationSubscribers'.PagerdutyApi.GetIncidentResponseAnalytics
Provides enriched responder data for a single incident. Use this tool to obtain detailed analytics on a specific incident's responder data, such as Time to Respond, Responder Type, and Response Status. Note that analytics data is updated daily and may take up to 24 hours to appear.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_id | string | Required | The ID of the incident to retrieve analytics for. |
display_order | string | Optional | Specifies the order to display results: 'asc' for ascending, 'desc' for descending. Defaults to 'desc'. |
order_results_by_column | string | Optional | Specify the column to use for ordering the results, such as 'requested_at'. |
results_limit | integer | Optional | The number of results to include in each batch. Acceptable values range from 1 to 1000. |
time_zone_for_results | string | Optional | The time zone to use for displaying the results. |
Requirements
Output
json— Response from the API endpoint 'getAnalyticsIncidentResponsesById'.PagerdutyApi.GetIncidentTypeCustomField
Retrieve a custom field for a specific incident type. Use this tool to obtain custom fields associated with a specific incident type, enhancing incident details with user-defined data for filtering, search, and analytics.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
field_id | string | Required | The ID of the custom field to retrieve for the incident type. |
incident_type_id_or_name | string | Required | The ID or name of the Incident Type for which to retrieve the custom field. |
include_field_details | string | Optional | Specify additional details, such as 'field_options', to include in the response. |
Requirements
Output
json— Response from the API endpoint 'getIncidentTypeCustomField'.PagerdutyApi.GetIncidentTypeDetails
Retrieve detailed information on a specific incident type. This tool fetches detailed information about a single incident type using either an incident type ID or name. It helps categorize incidents such as security or major incidents. Use this tool to get insights on incident categorization in your system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_type_identifier | string | Required | The ID or name of the Incident Type to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'getIncidentType'.PagerdutyApi.GetIncidentWorkflow
Retrieve an existing Incident Workflow. This tool retrieves the details of an existing Incident Workflow, which consists of configurable Steps and associated Triggers for automated Actions related to an Incident. Use this to understand or manage incident responses more effectively.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_workflow_id | string | Required | The ID of the Incident Workflow to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'getIncidentWorkflow'.PagerdutyApi.GetIncidentWorkflowAction
Retrieve details of an incident workflow action. Use this tool to obtain information about a specific incident workflow action in PagerDuty. Ideal for scenarios where you need to understand or display workflow details based on an ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique ID of the incident workflow action to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getIncidentWorkflowAction'.PagerdutyApi.GetIncidentWorkflowTrigger
Retrieve an existing Incident Workflows Trigger. Call this tool to get details about a specific Incident Workflows Trigger using its ID. Useful for obtaining information on workflow triggers in incident management systems.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_workflow_trigger_id | string | Required | The unique ID of the Incident Workflow Trigger to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'getIncidentWorkflowTrigger'.PagerdutyApi.GetIntegrationDetails
Retrieve details of an orchestration integration. Use this tool to obtain details about a specific integration associated with event orchestrations in PagerDuty. This can help in managing event routing using the provided integration's routing key. Requires 'event_orchestrations.read' OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_orchestration_id | string | Required | The ID of the Event Orchestration to retrieve integration details for. |
integration_id | string | Required | The ID of the integration to retrieve details for within an event orchestration in PagerDuty. |
Requirements
Output
json— Response from the API endpoint 'getOrchestrationIntegration'.PagerdutyApi.GetLatestTeamAuditRecords
Retrieve the latest audit records for a specific team. Use this tool to get a sorted list of the most recent audit records for a team, from newest to oldest. This is useful for monitoring team activities and changes. For handling large data sets, utilize cursor-based pagination as detailed in PagerDuty's documentation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the team or resource for which you want to retrieve audit records. This ID specifies which team's audit records to retrieve. |
end_date_for_search_range | string | Optional | The end date of the search range. Defaults to current date if not specified, and must be within 31 days of the 'since' date. |
next_results_cursor | string | Optional | Cursor for fetching the next set of results. Obtained from the `next_cursor` of a previous request. Starts from the beginning if not provided. |
number_of_records_limit | integer | Optional | Specify the maximum number of audit records to retrieve in the request. |
start_date_range | string | Optional | The date from which to start searching audit records. Defaults to 24 hours ago if not specified. |
Requirements
Output
json— Response from the API endpoint 'listTeamsAuditRecords'.PagerdutyApi.GetMaintenanceWindow
Retrieve details of an existing maintenance window in PagerDuty. Use this tool to get information about a specific maintenance window, which temporarily disables one or more services during a set period.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
maintenance_window_id | string | Required | The unique identifier of the maintenance window to retrieve. |
include_models | string | Optional | Array of additional models to include in the response. Options are 'teams', 'services', or 'users'. |
Requirements
Output
json— Response from the API endpoint 'getMaintenanceWindow'.PagerdutyApi.GetOauthClientDetails
Retrieve details of a specific OAuth client by ID. This tool is used to obtain detailed information about a specific OAuth client using its ID. It requires admin or owner role permissions to access this information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
oauth_client_id | string | Required | The unique identifier of the OAuth client to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'getOauthClient'.PagerdutyApi.GetOutlierIncidentInfo
Retrieve information about an outlier incident for a service. Use this tool to get detailed information about an outlier incident associated with a specified incident on its service. Requires appropriate OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_resource_id | string | Required | The unique identifier for the incident resource you want details about. |
include_additional_incident_details | string | Optional | Include additional attributes for related incidents, specified as strings. |
start_date_range | string | Optional | The start date for the search range in YYYY-MM-DD format. |
Requirements
Output
json— Response from the API endpoint 'getOutlierIncident'.PagerdutyApi.GetPausedIncidentReportAlerts
Retrieve recent paused incident report alerts. Fetches the 5 most recent alerts triggered and resolved after being paused within a maximum 6-month period. Available with Event Intelligence or Digital Operations plan.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
end_date_range | string | Optional | The end date for the search range to retrieve alerts. Must be within 6 months. |
filter_by_suspend_method | string | Optional | Filter alerts by suspension type: 'Auto Pause' or 'Event Rules'. |
service_identifier | string | Optional | Filter reports to a specific service by providing its service ID. |
start_date | string | Optional | The start date for the search range. It should be in ISO 8601 format (YYYY-MM-DD). |
Requirements
Output
json— Response from the API endpoint 'getPausedIncidentReportAlerts'.PagerdutyApi.GetPausedIncidentReportCounts
Retrieve reporting counts for paused incident usage. This tool returns reporting counts for paused incident usage within a specified reporting period, up to a 6-month lookback. It is available with the Event Intelligence package or Digital Operations plan.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
end_date | string | Optional | End date for the date range over which to search for paused incident reports. Format: YYYY-MM-DD. |
filter_by_suspended_type | string | Optional | Filter to specify whether to include alerts suspended by Auto Pause or Event Rules. Use 'Auto Pause' or 'Event Rules'. |
service_identifier | string | Optional | Filter to limit reporting to a particular service by providing a specific service ID. |
start_date | string | Optional | The start date for the reporting period to search, in YYYY-MM-DD format. |
Requirements
Output
json— Response from the API endpoint 'getPausedIncidentReportCounts'.PagerdutyApi.GetPostmortemByPostId
Retrieve postmortem details using post ID. Use this tool to get detailed postmortem information for a specific post using its Post ID on PagerDuty. This is useful for obtaining insights and summaries related to incidents.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier for the resource. Used to retrieve the specific postmortem information. |
status_page_post_id | string | Required | The ID of the Status Page Post to retrieve postmortem details. |
Requirements
Output
json— Response from the API endpoint 'getPostmortem'.PagerdutyApi.GetPostUpdate
Retrieve specific post updates by post and update IDs. Use this tool to get detailed information about a specific post update from a status page, using the specified post and update IDs. Scoped OAuth with `status_pages.read` is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
post_update_id | string | Required | The ID of the Status Page Post Update required for fetching specific update details. |
resource_id | string | Required | The unique identifier for the resource to retrieve the post update. |
status_page_post_id | string | Required | The unique identifier for the Status Page Post to retrieve updates for. |
Requirements
Output
json— Response from the API endpoint 'getPostUpdate'.PagerdutyApi.GetPriorityThresholds
Retrieve priority threshold details for an account. This tool retrieves the priority threshold information set for an account, including the global threshold impacting business services. It helps determine which incidents are considered impactful based on their priority.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'getBusinessServicePriorityThresholds'.PagerdutyApi.GetResourceStandards
Retrieve standards applied to a specified resource on PagerDuty. Use this tool to get a list of standards that are applied to a specified resource type and ID on PagerDuty. Requires 'standards.read' OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The ID of the resource for which you want to list the applied standards. |
resource_type | string | Required | Specify the type of resource to which standards are applied, such as 'technical_services'. |
Requirements
Output
json— Response from the API endpoint 'listResourceStandards'.PagerdutyApi.GetResponderIncidentAnalytics
Retrieve enriched incident metrics for a specific responder. Provides detailed incident data and metrics such as Mean Resolve Time, Mean Engage Time, and more for a specified responder. Useful for analyzing responder performance. Note: Data updates every 24 hours. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
responder_id | string | Optional | The unique identifier of the responder whose incident metrics are to be retrieved. It is required to specify which responder's data is needed. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'getAnalyticsResponderIncidents'.PagerdutyApi.GetRuleset
Retrieve details of a ruleset from PagerDuty. Fetch information about a specific ruleset, including event routing and actions. Useful for understanding or managing event rules within a ruleset. Note: Rulesets and Event Rules will be deprecated soon; consider migrating to Event Orchestration.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ruleset_id | string | Required | The unique identifier for the ruleset to retrieve from PagerDuty. |
Requirements
Output
json— Response from the API endpoint 'getRuleset'.PagerdutyApi.GetRunnerTeamAssociation
Retrieve details of a runner and team relationship. Call this tool to obtain details about the relationship between a runner and a team within an automation actions context. Useful for understanding team assignments and runner affiliations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier for the resource to fetch runner-team association details. |
team_identifier | string | Required | The unique ID representing the team for which the runner relation details are needed. |
Requirements
Output
json— Response from the API endpoint 'getAutomationActionsRunnerTeamAssociation'.PagerdutyApi.GetRunnerTeamAssociations
Retrieve team references linked to a specific runner. Fetches all team references linked to a specified automation actions runner in PagerDuty, helpful for understanding team associations for automation management.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
runner_resource_id | string | Required | The ID of the automation actions runner to retrieve associated team references for. |
Requirements
Output
json— Response from the API endpoint 'getAutomationActionsRunnerTeamAssociations'.PagerdutyApi.GetScheduleDetails
Retrieve detailed schedule information. Fetch detailed information about a specific schedule, including entries for each layer. Use this tool to access comprehensive schedule details when needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
schedule_id | string | Required | The unique identifier for the schedule to retrieve details. |
allow_schedule_overflow | boolean | Optional | If true, schedule entries can extend beyond date range bounds. Defaults to false, truncating entries at bounds. |
date_range_start | string | Optional | The start date for the schedule entries. Defaults to 2 weeks before the end date if not provided. Optional parameter. |
end_date_for_schedule_entries | string | Optional | The end of the date range to display schedule entries. Defaults to 2 weeks after the start date if provided. |
results_time_zone | string | Optional | The time zone in which the schedule results will be rendered. Defaults to the schedule's time zone if not specified. |
user_id_for_next_oncall | string | Optional | Specify the `user_id` to get information about this user's next on-call schedule. |
Requirements
Output
json— Response from the API endpoint 'getSchedule'.PagerdutyApi.GetServiceCustomFieldInfo
Retrieve detailed information about a custom field for a service. Use this tool to get detailed information about a specific custom field associated with a service in PagerDuty. Requires OAuth scope: custom_fields.read.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
field_id | string | Required | The unique identifier for the custom field you want to retrieve information about. |
include_field_details | string | Optional | Specify additional details to include, such as 'field_options'. |
Requirements
Output
json— Response from the API endpoint 'getServiceCustomField'.PagerdutyApi.GetServiceCustomFieldOption
Retrieve a service custom field option by field and option ID. Use this tool to get details of a specific custom field option within a service by providing the field and option IDs. Requires 'custom_fields.read' OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
field_id | string | Required | The unique identifier for the field to which the custom option belongs. Required to fetch the specific field option. |
field_option_identifier | string | Required | The unique identifier for the field option. Use to specify which custom field option to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getServiceCustomFieldOption'.PagerdutyApi.GetServiceCustomFieldValues
Retrieve custom field values for a specific service. Use this tool to get custom field values associated with a specific service in PagerDuty. This is useful for accessing additional information formatted as custom fields. Requires appropriate OAuth scopes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_id | string | Required | The unique identifier for the PagerDuty service whose custom field values are to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'getServiceCustomFieldValues'.PagerdutyApi.GetServiceDependencies
Fetch immediate dependencies of a technical service. This tool retrieves all immediate dependencies of a specified technical service, also known as a service, using its ID. Useful for understanding service interconnections. Requires 'services.read' OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The ID of the technical service whose dependencies are to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'getTechnicalServiceServiceDependencies'.PagerdutyApi.GetServiceDetails
Retrieve details about an existing service. Fetch detailed information about a service, which may represent an application, component, or team for incident management. Useful for accessing specific service data when managing incidents.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_id | string | Required | The unique identifier of the service to retrieve details for. |
additional_details_to_include | string | Optional | Array of additional details to include, such as escalation policies, teams, auto pause notifications parameters, or integrations. |
Requirements
Output
json— Response from the API endpoint 'getService'.PagerdutyApi.GetServiceEventCacheData
Retrieve external data cache variable for event orchestration. This tool retrieves the data of an `external_data` type Cache Variable for a specified Service Event Orchestration in PagerDuty. It is useful when you need to access stored values like strings, numbers, or booleans for use in event orchestration rules. OAuth scope `services.read` is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cache_variable_id | string | Required | The ID of the Cache Variable to retrieve data for, used in service event orchestration. |
service_identifier | string | Required | The unique identifier for the service to retrieve the cache variable data from. |
Requirements
Output
json— Response from the API endpoint 'getExternalDataCacheVarDataOnServiceOrch'.PagerdutyApi.GetServiceEventCacheVariable
Get a cache variable for a service event orchestration. Fetches stored event data from a service event orchestration cache variable, useful for conditions or actions in event orchestration rules.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cache_variable_id | string | Required | The unique identifier of the cache variable to retrieve. |
service_identifier | string | Required | The unique identifier of the service. Use this to specify the service whose event orchestration cache variable you want to access. |
Requirements
Output
json— Response from the API endpoint 'getCacheVarOnServiceOrch'.PagerdutyApi.GetServiceImpactsByUrlSlug
Retrieve impacted business services from a status dashboard. Use this tool to obtain business service impact details for status dashboards using a specific `url_slug`. It returns a sorted list of the most impacted services, limited to 200 entries.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status_dashboard_url_slug | string | Required | The URL slug for the specific status dashboard to retrieve service impacts from. |
include_additional_fields | string | Optional | Specify whether to include additional fields such as highest impacting priority and total impacted count. Choose from 'services.highest_impacting_priority' or 'total_impacted_count'. |
Requirements
Output
json— Response from the API endpoint 'getStatusDashboardServiceImpactsByUrlSlug'.PagerdutyApi.GetServiceIntegrationDetails
Retrieve details about a specific service integration. This tool retrieves details about an integration for a specified service in PagerDuty. Use this tool to find information about how an application, component, or team is integrated for incident management. Requires appropriate OAuth permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
integration_id | string | Required | The unique ID of the integration on the specified service in PagerDuty. |
resource_id | string | Required | The unique identifier for the service resource to retrieve integration details. |
include_additional_details | string | Optional | Specify additional details like 'services' or 'vendors' to include. |
Requirements
Output
json— Response from the API endpoint 'getServiceIntegration'.PagerdutyApi.GetServiceOrchestration
Retrieve details of a service orchestration configuration. Accesses service orchestration details, including event rules and processing pathways within PagerDuty. Useful for understanding or modifying event escalation paths.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_identifier | string | Required | The unique identifier for the service you want to retrieve orchestration details for. |
include_models_in_response | string | Optional | Specify additional models like 'migrated_metadata' to include in the response. |
Requirements
Output
json— Response from the API endpoint 'getOrchPathService'.PagerdutyApi.GetServiceOrchestrationStatus
Retrieve the active status of a Service Orchestration. This tool is used to get the active status of a Service Orchestration, determining if the event evaluation is against a service orchestration path or service ruleset. Applicable for managing service paths and rulesets.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_id | string | Required | The unique identifier for the service to check its orchestration status. |
Requirements
Output
json— Response from the API endpoint 'getOrchActiveStatus'.PagerdutyApi.GetServiceReferencesForAutomationAction
Retrieve services linked to a specific automation action. Use this tool to obtain all service references associated with a given Automation Action. It's useful for understanding which services are connected to a particular action in your PagerDuty setup.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier for the automation action resource. |
Requirements
Output
json— Response from the API endpoint 'getAutomationActionsActionServiceAssociations'.PagerdutyApi.GetStatusDashboard
Retrieve PagerDuty status dashboard details by ID. Use this tool to get detailed information about a specific PagerDuty status dashboard using its unique ID. This can be helpful for monitoring and analysis of service status.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status_dashboard_id | string | Required | The unique ID of the PagerDuty status dashboard to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getStatusDashboardById'.PagerdutyApi.GetStatusDashboardBySlug
Retrieve a PagerDuty Status Dashboard by its URL slug. Use this tool to get details of a custom Status Dashboard in PagerDuty using the URL slug. Ideal for accessing human-readable dashboard references.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status_dashboard_url_slug | string | Required | The URL slug for a status dashboard, typically a dash-separated string like 'dash-separated-string'. Used to identify a specific dashboard in PagerDuty. |
Requirements
Output
json— Response from the API endpoint 'getStatusDashboardByUrlSlug'.PagerdutyApi.GetStatusDashboards
Retrieve all custom Status Dashboard views for your account. Use this tool to get an overview of all Status Dashboard views configured in your PagerDuty account. Useful for monitoring and management purposes.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listStatusDashboards'.PagerdutyApi.GetStatusPageImpact
Retrieve impact details for a specific status page. This tool retrieves impact information for a given status page using the status page ID and impact ID. It should be called when detailed impact data is needed for specific status pages. Requires `status_pages.read` OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status_page_id | string | Required | The ID of the status page resource to retrieve impact details for. |
status_page_impact_id | string | Required | The unique identifier for the Status Page Impact. Use this to fetch specific impact details. |
Requirements
Output
json— Response from the API endpoint 'getStatusPageImpact'.PagerdutyApi.GetStatusPagePost
Retrieve a post from a specific status page. Use this tool to fetch detailed information about a specific post on a status page using the status page ID and post ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status_page_id | string | Required | The ID of the status page resource to retrieve the post from. |
status_page_post_id | string | Required | The unique identifier for the Status Page Post to retrieve details. |
include_models | array<string> | Optional | Array of model names to include in the response for additional detail. |
Requirements
Output
json— Response from the API endpoint 'getStatusPagePost'.PagerdutyApi.GetStatusPageService
Get service details for a status page by ID and service ID. Fetches and returns details of a specific service associated with a given status page using the status page ID and service ID. Useful for monitoring or auditing service statuses on PagerDuty status pages.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The ID of the status page resource to fetch the service for. |
status_page_service_id | string | Required | The unique identifier of the Status Page service to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'getStatusPageService'.PagerdutyApi.GetStatusPageSeverity
Retrieve severity details for a status page using IDs. This tool fetches the severity information for a given status page by using the status page ID and severity ID. It's useful for monitoring and managing incident details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status_page_id | string | Required | The unique identifier for the status page resource. |
status_page_severity_id | string | Required | The unique identifier for the specific severity on a status page. Used to fetch severity details. |
Requirements
Output
json— Response from the API endpoint 'getStatusPageSeverity'.PagerdutyApi.GetStatusPageStatus
Retrieve the status of a status page by ID and status ID. Use this tool to get the current status of a specific status page by providing the page ID and status ID. Useful for monitoring and analyzing the current operational status of services.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier for the resource to fetch the status for. |
status_page_status_id | string | Required | The ID of the Status Page status to retrieve. This is required to specify which status is being queried. |
Requirements
Output
json— Response from the API endpoint 'getStatusPageStatus'.PagerdutyApi.GetStatusPageSubscription
Retrieve a status page subscription by ID. Fetch details of a specific subscription linked to a status page using the status page ID and subscription ID. This tool requires relevant OAuth permissions to access the data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique ID of the status page resource to retrieve the subscription details. |
status_page_subscription_id | string | Required | The unique identifier for the Status Page subscription. |
Requirements
Output
json— Response from the API endpoint 'getStatusPageSubscription'.PagerdutyApi.GetTagDetails
Retrieve details about a specific PagerDuty Tag. Use this tool to obtain details about a specific Tag in PagerDuty, which can be associated with Escalation Policies, Teams, or Users for filtering purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique ID of the PagerDuty Tag to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'getTag'.PagerdutyApi.GetTagsByEntity
Retrieve related entities for a specific tag. Call this tool to get users, teams, or escalation policies related to a specific tag. Useful for filtering entities by tags. Appropriate for scenarios where you need to understand what entities a particular tag is associated with.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
entity_type | string | Required | Specify the type of entity related to the tag. Options: 'users', 'teams', or 'escalation_policies'. |
resource_id | string | Required | The unique identifier of the resource to retrieve related entities for a tag. |
include_total_in_pagination | boolean | Optional | Set to true to include the total count of results in pagination responses, which may impact response times. |
pagination_offset | integer | Optional | Offset to start pagination of search results. |
results_per_page | integer | Optional | Specify the number of results to return per page. |
Requirements
Output
json— Response from the API endpoint 'getTagsByEntityType'.PagerdutyApi.GetTagsByEntityId
Retrieve tags for Users, Teams, or Escalation Policies. Use this tool to get tags related to a specific User, Team, or Escalation Policy by their ID. Useful for filtering and organizing entities based on applied tags.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
entity_id | string | Required | The unique identifier of the resource for which to retrieve tags. This ID corresponds to a specific User, Team, or Escalation Policy. |
entity_type | string | Required | Specifies the type of entity (users, teams, escalation_policies) to retrieve related tags for. |
include_total_in_response | boolean | Optional | Set to true to include the total number of results in the pagination response. |
pagination_offset | integer | Optional | The offset position to start paginating search results. Useful for browsing through large sets of data. |
results_per_page | integer | Optional | The number of results to return per page when retrieving tags. |
Requirements
Output
json— Response from the API endpoint 'getEntityTypeByIdTags'.PagerdutyApi.GetTeamDetails
Retrieve details about a specified team. Fetches information about an existing team, which includes users and escalation policies. Useful for understanding team composition and responsibilities within an organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_id | string | Required | The unique ID of the team to retrieve information for. |
include_additional_models | string | Optional | Specify additional models like 'privileges' to include in the response. |
Requirements
Output
json— Response from the API endpoint 'getTeam'.PagerdutyApi.GetTeamIncidentMetrics
Fetch aggregated incident metrics by team and time unit. Use this tool to obtain metrics such as Seconds to Resolve and Sleep Hour Interruptions for incidents, aggregated by team. Data can be grouped by day, week, or month, or summarized for a specific period for each team. A team or service ID filter is required for user-level API keys. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'getAnalyticsMetricsIncidentsTeam'.PagerdutyApi.GetTeamNotificationSubscriptions
Retrieve a team's notification subscriptions from PagerDuty. This tool retrieves notification subscriptions for a specific team in PagerDuty. It should be called when you need to get a list of current notification subscriptions for a team that has been added through the notification subscriptions endpoint. Requires `subscribers.read` OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_id | string | Required | The ID of the team to retrieve notification subscriptions for. This must be a valid team ID added through the notification subscriptions endpoint. |
Requirements
Output
json— Response from the API endpoint 'getTeamNotificationSubscriptions'.PagerdutyApi.GetTeamReferencesForAutomationAction
Retrieve teams associated with a specific automation action. This tool retrieves all team references linked to a given Automation Action. It's useful for understanding which teams are involved with or responsible for specific actions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The ID of the Automation Action resource to retrieve associated teams for. |
Requirements
Output
json— Response from the API endpoint 'getAutomationActionsActionTeamAssociations'.PagerdutyApi.GetTemplateDetails
Retrieve details of a specific template using its ID. Use this tool to get detailed information about a specific template in your PagerDuty account. Ideal for checking template configurations or reviewing template information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
template_id | string | Required | The unique ID of the template to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'getTemplate'.PagerdutyApi.GetTemplateFields
Retrieve fields for account templates. Call this tool to obtain a list of fields that can be used on account templates in PagerDuty. Requires `templates.read` OAuth scope.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'getTemplateFields'.PagerdutyApi.GetTemplateList
Retrieve a list of all templates on an account. This tool fetches all the templates available on a PagerDuty account. It should be called when you need to access or manage existing templates.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_template_type | string | Optional | Specify the type of template to filter results by. Use this to narrow down the list to specific template types. |
include_total_in_response | boolean | Optional | Set to true to include the total count of templates in the response. This may affect response time. |
pagination_offset | integer | Optional | Offset to start pagination search results. Define where the returned list should begin. |
results_per_page | integer | Optional | The number of template results returned per page. Use this to control pagination size. |
search_template_query | string | Optional | Template name or description to search for in the templates list. |
sort_by_field_and_direction | string | Optional | Specify the field ('name' or 'created_at') and direction ('asc' or 'desc') to sort results. Format: field:direction, defaulting to ascending. |
Requirements
Output
json— Response from the API endpoint 'getTemplates'.PagerdutyApi.GetTopLevelImpactorsForBusinessServices
Retrieve high-priority incidents impacting top-level business services. Use this tool to obtain a list of the most critical incidents (impactors) affecting the top-level business services in your account, up to a limit of 200. These incidents are sorted by priority and creation date. Utilize the `ids[]` parameter to specify particular business services.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
business_service_ids | string | Optional | List of business service IDs to fetch impactors for. |
Requirements
Output
json— Response from the API endpoint 'getBusinessServiceTopLevelImpactors'.PagerdutyApi.GetUnroutedEventOrchestrationRules
Retrieve rules for unrouted event orchestration in PagerDuty. This tool retrieves the set of rules used in a Global Event Orchestration for handling unrouted events in PagerDuty. It should be called to understand how events that don't match any global routing rules are processed, modified, or enhanced. The retrieved rules can provide insights into further event processing strategies.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_orchestration_id | string | Required | The unique identifier for the Event Orchestration to retrieve unrouted event rules. |
Requirements
Output
json— Response from the API endpoint 'getOrchPathUnrouted'.PagerdutyApi.GetUserActiveSessions
List active sessions of a specified PagerDuty user. Use this tool to retrieve a list of active sessions for a specific PagerDuty user. Note that active sessions do not include newly issued OAuth tokens as of November 2021. This information is useful for managing and interacting with user access within a PagerDuty account. Requires proper OAuth scope: `users:sessions.read`.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_id | string | Required | The ID of the PagerDuty user whose active sessions are to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'getUserSessions'.PagerdutyApi.GetUserAuditRecords
Retrieve audit records for a specified user. This tool fetches audit records related to changes made to a specified user in PagerDuty. The records are ordered by the latest execution time. Use this tool to track changes to a user's account or settings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_id | string | Required | The unique identifier for the user whose audit records are being retrieved. |
end_date_range | string | Optional | The end date for searching audit records. Defaults to now and cannot exceed 31 days after `since`. |
pagination_cursor | string | Optional | Optional string to fetch the next set of results. Use the `next_cursor` from previous responses. |
result_limit | integer | Optional | Specifies the maximum number of audit records to retrieve in a single request. |
start_date | string | Optional | The start date for the search range. Defaults to 24 hours ago if not specified. |
Requirements
Output
json— Response from the API endpoint 'listUsersAuditRecords'.PagerdutyApi.GetUserContactMethodInfo
Retrieve details about a user's contact method in PagerDuty. Use this tool to obtain information on a specific user's contact method in a PagerDuty account. It provides details necessary for interacting with user incidents and related account data. Requires appropriate OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The ID of the user resource to retrieve contact method details for. |
user_contact_method_id | string | Required | The unique identifier for a user's specific contact method in PagerDuty. |
Requirements
Output
json— Response from the API endpoint 'getUserContactMethod'.PagerdutyApi.GetUserContactMethods
Retrieve a user's contact methods from PagerDuty. Use this tool to list the contact methods associated with a specific PagerDuty user. This information is useful for interacting with incidents and other account data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_id | string | Required | The ID of the PagerDuty user whose contact methods are to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'getUserContactMethods'.PagerdutyApi.GetUserDetails
Retrieve details about a specific PagerDuty user. This tool is used to get detailed information about an existing user in a PagerDuty account. Useful for accessing user-specific data to manage interactions with incidents and other account activities.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_id | string | Required | The unique identifier for the specific PagerDuty user whose details are to be retrieved. |
additional_models_to_include | string | Optional | Specify additional models (e.g., 'contact_methods', 'notification_rules') to include in the response. |
Requirements
Output
json— Response from the API endpoint 'getUser'.PagerdutyApi.GetUserHandoffNotificationRule
Fetch a user's handoff notification rule details. Use this tool to retrieve detailed information about a user's handoff notification rule in PagerDuty. It is useful for understanding user-specific notification settings related to on-call handoffs. Requires 'users.read' scope for OAuth.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
oncall_handoff_notification_rule_id | string | Required | The ID of the oncall handoff notification rule for the user. |
user_id | string | Required | The unique identifier for the user whose handoff notification rule details are being retrieved. This is required to specify the target user in PagerDuty. |
Requirements
Output
json— Response from the API endpoint 'getUserHandoffNotifiactionRule'.PagerdutyApi.GetUserLicense
Retrieve the license allocated to a user. This tool fetches the license information assigned to a specific user in the PagerDuty system. It should be called when there is a need to know the license status or allocation for a particular user. Requires appropriate OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_id | string | Required | The unique identifier of the user to fetch license information for. |
Requirements
Output
json— Response from the API endpoint 'getUserLicense'.PagerdutyApi.GetUserNotificationRule
Retrieve details about a user's notification rule. This tool retrieves information about a user's notification rule in a PagerDuty account. It should be called when you need to understand how a user is notified regarding incidents. OAuth scope required: `users:contact_methods.read`.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
notification_rule_id | string | Required | The unique identifier for the user's notification rule to be retrieved. |
user_id | string | Required | The unique identifier of the user in PagerDuty. Required to fetch their notification rule. |
include_additional_details | string | Optional | Specify additional details to include such as 'contact_methods'. |
Requirements
Output
json— Response from the API endpoint 'getUserNotificationRule'.PagerdutyApi.GetUserNotificationRules
Retrieve status update notification rules for a PagerDuty user. This tool fetches the status update notification rules for a specified user on PagerDuty. Use it when you need to understand how a user is notified about status updates in their account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_id | string | Required | The unique identifier for the PagerDuty user whose notification rules are to be retrieved. |
include_additional_details | string | Optional | Specify additional details to include, such as 'contact_methods'. |
Requirements
Output
json— Response from the API endpoint 'getUserStatusUpdateNotificationRules'.PagerdutyApi.GetUserNotificationSubscriptions
Retrieve a user's notification subscriptions. Fetches the list of notification subscriptions for a specified user. Useful for checking what notifications a user is subscribed to. Requires that users be added through the appropriate endpoint beforehand and requires the 'subscribers.read' OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_id | string | Required | The unique identifier for the user whose notification subscriptions are being retrieved. |
Requirements
Output
json— Response from the API endpoint 'getUserNotificationSubscriptions'.PagerdutyApi.GetUserSessionDetails
Fetches details about a specific PagerDuty user session. Use this tool to retrieve details of a user's session in PagerDuty. Useful for understanding user access and activity, especially in managing incidents and data interaction within an account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique ID of the PagerDuty user whose session details you want to retrieve. |
session_type | string | Required | Specifies the type of the user session. This information is required to identify the nature of the session for the user session ID. |
user_session_id | string | Required | The unique session ID for a specific PagerDuty user to retrieve session details. |
Requirements
Output
json— Response from the API endpoint 'getUserSession'.PagerdutyApi.GetUserStatusUpdateNotificationRule
Get details about a user's status update notification rule. Call this tool to retrieve information regarding a specific user's notification settings for status updates within a PagerDuty account. Useful for managing or reviewing user-specific notification rules. Requires user's ID and the rule ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status_update_notification_rule_id | string | Required | The ID of the user's status update notification rule to retrieve details for. |
user_id | string | Required | The unique identifier of the user whose notification rule details are to be retrieved. |
include_contact_methods | string | Optional | Specify 'contact_methods' to include additional contact method details in the response. Leave empty if no additional details are needed. |
Requirements
Output
json— Response from the API endpoint 'getUserStatusUpdateNotificationRule'.PagerdutyApi.GetVendorDetails
Fetch detailed information about a specific vendor on PagerDuty. Use this tool to retrieve details about a specific vendor integrated with PagerDuty, like AWS Cloudwatch, Splunk, or Datadog. Useful for understanding integration types.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
vendor_id | string | Required | The unique identifier for the vendor whose details are being requested. |
Requirements
Output
json— Response from the API endpoint 'getVendor'.PagerdutyApi.GetWebhookSubscriptionDetails
Retrieve details about a specific webhook subscription. Use this tool to get detailed information about an existing webhook subscription using its ID. Requires appropriate OAuth permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the webhook subscription to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'getWebhookSubscription'.PagerdutyApi.GetWorkflowConnections
Retrieve connections for a specific workflow integration. Use this tool to list all workflow integration connections for a specified workflow integration. This requires the appropriate OAuth scope for access.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
workflow_integration_id | string | Required | Specify the unique ID of the workflow integration to retrieve its connections. |
filter_by_partial_name | string | Optional | Filter integrations by a partial name match. Provide part of the integration name to refine results. |
next_result_cursor | string | Optional | Request the next set of results using the cursor obtained from a previous response. Leave empty to start from the beginning. |
result_limit | integer | Optional | Specifies the maximum number of results to return. It is the minimum of the request's limit or the API's maximum request size. |
Requirements
Output
json— Response from the API endpoint 'listWorkflowIntegrationConnectionsByIntegration'.PagerdutyApi.GetWorkflowIntegrationConnectionDetails
Retrieve details of a Workflow Integration Connection. This tool fetches details about a specific Workflow Integration Connection using its ID. It's useful for obtaining information on connected workflows via PagerDuty.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique ID of the Workflow Integration Connection resource. |
workflow_integration_id | string | Required | The unique ID of the Workflow Integration to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'getWorkflowIntegrationConnection'.PagerdutyApi.GetWorkflowIntegrationDetails
Retrieve details about a PagerDuty workflow integration. Use this tool to get detailed information about a specific workflow integration in PagerDuty. Useful for understanding integration configurations and parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the workflow integration resource in PagerDuty that you want to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'getWorkflowIntegration'.PagerdutyApi.InstallPagerdutyAddon
Install an add-on for your PagerDuty account. Use this tool to install a new add-on in your PagerDuty account. The add-on is a functional component embedded via an iframe URL provided in the configuration. This allows users to access it from a drop-down menu in PagerDuty's UI. Requires 'addons.write' OAuth scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createAddon'.PagerdutyApi.InvokeAutomationAction
Triggers an automation action in PagerDuty. Use this tool to invoke an automation action in PagerDuty by specifying the action ID in the URL path. Ideal for automating processes or triggering predefined workflows.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_id | string | Required | The ID of the incident associated with the automation action invocation. This ties the action to a specific incident. |
resource_id | string | Required | The unique identifier for the resource to be invoked. |
alert_id_metadata | string | Optional | The alert ID to be used in the invocation metadata for the automation action. This identifier specifies which alert is associated with the action. |
Requirements
Output
json— Response from the API endpoint 'createAutomationActionInvocation'.PagerdutyApi.ListAccountLicenses
Retrieve the list of licenses for your account. Use this tool to obtain a list of licenses associated with your PagerDuty account. This can be useful for managing permissions and understanding the resources available to your account. Requires the `licenses.read` OAuth scope.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listLicenses'.PagerdutyApi.ListAccountTags
Retrieve all tags for your account. This tool retrieves a list of all tags associated with your account, which can be applied to Escalation Policies, Teams, or Users. Use this tool to manage or filter these entities based on tags.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_total_in_pagination | boolean | Optional | Set to true to include the total number of results in the pagination response. Defaults to false for faster response without total. |
pagination_offset | integer | Optional | Offset to start pagination search results. Use this to specify the starting point for retrieval when paginating through results. |
results_per_page | integer | Optional | The number of results to display per page. |
tag_filter_query | string | Optional | Filters the results to show only tags whose labels match this query string. |
Requirements
Output
json— Response from the API endpoint 'listTags'.PagerdutyApi.ListAddons
Retrieve all installed add-ons on your PagerDuty account. Use this tool to list all the add-ons currently installed on your PagerDuty account. Add-ons provide additional functionality by integrating into PagerDuty's UI. This tool is useful for understanding what add-ons are available and active on your account. Requires `addons.read` OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
addon_type_filter | string | Optional | Filters the results, showing only Add-ons of the specified type, such as 'full_page_addon' or 'incident_show_addon'. |
filter_by_service_ids | array<string> | Optional | An array of service IDs to filter results, showing only Add-ons for these services. |
include_additional_models | string | Optional | Specify additional models to include in the response, such as 'services'. |
include_total_field | boolean | Optional | Set to true to include the total count of results in the response, which can affect response times. |
pagination_start_offset | integer | Optional | Offset to start pagination of search results. This determines where to begin the list of add-ons. |
results_per_page | integer | Optional | Specify the number of results to return per page. |
Requirements
Output
json— Response from the API endpoint 'listAddon'.PagerdutyApi.ListAlertGroupingSettings
Retrieve all alert grouping settings. This tool retrieves all alert grouping settings, including single service and global content-based configurations. It is useful for managing and reviewing alert grouping configurations in PagerDuty.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_total_in_response | boolean | Optional | Set to true to include the total number of records in the response; default is null for faster responses. |
pagination_cursor_after | string | Optional | Cursor to retrieve the next page of results; used if additional data pages exist. |
previous_page_cursor | string | Optional | Cursor to retrieve the previous page; use only if not on the first page. |
results_per_page | integer | Optional | Specify the number of alert grouping settings to display per page. |
service_id_list | array<string> | Optional | An array of service IDs to filter results. Only results for these IDs will be returned. |
Requirements
Output
json— Response from the API endpoint 'listAlertGroupingSettings'.PagerdutyApi.ListAllVendors
Retrieve a list of all vendor integrations. Use this tool to get a list of all vendors representing specific types of integrations like AWS Cloudwatch, Splunk, and Datadog. Useful for viewing available integration options.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_total_in_pagination | boolean | Optional | Set to true to populate the `total` field in pagination responses, which provides the total number of results but may affect performance. |
pagination_offset | integer | Optional | Offset for starting pagination of the search results. |
results_per_page | integer | Optional | The maximum number of vendor results to return per page. Use to control pagination. |
Requirements
Output
json— Response from the API endpoint 'listVendors'.PagerdutyApi.ListAuditRecords
Retrieve audit trail records from PagerDuty. Use this tool to list audit trail records from PagerDuty based on specified query parameters or default criteria. Only accessible by admins, account owners, or authorized tokens on specific pricing plans. Records are sorted by execution time, from newest to oldest. Useful for tracking changes and activities within the system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
action_filters | string | Optional | Filter the audit records by specific actions such as 'create', 'update', or 'delete'. |
actor_type_filter | string | Optional | Specifies the type of actor to filter the audit records by. Acceptable values are 'user_reference', 'api_key_reference', or 'app_reference'. |
end_date_range | string | Optional | Specifies the end date for the audit record search. Defaults to now if not specified and cannot exceed 31 days after the start date. |
filter_by_actor_id | string | Optional | Filter audit records by actor ID. Requires `actor_type` to be specified. |
method_truncated_token | string | Optional | Filter records by method truncated token. Requires 'method_type' parameter for qualification. |
method_type_filter | string | Optional | Specify the method type for filtering audit records. Options include 'browser', 'oauth', 'api_token', 'identity_provider', and 'other'. |
next_result_cursor | string | Optional | Use this to fetch the next set of results. Typically acquired from the `next_cursor` of the prior request. If not provided, it starts from the beginning of the result set. |
record_limit | integer | Optional | Specifies the maximum number of audit records to return. It is either the requested limit or the API's maximum request size. |
resource_type_filter | string | Optional | Filter records by specified root resource types such as users, teams, or services. |
start_date | string | Optional | The start date for the search range. Defaults to 24 hours ago if not specified. |
Requirements
Output
json— Response from the API endpoint 'listAuditRecords'.PagerdutyApi.ListAutomationActionInvocations
Retrieve a list of automation action invocations. Call this tool to obtain a list of automation action invocations from PagerDuty. This can be useful for tracking and managing automation actions within your system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
action_id | string | Optional | The unique identifier for the action to filter invocations by. |
exclude_invocation_state | string | Optional | Filter out invocations not in the specified state. Supported states: prepared, created, sent, queued, running, aborted, completed, error, unknown. |
filter_by_invocation_state | string | Optional | Filter the invocations by their state. Options include 'prepared', 'created', 'sent', 'queued', 'running', 'aborted', 'completed', 'error', or 'unknown'. |
incident_id | string | Optional | The unique identifier for the incident. Use this to filter invocations related to a specific incident. |
Requirements
Output
json— Response from the API endpoint 'listAutomationActionInvocations'.PagerdutyApi.ListAutomationActionRunners
Retrieve a list of Automation Action runners. Fetches and lists the Automation Action runners that match provided query parameters, sorted by runner name. Useful for managing and reviewing automation runners on PagerDuty.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_additional_data_elements | array<string> | Optional | List of additional data elements to include in the response. Each entry should be a string representing the type of data element to include. |
next_cursor | string | Optional | Optional cursor for requesting the next set of results. Use the value obtained from a previous response's `next_cursor`. If not provided, retrieval starts from the beginning. |
result_limit | integer | Optional | Specifies the maximum number of Automation Action runners to return in the response. The actual response will have a minimum of this limit or the maximum allowed by the API. |
runner_name_filter | string | Optional | Filter results to include Automation Action runners with names matching this substring (case insensitive). |
Requirements
Output
json— Response from the API endpoint 'getAutomationActionsRunners'.PagerdutyApi.ListAutomationActions
Retrieve all automation actions with optional query filters. Use this tool to list all available automation actions from PagerDuty, filtered by any specified query parameters. Results are sorted alphabetically by action name and can be paginated.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
classification_filter | string | Optional | Filters results to include only those matching the specified classification, such as 'diagnostic' or 'remediation'. |
filter_by_action_type | string | Optional | Filter results to include only those matching the specified action type. Accepts 'script' or 'process_automation'. |
filter_by_name | string | Optional | Filters results to include actions matching the specified name using case insensitive substring matching. |
filter_by_runner_id | string | Optional | Filter results to include actions linked to a specific runner. Use 'any' to include only those linked to any runner, excluding unlinked actions. |
filter_by_service_id | string | Optional | Filters results to include only those actions associated with the specified service ID. |
filter_by_team_id | string | Optional | Filters results to include actions associated with a specified team by providing its ID. |
max_results | integer | Optional | Maximum number of results to return, limited by the API's maximum request size. |
next_page_cursor | string | Optional | Cursor to request the next set of results, typically obtained from the previous response. |
Requirements
Output
json— Response from the API endpoint 'getAllAutomationActions'.PagerdutyApi.ListBusinessServices
Retrieve a list of existing business services. Use this tool to obtain a comprehensive list of business services, which model capabilities spanning multiple technical services and are often owned by different teams. Beneficial for understanding service inventory and management.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_total_count | boolean | Optional | Set to true to include the total count of results in the pagination response. |
pagination_offset | integer | Optional | Offset to start pagination of the search results. Use this to skip a set number of entries. |
results_per_page | integer | Optional | Specify the number of results to display on each page. |
Requirements
Output
json— Response from the API endpoint 'listBusinessServices'.PagerdutyApi.ListCacheVariables
Retrieve cache variables for a global event orchestration. This tool retrieves cache variables stored for a global event orchestration, which can be used in orchestration rules for conditions or actions. Useful for managing and evaluating event data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_orchestration_id | string | Required | The unique identifier for an Event Orchestration to retrieve its cache variables. |
Requirements
Output
json— Response from the API endpoint 'listCacheVarOnGlobalOrch'.PagerdutyApi.ListCacheVariablesForServiceEventOrchestration
Retrieve cache variables for service event orchestration. Use this tool to obtain a list of cache variables associated with a specific service event orchestration in PagerDuty. Cache variables store event data and are utilized in orchestration rules. This tool should be called when you need to access or manage cache variables for event orchestration.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_id | string | Required | The unique identifier of the service. It specifies which service's event orchestration cache variables to list. |
Requirements
Output
json— Response from the API endpoint 'listCacheVarOnServiceOrch'.PagerdutyApi.ListChangeEvents
Fetch a list of existing change events from PagerDuty. Use this tool to retrieve all current change events. Useful for monitoring and tracking changes within systems integrated with PagerDuty.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
end_date_utc | string | Optional | The end date in UTC ISO 8601 format for the date range to search. Note: Must be a valid UTC string. |
include_total_in_pagination | boolean | Optional | Set to true to include the total count of results in pagination responses, which is null by default. |
integration_ids | array<string> | Optional | Array of integration IDs; filters results to these integrations. |
pagination_offset | integer | Optional | Offset to start retrieving paginated search results. |
results_per_page | integer | Optional | Specify the number of change event results to return per page. |
start_date_time_utc | string | Optional | The start date and time for searching change events, in UTC ISO 8601 format. |
team_ids | array<string> | Optional | Array of team IDs. Filters results to those teams. Requires 'teams' ability. |
Requirements
Output
json— Response from the API endpoint 'listChangeEvents'.PagerdutyApi.ListCustomFieldOptions
Retrieve options for a custom field in an incident type. This tool retrieves a list of field options for a custom field associated with a specific incident type. It helps in extending incidents with custom data for better filtering, search, and analytics.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
field_identifier | string | Required | The unique identifier for the custom field. |
incident_type_identifier | string | Required | The ID or name of the Incident Type for which to retrieve custom field options. |
Requirements
Output
json— Response from the API endpoint 'listIncidentTypeCustomField'.PagerdutyApi.ListEscalationPolicies
Retrieve all current escalation policies. Use this tool to obtain a list of all existing escalation policies, which define alerting priorities for users. Requires appropriate OAuth scope for access.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
additional_models_to_include | string | Optional | Array of models to include in the response. Options: 'services', 'teams', 'targets'. |
filter_by_user_ids | array<string> | Optional | Filters the results to show only escalation policies where any specified user is a target. Provide an array of user IDs. |
include_total_in_pagination | boolean | Optional | Set to true to include the total count of records in the pagination response. False ensures faster response times by setting it to null. |
name_filter_query | string | Optional | A string to filter results by matching escalation policy names. |
pagination_offset | integer | Optional | Offset to start pagination for search results. |
results_per_page | integer | Optional | Specifies the number of escalation policy results to display per page. |
sort_by_field | string | Optional | Specify the sorting field for results: 'name', 'name:asc', or 'name:desc'. |
team_ids | array<string> | Optional | A list of team IDs to filter escalation policies. Requires 'teams' ability. |
Requirements
Output
json— Response from the API endpoint 'listEscalationPolicies'.PagerdutyApi.ListEventOrchestrationEnablings
Retrieve feature enablement settings for Event Orchestrations. This tool retrieves all feature enablement settings for a specific Event Orchestration in PagerDuty, currently focusing on AIOps enablement. It should be used to check which AIOps features are enabled for an Event Orchestration. Note: A warning will be returned if the account is not entitled to use AIOps features.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_orchestration_id | string | Required | The unique identifier for a specific Event Orchestration in PagerDuty. This is required to retrieve its feature enablement settings. |
Requirements
Output
json— Response from the API endpoint 'listEventOrchestrationFeatureEnablements'.PagerdutyApi.ListEventOrchestrations
Retrieve all Global Event Orchestrations from an account. This tool lists all Global Event Orchestrations on an account, allowing you to manage and view the defined sets of Global and Router Rules that determine event actions and service routing. Call this tool to access orchestration details, which require 'event_orchestrations.read' OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_offset | integer | Optional | The starting point for pagination in search results, specified as an integer. |
results_per_page | integer | Optional | The number of results to return per page when listing the Global Event Orchestrations. |
sort_field_with_order | string | Optional | Specify the field and order (asc/desc) for sorting results. Options include: 'name:asc', 'name:desc', 'routes:asc', 'routes:desc', 'created_at:asc', 'created_at:desc'. |
Requirements
Output
json— Response from the API endpoint 'listEventOrchestrations'.PagerdutyApi.ListEventRules
Retrieve all event rules within a specified ruleset. This tool lists all event rules associated with a specified ruleset on PagerDuty. It should be called to view actions based on event content within a ruleset. Note that rulesets and event rules will soon be deprecated, and migrating to Event Orchestration is recommended.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ruleset_id | string | Required | The unique identifier for the ruleset to list event rules from. |
include_total_in_response | boolean | Optional | Set to true to include the total number of results in the pagination response. This may impact response time. |
pagination_start_offset | integer | Optional | The starting point for pagination to begin returning results from a specific offset. |
results_per_page | integer | Optional | Specify the number of results to return per page. |
Requirements
Output
json— Response from the API endpoint 'listRulesetEventRules'.PagerdutyApi.ListExistingIncidents
Retrieve a list of existing incidents. Fetches a list of incidents that represent problems needing resolution. Useful for monitoring and addressing ongoing issues.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
additional_details_to_include | string | Optional | Array of additional details to include in the incident list, such as 'acknowledgers', 'agents', 'assignees', etc. |
assigned_user_ids | array<string> | Optional | Return incidents currently assigned to specific users by providing their user IDs. Only incidents with statuses 'triggered' or 'acknowledged' are returned. Resolved incidents are not included. |
end_date_range | string | Optional | The end date of the range for searching incidents. Maximum range is 6 months; default is 1 month. |
filter_by_team_ids | array<string> | Optional | Array of team IDs to filter incidents. Requires `teams` ability. |
ignore_since_until_date_range | string | Optional | Set to 'all' to ignore the 'since' and 'until' parameters, extending the search to all dates. |
incident_deduplication_key | string | Optional | A unique key to identify and retrieve specific incidents. Useful for querying by matching alert keys. |
incident_statuses | string | Optional | Specify the list of incident statuses to filter by, such as 'triggered', 'acknowledged', or 'resolved'. |
incident_urgencies | string | Optional | Array of incident urgencies to filter results by. Valid values are 'high' or 'low'. Defaults to all urgencies. |
include_total_in_response | boolean | Optional | Set to true to include the total number of incidents in the response, which may reduce response speed. |
pagination_offset | integer | Optional | Offset to start pagination of the incident search results. Specify the number of entries to skip before starting to collect the result set. |
render_time_zone | string | Optional | Specify the time zone for rendering results. Defaults to the account time zone. |
results_per_page | integer | Optional | The number of results per page. Specify up to a maximum of 100. |
service_ids | array<string> | Optional | A list of service IDs to filter incidents associated with specific services. |
sort_incidents_by | array<string> | Optional | Specify fields and directions for sorting incidents, e.g., 'created_at:asc'. Separate fields with a comma. |
start_date_range | string | Optional | The start date to begin searching for incidents, within a 6-month range. Defaults to 1 month if not provided. |
Requirements
Output
json— Response from the API endpoint 'listIncidents'.PagerdutyApi.ListExtensions
Retrieve a list of existing extensions and their details. Call this tool to obtain a list of extensions, which are representations of Extension Schema objects attached to Services. Useful for managing and identifying existing integrations within the service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_extension_object_id | string | Optional | Filter the extensions by specifying the extension object's ID you want to include. |
filter_by_extension_vendor_id | string | Optional | Specify the extension vendor ID to filter extensions by vendor. |
include_details | string | Optional | Specify additional details to include, such as 'extension_objects' or 'extension_schemas'. |
include_total_in_response | boolean | Optional | Set to true to populate the total field in pagination responses, providing the total count of results. |
name_query_filter | string | Optional | Filter results to show only records whose name matches this query string. |
pagination_offset | integer | Optional | Offset to begin pagination search results listing. Specify an integer value to set the starting point. |
results_per_page | integer | Optional | The number of results to return per page retrieval request. |
Requirements
Output
json— Response from the API endpoint 'listExtensions'.PagerdutyApi.ListExtensionSchemas
Retrieve a list of all PagerDuty extension schemas. This tool fetches a list of all extension schemas in PagerDuty, representing outbound integrations like Webhooks, Slack, and ServiceNow. It should be called when needing details about available extension types. OAuth scope required: `extension_schemas.read`.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_total_in_response | boolean | Optional | Set to true to populate the total field in pagination responses, providing the total count, which may affect response time. |
pagination_offset | integer | Optional | The starting point for pagination in the result set, defined as the number of items to skip. |
results_per_page | integer | Optional | Specify the number of results to display per page. |
Requirements
Output
json— Response from the API endpoint 'listExtensionSchemas'.PagerdutyApi.ListIncidentAlerts
Retrieve alerts for a specified incident. Use this tool to list all alerts associated with a specific incident, which represents an issue that requires resolution. Useful for tracking and managing problems effectively.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_id | string | Required | The unique identifier of the incident to retrieve alerts for. |
alert_deduplication_key | string | Optional | The unique key used for alert de-duplication. |
filter_by_statuses | string | Optional | Filter alerts by specific statuses, such as 'triggered' or 'resolved'. |
include_additional_details | string | Optional | Specify additional details to include, such as services, first_trigger_log_entries, or incidents. |
include_pagination_total | boolean | Optional | Set to `true` to include the total count of results in pagination responses for faster response times. Set to `false` for the default behavior of `null`, which is faster. |
results_per_page | integer | Optional | Specify the number of alert results per page for pagination. |
sort_incident_alerts_by | string | Optional | Specify the field and order for sorting alerts (created_at or resolved_at, with ascending or descending options). |
start_pagination_offset | integer | Optional | Offset for starting the pagination in search results. Use for navigating through paginated data. |
Requirements
Output
json— Response from the API endpoint 'listIncidentAlerts'.PagerdutyApi.ListIncidentLogEntries
Retrieve log entries for a specific incident. Use this tool to obtain a list of log entries related to a specific incident, which represents a problem that needs resolution. This tool should be called when you need detailed records of events concerning an incident.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_id | string | Required | The unique identifier for the incident to retrieve log entries for. |
additional_models_to_include | string | Optional | Array of additional models to include in the response, such as 'incidents', 'services', 'channels', or 'teams'. |
end_date | string | Optional | Specify the end date for the log entry search range. Format as 'YYYY-MM-DD'. |
include_total_in_response | boolean | Optional | Set to true to populate the total field in pagination responses for more detailed information. Defaults to null for faster responses. |
pagination_start_offset | integer | Optional | Specifies the starting point for pagination to search results. Use an integer value. |
results_per_page | integer | Optional | Specify the number of results to display per page. |
results_time_zone | string | Optional | Time zone for rendering the results, defaults to the account time zone. |
return_important_changes_only | boolean | Optional | If `true`, returns a subset of log entries showing only the most important changes to the incident. |
start_date | string | Optional | The start date for the range to search log entries. Expected format: YYYY-MM-DDTHH:MM:SSZ. |
Requirements
Output
json— Response from the API endpoint 'listIncidentLogEntries'.PagerdutyApi.ListIncidentNotes
List notes for a specific incident. Use this tool to retrieve all existing notes related to a specific incident, which represents a problem or issue needing resolution.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_id | string | Required | The unique identifier for the incident whose notes you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'listIncidentNotes'.PagerdutyApi.ListIncidentPriorities
Retrieve a list of incident priorities by severity. This tool retrieves the list of existing incident priorities, ordered from most to least severe. It is used to understand the importance and impact levels of incidents within the Standard and Enterprise plans.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_total_in_response | boolean | Optional | Set to true to include the total number of results in the response, which is not shown by default for performance reasons. |
pagination_offset | integer | Optional | Offset to start pagination from this position in the results. |
results_per_page | integer | Optional | The number of incident priorities to display per page. |
Requirements
Output
json— Response from the API endpoint 'listPriorities'.PagerdutyApi.ListIncidentTypeCustomFields
List custom fields for a specified incident type. This tool retrieves custom fields associated with a specific incident type in PagerDuty. Custom fields allow for extended data to support features like customized filtering, search, and analytics. Use this tool when you need details on the custom fields for a particular incident type.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_type_id_or_name | string | Required | The ID or name of the incident type to retrieve custom fields for. |
include_additional_details | string | Optional | Specify additional details to include, such as 'field_options'. |
Requirements
Output
json— Response from the API endpoint 'listIncidentTypeCustomFields'.PagerdutyApi.ListIncidentTypes
Retrieve available incident types from PagerDuty. Use this tool to list incident types, such as security or major incidents, categorized by their enabled or disabled status. Useful for understanding how incidents are classified within PagerDuty.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_type_filter | string | Optional | Filter incident types by their enabled state. Options: 'enabled', 'disabled', 'all'. |
Requirements
Output
json— Response from the API endpoint 'listIncidentTypes'.PagerdutyApi.ListIncidentWorkflowActions
Retrieve a list of incident workflow actions. Use this tool to get a list of available incident workflow actions from PagerDuty. This is useful for managing and understanding workflows associated with incidents. Requires `incident_workflows.read` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_keyword | string | Optional | Show actions tagged with the specified keyword. Provide a specific keyword to filter results. |
max_results_limit | integer | Optional | The maximum number of incident workflow actions to return in a single request. This value is the lesser of the specified limit or the API's maximum request size. |
pagination_cursor | string | Optional | Optional parameter to fetch the next set of results. Use 'next_cursor' from the previous response. Starts at the beginning if not provided. |
Requirements
Output
json— Response from the API endpoint 'listIncidentWorkflowActions'.PagerdutyApi.ListIncidentWorkflows
Retrieve all incident workflows in your PagerDuty account. Use this tool to list all existing Incident Workflows in your PagerDuty account, which consist of configurable steps and triggers for automated actions. Ideal for managing workflows related to incidents.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_name | string | Optional | Filter results to show only records whose name matches the query. |
include_additional_details | string | Optional | Specify additional details to include, such as 'steps' or 'team'. |
include_total_in_pagination | boolean | Optional | Set to true to populate the `total` field in pagination responses, false otherwise to optimize for speed. |
pagination_offset | integer | Optional | Offset to start pagination search results. |
results_per_page | integer | Optional | Specifies the number of results to return per page in the response. |
Requirements
Output
json— Response from the API endpoint 'listIncidentWorkflows'.PagerdutyApi.ListIncidentWorkflowTriggers
Retrieve a list of existing incident workflow triggers. Use this tool to obtain information about all current incident workflow triggers. It requires `incident_workflows.read` OAuth scope to access the data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_service_id | string | Optional | Show triggers for incidents in the given service. Cannot be used with `incident_id`. |
filter_by_trigger_type | string | Optional | Specify the type of triggers to show, such as 'manual', 'conditional', or 'incident_type'. |
filter_for_disabled_triggers | boolean | Optional | Set to true to filter for disabled triggers, false for enabled. This parameter is deprecated. |
incident_id_filter | string | Optional | Show triggers for the service of the specified incident. Cannot be used with `service_id`. |
maximum_results | integer | Optional | Specify the maximum number of triggers to return. This limits the size of the response, constrained by the API's maximum request size. |
pagination_cursor | string | Optional | Optional parameter to request the next set of results, usually from the `next_cursor` field of a previous request. Starts at the beginning if not provided. |
sort_triggers_by | string | Optional | Specify the property to sort triggers, such as 'workflow_id asc' or 'workflow_name desc'. |
workflow_id_filter | string | Optional | If provided, only show triggers configured to start the specified workflow, useful for listing services linked to a workflow. |
workflow_name_contains | string | Optional | Filter triggers by workflow names containing this value. |
Requirements
Output
json— Response from the API endpoint 'listIncidentWorkflowTriggers'.PagerdutyApi.ListMaintenanceWindows
Retrieve maintenance windows with optional filters for service or team. This tool retrieves a list of existing maintenance windows, allowing optional filtering by service and/or team. It can specify windows from the past, present, or future. A maintenance window is used to disable services temporarily for a set period. Scoped OAuth requires: `services.read`.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_name | string | Optional | Filter maintenance windows to show only those with names matching the query. |
filter_by_service_ids | array<string> | Optional | An array of service IDs to filter maintenance windows. Only results related to these services will be returned. |
filter_by_team_ids | array<string> | Optional | Array of team IDs to filter results. Requires 'teams' ability. |
include_models | string | Optional | Specify models to include in the response, such as 'teams', 'services', or 'users'. |
include_total_in_response | boolean | Optional | Set to true to populate the `total` field in pagination responses and get the total count of records. |
maintenance_window_state | string | Optional | Specify the state of maintenance windows to return: 'past', 'future', 'ongoing', 'open', or 'all'. |
pagination_offset | integer | Optional | Offset to start the pagination of search results. Use to skip a number of results. |
results_per_page | integer | Optional | The number of maintenance window results to display per page. |
Requirements
Output
json— Response from the API endpoint 'listMaintenanceWindows'.PagerdutyApi.ListNotifications
Retrieve notifications within a specified time range. This tool retrieves notifications for a given time range, which can be filtered by type such as SMS, email, phone, or push notifications. Notifications are created when an incident is triggered or escalated.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
end_date_for_search | string | Required | The end of the date range for the search. Must be in the same format as the 'since' date and within 3 months of it. |
start_date | string | Required | The start date for the search range. Time is optional and must match format of 'until'. |
additional_details_include | string | Optional | Specify additional details to include, such as 'users'. |
include_total_in_response | boolean | Optional | Set to true to populate the total field in pagination responses, otherwise it will be null. |
notification_type_filter | string | Optional | Return notifications of a specific type such as SMS, email, phone, or push. |
output_time_zone | string | Optional | Time zone for rendering results. Defaults to the account's time zone if not specified. |
pagination_offset | integer | Optional | Offset number to begin the pagination of search results. |
results_per_page | integer | Optional | The number of results to display per page. |
Requirements
Output
json— Response from the API endpoint 'listNotifications'.PagerdutyApi.ListOauthClients
Retrieve all OAuth clients for webhook subscriptions. Use this tool to list all OAuth clients associated with webhook subscriptions. Requires admin or owner role permissions and is limited to a maximum of 10 clients per account.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listOauthClients'.PagerdutyApi.ListOnCallEntries
Retrieve on-call entries for a specified time range. This tool fetches the on-call entries indicating who is scheduled to be on call during a specified time period. This can be used to determine coverage for escalation policies and rules. Note that specific OAuth permissions ('oncalls.read') are required, and rate limits may apply.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
additional_details_to_include | string | Optional | Array of additional details to include such as escalation policies, users, or schedules. |
end_time_for_on_call_search | string | Optional | Specify the end of the time period to search for on-call entries. The end time must be after the start time ('since') and cannot exceed 90 days in the future. Defaults to current time if not specified. |
filter_by_escalation_policy_ids | array<string> | Optional | Array of escalation policy IDs to filter the on-call results. Only entries matching these IDs will be included. |
filter_user_ids | array<string> | Optional | An array of user IDs to filter and show only the on-calls for these users. |
include_total_in_response | boolean | Optional | Set to true to populate the total field in pagination responses, enhancing the response with total entry count. |
pagination_offset | integer | Optional | Offset indicating where to start the pagination for search results. |
results_per_page | integer | Optional | The maximum number of on-call entries to return per page. Set this to control pagination. |
results_time_zone | string | Optional | Specifies the time zone for rendering results. Defaults to the account time zone if not provided. |
return_earliest_on_call | boolean | Optional | Set to true to filter and return only the earliest on-call entry for each combination of escalation policy, escalation level, and user. |
schedule_ids_filter | array<string> | Optional | Array of schedule IDs to filter results. Include `null` to cover permanent on-calls from direct user escalations. |
start_time_range | string | Optional | The start time for the search range. On-call periods overlapping this time will be included. Defaults to the current time. Limited to 90 days in the future. |
Requirements
Output
json— Response from the API endpoint 'listOnCalls'.PagerdutyApi.ListOnCallSchedules
Retrieve the on-call schedules from PagerDuty. Use this tool to get information about the time periods when users are on-call in PagerDuty. This tool is useful for understanding and managing on-call rotations. OAuth with 'schedules.read' scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
additional_details_to_include | string | Optional | Specify additional details to include, such as 'schedule_layers', 'overrides_subschedule', 'final_schedule'. |
end_date_range | string | Optional | Specify the end date for the schedule entries range. Defaults to 2 weeks after the 'since' date if not provided. |
filter_by_name | string | Optional | Filters results to show records with matching names. |
include_total_in_pagination | boolean | Optional | Set to true to populate the total field in pagination responses. Defaults to null for faster response times if false. |
pagination_offset | integer | Optional | The starting point for pagination of search results. Use this to skip a specific number of results. |
render_results_in_time_zone | string | Optional | Specify the time zone for displaying results. Defaults to the user's or account's time zone. |
results_per_page | integer | Optional | The number of results to retrieve per page for the on-call schedules. |
start_date_for_schedule_entries | string | Optional | The start date for showing schedule entries. Defaults to 2 weeks before the 'until' date if not specified. |
user_id_for_next_oncall | string | Optional | Specify a user_id to get information about this user's next on-call schedule. |
Requirements
Output
json— Response from the API endpoint 'listSchedules'.PagerdutyApi.ListOnCallUsers
Retrieve users on call for a given schedule and time range. This tool lists all users who are on call for a specified schedule within a given time range. It is useful for managing and viewing on-call schedules and requires the `users.read` OAuth permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
schedule_resource_id | string | Required | The ID of the schedule resource to retrieve on-call users for. |
end_date_range | string | Optional | The end date for the time range of user search. Format as YYYY-MM-DD. |
start_date_range | string | Optional | The start date of the range to search for users on call. Format should be YYYY-MM-DD. |
Requirements
Output
json— Response from the API endpoint 'listScheduleUsers'.PagerdutyApi.ListOrchestrationIntegrations
Retrieve integrations for an event orchestration. Use this tool to obtain the integrations linked to a specific event orchestration in PagerDuty. These integrations provide routing keys to send events to PagerDuty. Requires 'event_orchestrations.read' scope with OAuth.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_orchestration_id | string | Required | The unique identifier for the Event Orchestration to retrieve integrations for. This ID is necessary to specify which event orchestration's integrations you wish to list. |
Requirements
Output
json— Response from the API endpoint 'listOrchestrationIntegrations'.PagerdutyApi.ListPagerdutyTeams
Retrieve a list of teams from your PagerDuty account. This tool retrieves a list of teams from your PagerDuty account, possibly filtered by a search query. Teams comprise users and escalation policies representing organizational groups. Use this tool to get insights into team structures and members.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_name_query | string | Optional | Specify a query to filter teams by name. Only teams with names matching this query will be returned. |
include_total_in_response | boolean | Optional | Set to true to include the total count of results in the response for pagination. This may impact response time. |
pagination_offset | integer | Optional | Offset to start returning team results from in pagination. |
results_per_page | integer | Optional | Specify the number of teams to return per page. |
Requirements
Output
json— Response from the API endpoint 'listTeams'.PagerdutyApi.ListPagerdutyUsers
Retrieve users from your PagerDuty account. Use this tool to list all users in your PagerDuty account, with the option to filter by a search query. Users are those who can interact with incidents and data within the account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
additional_models_to_include | string | Optional | Array of additional models to include in the response, such as 'contact_methods', 'notification_rules', 'teams', or 'subdomains'. |
include_total_in_response | boolean | Optional | Set to true to include the total count in pagination responses, which may slow down the response time. |
pagination_offset | integer | Optional | Offset to start pagination in search results. Specify the number of items to skip. |
results_per_page | integer | Optional | Specify the number of user results to be returned per page. |
team_ids | array<string> | Optional | An array of team IDs to filter the user results. Requires the account to have the 'teams' ability. |
user_name_filter | string | Optional | String to filter users by name in the PagerDuty account. |
Requirements
Output
json— Response from the API endpoint 'listUsers'.PagerdutyApi.ListResourceStandards
Retrieve standards applied to multiple resources. Use this tool to get a list of standards applied to a specified set of resources. It requires scoped OAuth permission `standards.read` and is useful for obtaining compliance information or resource evaluations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_ids | array<string> | Required | Array of resource IDs to which standards will be applied. Maximum of 100 items. |
resource_type | string | Required | Specifies the type of resources to which the standards are applied. For example, 'technical_services'. |
Requirements
Output
json— Response from the API endpoint 'listResourceStandardsManyServices'.PagerdutyApi.ListRulesets
Retrieve a list of all rulesets from PagerDuty. This tool retrieves all rulesets, which are used to route events to endpoints and define actions based on event contents. Note that rulesets and event rules will soon be deprecated, and it is recommended to migrate to Event Orchestration. Use this tool to access existing rulesets until they are phased out.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_total_count | boolean | Optional | Set to true to include the total count of results in the response. By default, this is omitted for speed. Refer to the Pagination Docs for details. |
pagination_offset | integer | Optional | The starting point for pagination in search results. Use this to skip a specific number of results. |
results_per_page | integer | Optional | Specify the number of ruleset results to return per page. |
Requirements
Output
json— Response from the API endpoint 'listRulesets'.PagerdutyApi.ListScheduleAuditRecords
Retrieve sorted audit records for a specific schedule. Fetches audit records for a particular schedule identified by its ID, sorted by the execution time from newest to oldest. Useful for monitoring changes in schedule configurations or activities. Requires OAuth with 'audit_records.read' scope for authorization. Supports cursor-based pagination for large datasets.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the schedule resource to retrieve audit records for. |
end_of_date_range | string | Optional | The end date for the search range. Defaults to 'now' if not specified; must be within 31 days after the 'since' date. |
maximum_records_limit | integer | Optional | The maximum number of records to return. This is the lesser of the specified limit or the API's maximum size. |
pagination_cursor | string | Optional | Cursor for requesting the next set of results. Use the `next_cursor` from the previous request to paginate. |
start_date | string | Optional | The start date for searching audit records. Defaults to 24 hours ago if not specified. |
Requirements
Output
json— Response from the API endpoint 'listSchedulesAuditRecords'.PagerdutyApi.ListScheduleOverrides
Fetch overrides for a specific schedule and time range. Use this tool to list all the overrides for a given schedule within a specified time range. Useful for understanding changes to on-call schedules. Requires `schedules.read` OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
end_date_range | string | Required | The end date for the search range in which to list schedule overrides. |
resource_id | string | Required | Specify the ID of the schedule resource to fetch overrides. |
start_date | string | Required | The start date for the search range, formatted as YYYY-MM-DD. |
include_overflown_entries | boolean | Optional | Set to true to include schedule entries extending beyond date range bounds. Defaults to false. |
return_only_editable_overrides | boolean | Optional | Set to true to return only editable overrides. Only future overrides will be included. |
Requirements
Output
json— Response from the API endpoint 'listScheduleOverrides'.PagerdutyApi.ListServiceAuditRecords
Retrieve service audit records sorted by execution time. Use this tool to get audit records for a specific service from PagerDuty, sorted by execution time from newest to oldest. Ideal for monitoring actions and changes related to a service. Ensure proper OAuth scope with `audit_records.read`.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The ID of the service for which audit records are being retrieved. |
end_date | string | Optional | The end of the date range for searching audit records. Defaults to `now()` if unspecified. Must be within 31 days after `start_date`. |
pagination_cursor | string | Optional | Optional parameter to retrieve the next set of audit records. Use the token from `next_cursor` of the previous response. Defaults to the start if not provided. |
result_limit | integer | Optional | Specify the maximum number of audit records to return. Accepts an integer value. |
start_date_range | string | Optional | The start of the date range for search. Defaults to 24 hours ago if not specified. |
Requirements
Output
json— Response from the API endpoint 'listServiceAuditRecords'.PagerdutyApi.ListServiceChangeEvents
Retrieve change events for a specific service. Use this tool to list all existing change events related to a specified service. Requires the 'services.read' OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The ID of the service resource for which to list change events. |
end_date_utc | string | Optional | The end of the date range for the search, in UTC ISO 8601 format. Only UTC dates are accepted. |
filter_by_integration_ids | array<string> | Optional | An array of integration IDs to filter results. Only events related to these integrations will be returned. |
include_total_in_response | boolean | Optional | Set to true to populate the total field in pagination responses, which may affect response time. |
pagination_offset | integer | Optional | Offset to start pagination search results. |
results_per_page | integer | Optional | Specify the number of results to return per page. |
start_date | string | Optional | The start date of the search range, in UTC ISO 8601 format (e.g., '2023-10-01T00:00:00Z'). Ensure it is in UTC to avoid errors. |
team_ids | array<string> | Optional | An array of team IDs to filter results. Account must have `teams` ability to use this. |
Requirements
Output
json— Response from the API endpoint 'listServiceChangeEvents'.PagerdutyApi.ListServiceCustomFieldOptions
Retrieve all options for a specific custom field in PagerDuty. Call this tool to get all options available for a specific custom field in PagerDuty services. Useful for understanding the potential values a custom field can take.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
field_id | string | Required | The unique identifier for the custom field to retrieve options for. |
Requirements
Output
json— Response from the API endpoint 'listServiceCustomFieldOptions'.PagerdutyApi.ListServiceCustomFields
Retrieve the custom fields for PagerDuty services. This tool should be called to obtain a list of custom fields available for services in PagerDuty. It requires the 'custom_fields.read' OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_additional_details | string | Optional | Specify additional details to include, such as 'field_options'. |
Requirements
Output
json— Response from the API endpoint 'listServiceCustomFields'.PagerdutyApi.ListServiceEventRules
Retrieve a list of event rules for a specific service. Use this tool to get a list of event rules associated with a specific service in PagerDuty. This functionality is marked for end-of-life, so consider migrating to Event Orchestration for enhanced features.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_id | string | Required | The unique identifier for the service whose event rules are being listed. |
include_additional_models | string | Optional | Array of additional models to include in response, such as 'migrated_metadata'. |
pagination_offset | integer | Optional | The starting point for pagination of search results, specified as an integer. |
populate_total_field | boolean | Optional | Set to true to populate the total field in pagination responses; set to false to keep it null for faster responses. |
results_per_page | integer | Optional | Specifies the number of results returned per page in the response. |
Requirements
Output
json— Response from the API endpoint 'listServiceEventRules'.PagerdutyApi.ListServiceFeatureEnablements
List feature enablement settings for a service. Retrieves all feature enablement settings for a specified service, focusing on AIOps enablements. If the account lacks AIOps entitlement, a warning will be included with the data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_id | string | Required | The unique identifier for the PagerDuty service whose feature enablements you want to list. |
Requirements
Output
json— Response from the API endpoint 'listServiceFeatureEnablements'.PagerdutyApi.ListServices
Retrieve a list of existing services. Use this tool to get a list of services, which may include applications, components, or teams for incident management.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_service_name | string | Optional | Filters results to show only services with the specified name. |
filter_by_team_ids | array<string> | Optional | Filter results to only include services related to the specified team IDs. Requires 'teams' ability. |
include_additional_details | string | Optional | Array of additional details to include, such as 'escalation_policies', 'teams', 'integrations', or 'auto_pause_notifications_parameters'. |
include_total_in_response | boolean | Optional | Set to true to include the total count of results in the pagination response. |
name_query_filter | string | Optional | Filters results to show only services with names matching the query. |
pagination_offset | integer | Optional | Offset to start pagination search results. |
results_per_page | integer | Optional | Specify the number of results to be returned per page. |
results_time_zone | string | Optional | Time zone for rendering results, defaulting to the account time zone. |
sort_results_by | string | Optional | Specifies the field and order (ascending/descending) to sort the results by. Options include: 'name', 'name:asc', 'name:desc'. |
Requirements
Output
json— Response from the API endpoint 'listServices'.PagerdutyApi.ListStatusPageImpacts
Retrieve impacts for a specified status page by ID. Use this tool to fetch a list of impacts affecting a particular status page. This is helpful for monitoring and managing service disruptions and their effects. Ensure the necessary OAuth scope `status_pages.read` is granted to access the data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status_page_id | string | Required | The ID of the status page to retrieve impacts for. |
filter_by_post_type | string | Optional | Specify the type of posts to filter by: 'incident' or 'maintenance'. |
Requirements
Output
json— Response from the API endpoint 'listStatusPageImpacts'.PagerdutyApi.ListStatusPagePosts
Retrieve posts for a specific status page using its ID. Use this tool to get posts associated with a given status page by providing its ID. Useful for monitoring updates and information shared through the status page.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status_page_id | string | Required | The unique ID of the status page to retrieve posts from. |
filter_by_post_type | string | Optional | Filter posts by type. Acceptable values are 'incident' or 'maintenance'. |
filter_by_reviewed_status | string | Optional | Filter posts by their reviewed status. Possible values are 'approved' or 'not_reviewed'. |
status_identifiers | array<string> | Optional | Filter posts by an array of status identifiers to specify which statuses to retrieve. |
Requirements
Output
json— Response from the API endpoint 'listStatusPagePosts'.PagerdutyApi.ListStatusPages
Retrieve a list of status pages. Use this tool to get a list of status pages. Requires `status_pages.read` OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status_page_type | string | Optional | Specifies the type of the status page. Must be 'public' or 'private'. |
Requirements
Output
json— Response from the API endpoint 'listStatusPages'.PagerdutyApi.ListStatusPageServices
Retrieve services for a specific Status Page by ID. Use this tool to list all the services linked to a particular Status Page by providing the Status Page ID. Requires appropriate OAuth permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status_page_id | string | Required | The unique identifier of the Status Page to retrieve associated services. |
Requirements
Output
json— Response from the API endpoint 'listStatusPageServices'.PagerdutyApi.ListStatusPageSeverities
Retrieve severities for a specified status page. Use this tool to get a list of severities associated with a specific status page by providing its ID. Requires `status_pages.read` permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status_page_id | string | Required | The unique identifier for the status page to retrieve severities. |
post_type_filter | string | Optional | Specify the type of post to filter. Options: 'incident' or 'maintenance'. |
Requirements
Output
json— Response from the API endpoint 'listStatusPageSeverities'.PagerdutyApi.ListStatusPageStatuses
Retrieve statuses for a specific status page by ID. Use this tool to list the statuses of a status page using its ID. This requires the `status_pages.read` OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status_page_id | string | Required | The unique ID of the status page to retrieve statuses for. |
filter_by_post_type | string | Optional | Filter statuses by post type. Options include 'incident' or 'maintenance'. |
Requirements
Output
json— Response from the API endpoint 'listStatusPageStatuses'.PagerdutyApi.ListStatusPageSubscriptions
Retrieve subscriptions for a specific status page by ID. Use this tool to get a list of subscriptions associated with a specific status page by providing the status page ID. Useful for managing or viewing existing subscriptions on the page.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
status_page_id | string | Required | The unique identifier for the status page. Required to retrieve subscriptions associated with it. |
subscription_channel_filter | string | Optional | Specify the channel to filter subscriptions. Options: webhook, email, slack. |
subscription_status_filter | string | Optional | Filter the list of subscriptions by their status: 'active' or 'pending'. |
Requirements
Output
json— Response from the API endpoint 'listStatusPageSubscriptions'.PagerdutyApi.ListStatusUpdates
Retrieve post updates for a specific status page and post ID. This tool retrieves a list of post updates for a given status page and post ID. It should be called when you need detailed updates for a specific post on a status page. Requires appropriate OAuth permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique ID of the status page resource for which updates are needed. |
status_page_post_id | string | Required | The ID of the specific status page post to retrieve updates for. This identifies which post's updates will be listed. |
filter_by_reviewed_status | string | Optional | Filter post updates by their reviewed status. Options are 'approved' or 'not_reviewed'. |
Requirements
Output
json— Response from the API endpoint 'listStatusPagePostUpdates'.PagerdutyApi.ListTeamMembers
Retrieve details of members in a specified team. Use to get information about users and escalation policies associated with a team in an organization. Requires appropriate OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_id | string | Required | The unique identifier for the team whose members you want to retrieve. |
include_total_in_pagination | boolean | Optional | Set to true to populate the total field in pagination responses. Default is false for faster response times. |
include_users_in_response | string | Optional | Include additional models such as 'users' in the team members response. |
pagination_offset | integer | Optional | Integer to set the starting point for pagination in search results. |
results_per_page | integer | Optional | Specifies the number of results to return per page. |
Requirements
Output
json— Response from the API endpoint 'listTeamUsers'.PagerdutyApi.ListUserHandoffNotificationRules
List handoff notification rules for a PagerDuty user. Use this tool to retrieve the handoff notification rules for a specific user in a PagerDuty account. This can be helpful to understand how notifications are managed for user on-call handoffs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_id | string | Required | The unique identifier of the PagerDuty user whose handoff notification rules you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getUserHandoffNotificationRules'.PagerdutyApi.ListUserLicenseAllocations
Retrieve licenses allocated to users in your account. Use this tool to get a list of all licenses allocated to users within your account. This can be useful for tracking license usage or managing permissions. Requires `licenses.read` OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_offset | integer | Optional | The starting position for pagination in the search results. |
results_per_page | integer | Optional | Specifies the number of results to display per page when retrieving user licenses. |
Requirements
Output
json— Response from the API endpoint 'listLicenseAllocations'.PagerdutyApi.ListUserNotificationRules
Retrieve a PagerDuty user's notification rules. Use this tool to list the notification rules associated with a specific PagerDuty user. This can help you understand the methods and conditions under which users are notified about incidents and other account activities.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_resource_id | string | Required | The unique identifier of the PagerDuty user whose notification rules are to be retrieved. |
incident_urgency | string | Optional | Specify the incident urgency for the notification rules: 'high', 'low', or 'all'. Defaults to 'high'. |
include_additional_details | string | Optional | Specify additional details to include, such as 'contact_methods'. |
Requirements
Output
json— Response from the API endpoint 'getUserNotificationRules'.PagerdutyApi.ListWebhookSubscriptions
Retrieve existing webhook subscriptions from PagerDuty. Use this tool to list webhook subscriptions. It can filter subscriptions by service or team using `filter_type` and `filter_id` parameters. Useful for managing and configuring v3 webhooks. Requires 'webhook_subscriptions.read' permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_total_in_pagination | boolean | Optional | Set to true to populate the `total` field in pagination responses. Useful if you need the total number of entries. |
pagination_offset | integer | Optional | Offset to start the pagination of search results. |
resource_filter_id | string | Optional | The ID of the resource to filter upon. Required if filtering by service or team. |
resource_filter_type | string | Optional | Specify the type of resource to filter webhook subscriptions by, such as 'account', 'service', or 'team'. |
results_per_page | integer | Optional | Specify the number of webhook subscription results to return per page. |
Requirements
Output
json— Response from the API endpoint 'listWebhookSubscriptions'.PagerdutyApi.ListWorkflowIntegrationConnections
Retrieve all workflow integration connections from PagerDuty. This tool is used to list all Workflow Integration Connections available in PagerDuty. It requires proper OAuth scope for access.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_partial_name | string | Optional | Filter integrations by a partial name match to narrow down the results. |
next_results_cursor | string | Optional | Optional parameter to retrieve the next set of results from the API. Typically obtained from the previous request's `next_cursor` field. If not provided, the request starts from the beginning. |
response_limit | integer | Optional | The maximum number of results to return for the request. |
Requirements
Output
json— Response from the API endpoint 'listWorkflowIntegrationConnections'.PagerdutyApi.ListWorkflowIntegrations
Retrieve a list of available workflow integrations. Use this tool to obtain a list of available workflow integrations from PagerDuty. Requires specific OAuth permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_deprecated_integrations | boolean | Optional | Set to true to include deprecated integrations in the response; false to exclude them. |
next_results_cursor | string | Optional | A string to request the next set of results, usually from the `next_cursor` field of the previous response. Defaults to starting at the beginning if not provided. |
result_limit | integer | Optional | The limit on the number of workflow integrations to return in the response. |
Requirements
Output
json— Response from the API endpoint 'listWorkflowIntegrations'.PagerdutyApi.ManageIncidentStatus
Manage PagerDuty incident status and assignments. This tool allows you to acknowledge, resolve, escalate, or reassign a PagerDuty incident. It should be used when you need to update the status or assignment of an existing incident. OAuth scope 'incidents.write' is required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_id | string | Optional | The unique identifier of the incident to be managed. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
user_email_for_request | string | Optional | Email address of a valid user associated with the account making the request. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateIncident'.PagerdutyApi.MergeIncidents
Merge source incidents into a target incident. This tool merges a list of source incidents into a specified target incident. The target incident will include alerts from the source incidents, and the source incidents will be resolved. Only incidents with alerts or those manually created in the UI can be merged. Ensure the target incident remains open and does not exceed 1000 alerts after merging. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The ID of the target incident for merging source incidents. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
user_email_address | string | Optional | The email address of a valid user associated with the account making the request. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'mergeIncidents'.PagerdutyApi.MigrateIntegrationToEventOrchestration
Migrate an integration to a different event orchestration. Move an Integration and its Routing Key from one Event Orchestration to another as specified in the request. Future events will be processed by the new Event Orchestration's Rules. Requires appropriate OAuth permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
event_orchestration_id | string | Optional | The unique identifier of an Event Orchestration to migrate the integration to. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'migrateOrchestrationIntegration'.PagerdutyApi.ModifyStatusPagePostUpdate
Update a specific status page post update. Use this tool to update details of a specific status page post by providing the required Post ID and Post Update ID. Appropriate for modifying existing post updates. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier for the resource to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
status_page_post_id | string | Optional | The unique ID of the Status Page Post to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
status_page_post_update_id | string | Optional | The unique identifier for the specific status page post update to be modified. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateStatusPagePostUpdate'.PagerdutyApi.PreviewOnCallSchedule
Generate a preview of an on-call schedule without saving it. This tool previews an on-call schedule, allowing users to see time periods when team members are on-call without making any permanent changes. Useful for planning and adjustments before finalizing the schedule. Requires appropriate OAuth permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
start_date_range | string | Optional | The start date and time for the schedule preview. Use ISO 8601 format (e.g., '2023-10-01T10:00:00Z'). Only used when mode is 'execute'. |
end_date | string | Optional | The end date of the range for the on-call schedule preview. Format as ISO 8601 string. Only used when mode is 'execute'. |
include_overflow_entries | boolean | Optional | Set to true to allow schedule entries to overflow beyond the date range bounds. Defaults to false. True includes entries beyond specified dates. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createSchedulePreview'.PagerdutyApi.RemoveAddon
Remove an existing add-on from PagerDuty. Use this tool to delete an existing add-on in PagerDuty, which allows developers to integrate new functionality into the UI. This operation requires 'addons.write' OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier for the add-on to be removed. |
Requirements
Output
json— Response from the API endpoint 'deleteAddon'.PagerdutyApi.RemoveServiceCacheVariable
Delete external data cache variable on a service orchestration. Deletes data for an 'external_data' type cache variable within a service event orchestration. Useful for managing values used in orchestration rules. Requires 'services.write' authorization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cache_variable_id | string | Required | The unique identifier for an external data cache variable to be deleted from the service event orchestration. |
service_identifier | string | Required | The unique identifier for the service. Required for deleting cache variable data. |
Requirements
Output
json— Response from the API endpoint 'deleteExternalDataCacheVarDataOnServiceOrch'.PagerdutyApi.RemoveServiceDependency
Disassociate dependencies between two services. Use this tool to disassociate or remove dependencies between two business or technical services in PagerDuty. Suitable for scenarios where you need to update or modify service relationships managed by different teams. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'deleteServiceDependency'.PagerdutyApi.RemoveServiceFromIncidentTrigger
Remove a service from an incident workflow trigger. Use this tool to remove an existing service from a specific incident workflow trigger in PagerDuty. This action requires scoped OAuth with `incident_workflows.write` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_identifier | string | Required | The unique identifier for the service to remove from the incident workflow trigger. |
trigger_identifier | string | Required | The unique identifier for the incident workflow trigger from which the service will be removed. |
Requirements
Output
json— Response from the API endpoint 'deleteServiceFromIncidentWorkflowTrigger'.PagerdutyApi.RemoveTag
Remove an existing tag from escalation policies, teams, or users. This tool removes an existing tag applied to escalation policies, teams, or users in PagerDuty. Use this when you need to delete a tag for organizational or operational purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the resource (tag) to be removed. |
Requirements
Output
json— Response from the API endpoint 'deleteTag'.PagerdutyApi.RemoveTeamEscalationPolicy
Remove an escalation policy from a team. This tool removes an escalation policy from a specific team in PagerDuty. It's useful when you need to alter team configurations by deleting unnecessary or outdated escalation policies.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
escalation_policy_id | string | Required | The identifier of the escalation policy to remove from the team. |
resource_id | string | Required | The unique identifier of the team resource from which the escalation policy will be removed. |
Requirements
Output
json— Response from the API endpoint 'deleteTeamEscalationPolicy'.PagerdutyApi.RemoveUserContactMethod
Remove a user's contact method from PagerDuty. Use this tool to delete a user's contact method in PagerDuty. Useful for maintaining or updating user information. Requires appropriate OAuth permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_method_id | string | Required | The identifier for the user's contact method to be removed from PagerDuty. |
user_resource_id | string | Required | The ID of the user resource to identify which user the contact method belongs to. |
Requirements
Output
json— Response from the API endpoint 'deleteUserContactMethod'.PagerdutyApi.RemoveUserFromPagerduty
Remove an existing user from PagerDuty. Use this tool to delete a user from PagerDuty. Ensure the user has no assigned incidents unless your pricing plan supports the offboarding feature. The incidents reassignment is asynchronous and may not complete before the API call returns. This tool is suitable for managing user accounts on PagerDuty.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_id | string | Required | The unique identifier of the user to be removed from PagerDuty. |
Requirements
Output
json— Response from the API endpoint 'deleteUser'.PagerdutyApi.RemoveUserFromTeam
Remove a user from a specific team in PagerDuty. This tool removes a specified user from a team in PagerDuty. It should be called when you need to manage team memberships by deleting a user. Requires appropriate OAuth scope 'teams.write'.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_id | string | Required | The ID of the team from which the user will be removed. |
team_user_id | string | Required | The ID of the user to be removed from the team in PagerDuty. |
Requirements
Output
json— Response from the API endpoint 'deleteTeamUser'.PagerdutyApi.RemoveUserNotificationRule
Remove a user's notification rule on PagerDuty. This tool removes a specific notification rule from a user's profile on PagerDuty. Useful for managing user notification settings within an account. Requires appropriate OAuth permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
notification_rule_identifier | string | Required | The unique identifier for the notification rule to be removed from the user's profile. |
resource_id | string | Required | The ID of the user who owns the notification rule. |
Requirements
Output
json— Response from the API endpoint 'deleteUserNotificationRule'.PagerdutyApi.RemoveUserStatusUpdateNotificationRule
Removes a user's status update notification rule in PagerDuty. Use this tool to delete a notification rule for status updates assigned to a specific user in PagerDuty. This is helpful for managing user notification preferences and ensuring up-to-date settings. OAuth permission 'users.write' is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the user whose notification rule is being deleted. |
status_update_notification_rule_id | string | Required | The ID of the status update notification rule for a specific user in PagerDuty. |
Requirements
Output
json— Response from the API endpoint 'deleteUserStatusUpdateNotificationRule'.PagerdutyApi.RenderStatusUpdateTemplate
Renders a status update template with given incident data. Use this tool to render a status update template by providing the incident ID and a status update message. This helps in generating formatted updates based on specific incident details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_id | string | Optional | The ID of the incident resource to render the template for. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'renderTemplate'.PagerdutyApi.ResolveOrReassociateIncidentAlerts
Resolve or reassign alerts to incidents. Use this tool to resolve multiple alerts or associate them with different incidents in PagerDuty. Only up to 250 alerts can be updated at a time. Ideal for managing alerts detected by monitoring systems that need resolution or reassessment. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_resource_id | string | Optional | The unique identifier for the incident resource to be resolved or reassociated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
user_email | string | Optional | The email address of a valid user associated with the account making the request. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
results_per_page | integer | Optional | Specify the number of results to be returned per page. Must be an integer. Only used when mode is 'execute'. |
pagination_offset | integer | Optional | Offset for pagination to specify where search results should begin. Only used when mode is 'execute'. |
populate_total | boolean | Optional | Set to `true` to populate the `total` field in pagination responses, otherwise it remains `null` for faster response. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateIncidentAlerts'.PagerdutyApi.ResolveOrUpdateIncidentAlert
Resolve an alert or update its associated incident. Use this tool to resolve a specific alert or associate it with a different parent incident in PagerDuty. This is useful when managing incidents that require updates or resolution. Ensure you have `incidents.write` OAuth permissions before calling this tool. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier for the resource you want to update or resolve. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
alert_id | string | Optional | The ID of the alert to resolve or update its parent incident. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
user_email_address | string | Optional | The email address of a valid user associated with the account making the request. Ensure it is linked to the account with necessary permissions. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateIncidentAlert'.PagerdutyApi.RetrieveAnalyticsData
Provides aggregated incident metrics for selected responders. This tool retrieves aggregated metrics such as Seconds to Resolve, Seconds to Engage, and Sleep Hour Interruptions for all selected responders. It is called to analyze responder performance and incident handling efficiency. Note that the analytics data may take up to 24 hours to update. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'getAnalyticsMetricsRespondersAll'.PagerdutyApi.RetrieveImpactfulSupportingBusinessServices
Retrieve top supporting Business Services by impact for a given service. This tool retrieves up to 200 supporting Business Services that have the highest impact on a specified Business Service. The services are sorted by impact, recency, and name. Use this tool to analyze service dependencies and impacts efficiently. Requires OAuth with 'services.read' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_id | string | Required | The unique identifier for the business service to retrieve its supporting services by impact. |
include_additional_fields | string | Optional | Specify additional fields to include, such as highest impacting priority or total impacted count. Accepts 'services.highest_impacting_priority' or 'total_impacted_count'. |
resource_ids | string | Optional | List of resource IDs to retrieve their supporting Business Services impacts. Include multiple IDs if needed. |
Requirements
Output
json— Response from the API endpoint 'getBusinessServiceSupportingServiceImpacts'.PagerdutyApi.RetrievePastIncidents
Retrieve past incidents with similar metadata. Fetches incidents from the past 6 months that share similar metadata and were generated on the same service as a given incident. Available with Event Intelligence or Digital Operations plans only.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_id | string | Required | The unique identifier of the incident. Used to fetch past incidents with similar metadata. |
include_total_past_incidents | boolean | Optional | Set to true to include the total number of past incidents in the response. This may increase response time. |
results_limit | integer | Optional | Specifies the maximum number of past incidents to return. |
Requirements
Output
json— Response from the API endpoint 'getPastIncidents'.PagerdutyApi.RetrieveSessionConfigurations
Retrieve session configurations for a PagerDuty account. This tool retrieves session configurations for a PagerDuty account, either returning all available configurations or a specific type if requested. No configurations result in a 404 error. Use it to access mobile and web session settings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
session_configuration_type | string | Optional | Specifies session configuration type: 'mobile' or 'web'. Omit to return both types. |
Requirements
Output
json— Response from the API endpoint 'getSessionConfigurations'.PagerdutyApi.SendChangeEvent
Send a change event to PagerDuty's API. Use this tool to send change events to PagerDuty via the V2 Events API. Useful for logging changes in systems and notifying PagerDuty of updates.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'createChangeEvent'.PagerdutyApi.SetBusinessServicePriority
Set the priority threshold for a business service. Use this tool to update the account-level priority threshold for a business service. Requires the 'services.write' OAuth scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'putBusinessServicePriorityThresholds'.PagerdutyApi.SetServiceCustomFieldValues
Update custom field values for a specific service. Use this tool to set custom field values for a specific service in PagerDuty. It requires the scoped OAuth `services.write` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
service_id | string | Optional | The unique identifier of the service whose custom field values need to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateServiceCustomFieldValues'.PagerdutyApi.SnoozeIncident
Temporarily suspend alerts for an incident. Use this tool to pause notifications for a specific incident, allowing you to manage alerts more effectively. Ideal for situations where immediate attention isn't required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_id | string | Optional | The unique ID of the incident to snooze. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
user_email | string | Optional | The email address of a valid user associated with the account making the request. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createIncidentSnooze'.PagerdutyApi.StartIncidentWorkflow
Start an instance of an incident workflow for automation. This tool initiates an incident workflow, which consists of configurable steps and triggers, to execute automated actions related to an incident. Use it to automate processes in response to specific incident events. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The ID of the resource to start the incident workflow for. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createIncidentWorkflowInstance'.PagerdutyApi.SubscribeBusinessServiceEntities
Subscribe entities to a specified business service. This tool subscribes specified entities to a business service, allowing them to receive notifications. It should be called when you need to add entities to the notification list for a business service. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier of the business service to which entities will be subscribed. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createBusinessServiceNotificationSubscribers'.PagerdutyApi.SubscribeIncidentNotifications
Subscribe entities to incident status update notifications. This tool subscribes specified entities to receive notifications about updates to an incident's status. It requires the `subscribers.write` OAuth scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The ID of the resource to subscribe entities for notification updates. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createIncidentNotificationSubscribers'.PagerdutyApi.SubscribeToBusinessService
Subscribe your account to a PagerDuty business service. Use this tool to subscribe your account to a specified business service in PagerDuty. Authorization with the 'subscribers.write' scope is required for this action.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The ID of the business service resource to subscribe to. |
Requirements
Output
json— Response from the API endpoint 'createBusinessServiceAccountSubscription'.PagerdutyApi.TestWebhookSubscription
Test a webhook subscription by firing a test event. This tool tests a webhook subscription by firing a `pagey.ping` event to the specified destination, ensuring the webhook is correctly configured. Requires appropriate OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique ID of the webhook subscription to be tested. |
Requirements
Output
json— Response from the API endpoint 'testWebhookSubscription'.PagerdutyApi.UnsubscribeBusinessServiceNotifications
Unsubscribe users from Business Service notifications. Use this tool to unsubscribe specific users from receiving notifications for a particular Business Service on PagerDuty. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier of the resource to unsubscribe from. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'removeBusinessServiceNotificationSubscriber'.PagerdutyApi.UnsubscribeFromBusinessService
Unsubscribe an account from a business service. Use this tool to remove your account's subscription from a specified business service. This action requires appropriate OAuth permissions ('subscribers.write').
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
business_service_id | string | Required | The unique identifier of the business service to unsubscribe from. |
Requirements
Output
json— Response from the API endpoint 'removeBusinessServiceAccountSubscription'.PagerdutyApi.UnsubscribeIncidentNotification
Unsubscribe users from incident status update notifications. Removes specified subscribers from receiving status update notifications for a particular incident. Useful for managing notification preferences in incident response scenarios. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier for the incident resource to unsubscribe from notifications. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'removeIncidentNotificationSubscribers'.PagerdutyApi.UnsubscribeTeamNotifications
Unsubscribe a team from specific notification subscriptions. Use this tool to unsubscribe a specific team from receiving notifications on specified entities. This is helpful when you need to manage or reduce notification overload for teams. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The ID of the resource to unsubscribe from notifications. This should be a string value representing the unique identifier for the specific resource. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'removeTeamNotificationSubscriptions'.PagerdutyApi.UnsubscribeUserNotifications
Unsubscribe a user from notification subscriptions. Use this tool to unsubscribe a specific user from notifications associated with certain entities in the system. Ideal for managing user notification preferences efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier of the resource from which to unsubscribe the user. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'unsubscribeUserNotificationSubscriptions'.PagerdutyApi.UpdateAlertGroupingSetting
Update an existing alert grouping setting in PagerDuty. Use this tool to update an alert grouping setting in PagerDuty. This is particularly useful for managing how alerts are grouped and ensuring the correct configurations are in place. Note that if 'services' are not provided, existing services will remain unchanged. Requires scoped OAuth with `services.write`. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The ID of the alert grouping setting to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'putAlertGroupingSetting'.PagerdutyApi.UpdateAutomationAction
Update an existing automation action. Use this tool to update the details of an existing automation action by specifying its ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier of the automation action to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateAutomationAction'.PagerdutyApi.UpdateAutomationActionRunner
Update an Automation Action runner in PagerDuty. This tool updates the configuration of a specific Automation Action runner in PagerDuty. It should be called when you need to modify the settings or details of an existing runner, such as changing the runner's parameters or status. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier of the Automation Action runner to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateAutomationActionsRunner'.PagerdutyApi.UpdateBusinessService
Update the details of a business service in PagerDuty. Use this tool to update an existing business service, which models capabilities across multiple technical services. This tool is useful when business services require modifications, such as changes in ownership or scope. It requires the `services.write` OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier for the business service that needs updating. |
business_service_description | string | Optional | The description of the Business Service to be updated. |
business_service_name | string | Optional | The name of the Business Service to be updated. |
business_service_owner | string | Optional | Specify the owner of the Business Service. Typically, this should be the point of contact responsible for the service. |
team_id | string | Optional | The ID of the team associated with the business service. |
Requirements
Output
json— Response from the API endpoint 'updateBusinessService'.PagerdutyApi.UpdateCacheVariable
Update a cache variable for event orchestration rules. This tool updates a cache variable in a Global Event Orchestration, allowing stored event data to be used in orchestration rules. Useful for modifying conditions or actions based on event data. Requires `event_orchestrations.write` OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cache_variable_id | string | Required | The ID of the cache variable to update for the event orchestration. |
event_orchestration_id | string | Required | The ID of the Event Orchestration to update the cache variable for. |
Requirements
Output
json— Response from the API endpoint 'updateCacheVarOnGlobalOrch'.PagerdutyApi.UpdateCacheVariableData
Update cache variable data for service event orchestration. This tool updates the data for an external data type cache variable within a service event orchestration. Use it to modify string, number, or boolean values stored via a dedicated API endpoint. These values can be used in event orchestration conditions and actions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cache_variable_id | string | Required | The unique identifier for the Cache Variable to be updated. |
service_identifier | string | Required | A unique identifier for the service whose cache variable data is to be updated. |
Requirements
Output
json— Response from the API endpoint 'updateExternalDataCacheVarDataOnServiceOrch'.PagerdutyApi.UpdateChangeEvent
Updates an existing change event in PagerDuty. Use this tool to modify details of an existing change event using PagerDuty's updateChangeEvent API. Requires appropriate OAuth scope (`change_events.write`). Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier of the change event to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateChangeEvent'.PagerdutyApi.UpdateCustomFieldOption
Update a field option for a custom incident field. This tool updates a specific field option for a custom field in a PagerDuty incident type. Use it to modify custom data for improved filtering, search, and analytics features. Requires 'custom_fields.write' OAuth scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_type_id_or_name | string | Optional | The ID or name of the PagerDuty incident type. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
field_option_identifier | string | Optional | The unique identifier for the field option to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
field_id | string | Optional | The ID of the custom field to be updated in the incident type. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateIncidentTypeCustomFieldFieldOption'.PagerdutyApi.UpdateEscalationPolicy
Update an existing escalation policy and its rules. Use this tool to update an existing escalation policy and define which user should be alerted at which time. This tool requires appropriate OAuth credentials with `escalation_policies.write` permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
escalation_policy_id | string | Optional | The unique identifier of the escalation policy to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateEscalationPolicy'.PagerdutyApi.UpdateEventIntegration
Update an event orchestration integration. Use this tool to update an integration associated with an event orchestration. This is useful when you need to configure or change settings for how events are sent to PagerDuty using a specific integration. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
event_orchestration_id | string | Optional | The unique ID of the event orchestration to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
integration_id_for_update | string | Optional | The ID of an Integration to update within the event orchestration. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateOrchestrationIntegration'.PagerdutyApi.UpdateEventOrchestration
Update a Global Event Orchestration in PagerDuty. This tool updates a Global Event Orchestration, allowing users to define and modify sets of Global Rules and Router Rules for event routing and processing. It requires 'event_orchestrations.write' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
event_orchestration_id | string | Optional | The unique identifier for the Event Orchestration to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateOrchestration'.PagerdutyApi.UpdateEventOrchestrationFeatures
Update features for Event Orchestration in PagerDuty. This tool updates the enablement settings for specific product add-ons on an Event Orchestration in PagerDuty. Currently supports only the `aiops` feature. Use this to enable or disable features contained within the addon. Note: If the account lacks entitlement for AIOps, the change will occur but with a warning. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
event_orchestration_id | string | Optional | The unique identifier for an Event Orchestration to update features. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
feature_enablement_identifier | string | Optional | Specifies the feature enablement identifier for a product addon. Currently, only 'aiops' is supported. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateEventOrchestrationFeatureEnablements'.PagerdutyApi.UpdateEventOrchestrationGlobalRules
Update global orchestration rules for event orchestration. This tool updates the Global Orchestration Rules for an Event Orchestration in PagerDuty. It is used to modify and enhance events by evaluating them against a set of global rules and potentially routing them for further processing. Use this tool when you need to adjust the rules governing all events within a specific orchestration. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
event_orchestration_id | string | Optional | The unique identifier for an Event Orchestration to update its global rules. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateOrchPathGlobal'.PagerdutyApi.UpdateEventRule
Update an existing event rule within a ruleset. This tool updates an event rule in a specific ruleset in PagerDuty. It supports partial updates, allowing modification of any combination of writable fields. It is recommended to migrate to Event Orchestration for enhanced features. OAuth with `event_rules.write` scope is required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique ID of the ruleset resource to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
event_rule_id | string | Optional | The unique identifier of the Event Rule to update within the ruleset. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateRulesetEventRule'.PagerdutyApi.UpdateExtension
Update an existing extension in PagerDuty. Use this tool to update an existing extension in PagerDuty. Extensions are linked to services and require appropriate permissions. This call requires 'extensions.write' OAuth scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The ID of the extension resource you want to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateExtension'.PagerdutyApi.UpdateExternalDataCacheVariable
Update values for external data cache variables in global event orchestration. This tool updates the data for an external data type cache variable within a global event orchestration in PagerDuty. It's used to store string, number, or boolean values, which can be utilized in conditions or actions in event orchestration rules. Requires appropriate OAuth permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cache_variable_id | string | Required | The unique identifier for a Cache Variable within the event orchestration. This ID is used to specify which cache variable's data is to be updated. |
event_orchestration_id | string | Required | The unique identifier for an Event Orchestration to be updated. |
Requirements
Output
json— Response from the API endpoint 'updateExternalDataCacheVarDataOnGlobalOrch'.PagerdutyApi.UpdateIncidentCustomField
Update a custom field for a specific incident type. Use this tool to update custom fields for incident types, providing additional context and support for filtering and analytics. Custom field options can be modified in the same call. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_type_identifier | string | Optional | The ID or name of the specific incident type to update the custom field for. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
field_identifier | string | Optional | Provide the unique ID of the field to be updated for the incident type. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateIncidentTypeCustomField'.PagerdutyApi.UpdateIncidentCustomFields
Update custom field values for a specific incident. This tool updates custom field values for a given incident in PagerDuty. Requires 'incidents.write' OAuth scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_id | string | Optional | The ID of the incident to update custom field values. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'setIncidentFieldValues'.PagerdutyApi.UpdateIncidentLogEntry
Update an existing incident log entry channel. This tool updates an existing incident log entry channel in PagerDuty. Use it when you need to modify the communication channel for a specific log entry. Requires OAuth scope: `incidents.write`. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_resource_id | string | Optional | The unique ID of the incident log entry resource to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
user_email | string | Optional | The email address of a valid user associated with the account making the log entry update request. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateLogEntryChannel'.PagerdutyApi.UpdateIncidents
Manage the status of multiple incidents. Use this tool to acknowledge, resolve, escalate, or reassign up to 250 incidents simultaneously. It is useful for addressing and managing problems that need immediate attention. Ensure to stay within the rate limits and have the required 'incidents.write' OAuth permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
user_email | string | Optional | The email address of a valid user associated with the account making the request. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
results_per_page | integer | Optional | Specifies the maximum number of incident results to return per page. Only used when mode is 'execute'. |
pagination_start_offset | integer | Optional | Offset from where to start paginated search results. This is used to navigate search results effectively. Only used when mode is 'execute'. |
include_total_in_pagination | boolean | Optional | Set to true to populate the 'total' field in pagination responses. Otherwise, it remains null for faster response times. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateIncidents'.PagerdutyApi.UpdateIncidentServiceImpact
Update the impact of an incident on a business service. Use this tool to change the impact level of a specific incident on a specified business service. Useful for managing and communicating the effects of incidents within an organization. Requires appropriate OAuth permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier for the incident resource to update impact. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
business_service_id | string | Optional | The ID of the specific business service affected by the incident. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'putIncidentManualBusinessServiceAssociation'.PagerdutyApi.UpdateIncidentStatus
Create a status update for a specific incident. Use this tool to update the status of a specific incident in PagerDuty. It allows for optional customization of the email notification through the `subject` and `html_message` properties. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_id | string | Optional | The ID of the incident to update. This is required to specify which incident the status update is for. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
requestor_email | string | Optional | The email address of a valid user making the request in PagerDuty. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createIncidentStatusUpdate'.PagerdutyApi.UpdateIncidentType
Update or categorize an incident type on PagerDuty. Use this tool to update or categorize an incident type on PagerDuty, such as security or major incidents. Requires appropriate OAuth scope for modification. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_type_id_or_name | string | Optional | The ID or name of the incident type to be updated. Specify to categorize the incident. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateIncidentType'.PagerdutyApi.UpdateIncidentWorkflow
Updates an existing incident workflow in PagerDuty. Use this tool to update an incident workflow, which includes configurable steps and triggers for executing automated actions on an incident. Requires appropriate OAuth permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_workflow_id | string | Optional | The unique ID of the incident workflow to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'putIncidentWorkflow'.PagerdutyApi.UpdateIncidentWorkflowTrigger
Update an existing incident workflow trigger. Use this tool to update details of an existing incident workflow trigger in PagerDuty. This should be called when modifications to workflow triggers are needed for incident management. Scoped OAuth with 'incident_workflows.write' permission is required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The ID of the incident workflow trigger to be updated in PagerDuty. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateIncidentWorkflowTrigger'.PagerdutyApi.UpdateMaintenanceWindow
Update an existing maintenance window for services. Use this tool to modify an existing maintenance window, temporarily disabling specified services for a defined period. Ideal for scheduling downtime updates or adjustments. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier for the maintenance window to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateMaintenanceWindow'.PagerdutyApi.UpdateOauthClient
Update an existing OAuth client configuration. This tool updates an existing OAuth client, triggering token validation with the OAuth server. Requires admin or owner role permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier for the OAuth client resource to update. |
oauth_client_id | string | Optional | The OAuth client ID as provided by the OAuth server. |
oauth_client_name | string | Optional | A human-readable name for the OAuth client. |
oauth_client_secret | string | Optional | The OAuth client secret provided by the OAuth server for authentication. |
oauth_grant_type | string | Optional | Specifies the OAuth grant type to use, currently only 'client_credentials' is supported. Always use 'client_credentials' as input. |
oauth_scopes_requested | string | Optional | The OAuth scopes requested for this client. Provide as a space-separated string. |
oauth_token_endpoint_url | string | Optional | The URL for the OAuth token endpoint required for this client. |
Requirements
Output
json— Response from the API endpoint 'updateOauthClient'.PagerdutyApi.UpdateOnCallSchedule
Update an existing on-call schedule in PagerDuty. Use this tool to modify the time periods that users are on-call in an existing schedule in PagerDuty. This function is useful when duty schedules need adjustments. Requires 'schedules.write' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
schedule_id | string | Optional | The ID of the on-call schedule to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
allow_schedule_overflow | boolean | Optional | Allows schedule entries to exceed date range bounds if set to true. Defaults to false. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateSchedule'.PagerdutyApi.UpdateOrchestrationRoutingRules
Update rules for routing events in Global Orchestration. This tool updates the routing rules for a Global Orchestration in PagerDuty. It evaluates events against rules to determine routing to specific services. Use this tool when you need to modify how events are routed within a global orchestration. Requires necessary OAuth permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
event_orchestration_id | string | Optional | The unique identifier for the Event Orchestration to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateOrchPathRouter'.PagerdutyApi.UpdatePagerdutyAddon
Update an existing add-on in PagerDuty. This tool updates a specific add-on in PagerDuty by embedding a given URL in an iframe accessible through the UI. It requires the 'addons.write' OAuth scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier for the add-on resource to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateAddon'.PagerdutyApi.UpdatePagerdutyUser
Update an existing PagerDuty user's information. Use this tool to update details of a user in a PagerDuty account. This is useful for modifying user permissions, contact information, or any other user-related data. Requires appropriate OAuth permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
user_id | string | Optional | The unique identifier for the user to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateUser'.PagerdutyApi.UpdateRuleset
Update an existing ruleset in PagerDuty. Use this tool to update a ruleset in PagerDuty, which routes events to endpoints and defines actions based on event content. Note: Rulesets are being phased out, and migration to Event Orchestration is recommended. Requires `event_rules.write` OAuth scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier for the ruleset to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateRuleset'.PagerdutyApi.UpdateServiceCustomField
Update a custom field for a PagerDuty service. This tool updates a specified custom field for services in PagerDuty. It requires OAuth with `custom_fields.write` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
service_field_id | string | Optional | The unique identifier of the custom field to update in PagerDuty. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateServiceCustomField'.PagerdutyApi.UpdateServiceCustomFieldOption
Update a custom field option in a service. Use this tool to update a specific custom field option for a service in PagerDuty. This is useful when you need to adjust configurations related to custom fields. Requires appropriate OAuth permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
field_id | string | Optional | The unique identifier of the field to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
field_option_id | string | Optional | The ID of the custom field option to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateServiceCustomFieldOption'.PagerdutyApi.UpdateServiceDetails
Update details of an existing service in PagerDuty. Update information for an existing service, such as an application, component, or team. Ensure the open incident limit is not exceeded and handle `auto_resolve_timeout` appropriately. Requires `services.write` OAuth scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
service_id | string | Optional | The unique identifier of the service to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateService'.PagerdutyApi.UpdateServiceEventCacheVariable
Update a cache variable for a service event orchestration. This tool updates a cache variable for a specific service event orchestration in PagerDuty. Cache variables store event data used in orchestration rules. Requires 'services.write' permission. Useful for modifying orchestration rules or conditions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cache_variable_id | string | Required | The ID of the cache variable to update for the service event orchestration. |
service_identifier | string | Required | The unique identifier for the service to update the cache variable on a service event orchestration. |
Requirements
Output
json— Response from the API endpoint 'updateCacheVarOnServiceOrch'.PagerdutyApi.UpdateServiceEventRule
Update a specific event rule within a service. This tool updates an event rule on a particular service in PagerDuty. It supports partial updates, meaning you can provide any number of writable fields to modify the rule. This should be called when there's a need to adjust event rules to maintain or enhance service monitoring. Note: Migration to Event Orchestration is recommended as these rules will be phased out soon. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique ID of the service resource to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
event_rule_id | string | Optional | The ID of the Event Rule to update within the service. It identifies which event rule the update will apply to. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateServiceEventRule'.PagerdutyApi.UpdateServiceFeatureEnablement
Update the feature enablement for a service addon. Update the feature enablement setting for a specific product addon on a PagerDuty service. This tool manages enabling or disabling the addon features. Currently, only 'aiops' is supported. Warnings may be returned if the account is not entitled to use AIOps features. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The ID of the PagerDuty resource to update the feature enablement for. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
feature_enablement_identifier | string | Optional | Specify the feature enablement identifier, typically the addon name. Currently, only 'aiops' is supported. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateServiceFeatureEnablement'.PagerdutyApi.UpdateServiceIntegration
Update an integration for a specific service. Use this tool to update an integration that belongs to a specific service in PagerDuty. Services represent applications, components, or teams for incident management. Appropriate for when you need to modify integration settings or details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier of the resource to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
service_integration_id | string | Optional | The unique identifier for the integration associated with the service to update. This ID specifies which integration to modify. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateServiceIntegration'.PagerdutyApi.UpdateServiceOrchestration
Update a Service Orchestration with new event rules. This tool updates a Service Orchestration in PagerDuty by modifying its event rules. It evaluates incoming events against these rules to enhance and route them effectively. Use this tool to adjust the orchestration of a service. Requires 'services.write' scope for OAuth. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
service_identifier | string | Optional | The unique identifier for the service to update the orchestration rules. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateOrchPathService'.PagerdutyApi.UpdateServiceOrchestrationStatus
Update the active status of a service orchestration. Use this tool to change whether an event will be evaluated against a service orchestration path or service ruleset. Useful for managing orchestration event paths in PagerDuty. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
service_id | string | Optional | The unique identifier for the service to update the orchestration status. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateOrchActiveStatus'.PagerdutyApi.UpdateSessionConfigurations
Create or update session configurations in PagerDuty. This tool is used to create or update session configurations for a PagerDuty account. Changes will apply immediately to new sessions, and existing sessions of specified types will be revoked. Early access is required, and scoped OAuth with `session_configurations.write` permission is necessary.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
absolute_session_time_to_live_seconds | integer | Required | Specify the absolute session time to live in seconds. |
idle_session_time_to_live | integer | Required | Specify the idle session time to live in seconds. This determines how long a session remains active without activity before being terminated. |
session_configuration_type | string | Required | Specify session configuration type: 'mobile', 'web', or a comma-separated list of both. |
Requirements
Output
json— Response from the API endpoint 'updateSessionConfigurations'.PagerdutyApi.UpdateStandard
Updates a standard in PagerDuty. Use this tool to update an existing standard in PagerDuty. Requires appropriate OAuth permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
standard_id | string | Optional | The unique identifier of the standard to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateStandard'.PagerdutyApi.UpdateStatusPagePost
Update a post on a status page by its ID. Use this tool to update an existing post on a specific status page. Requires the status pages write permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The ID of the status page resource to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
status_page_post_id | string | Optional | The ID of the status page post to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateStatusPagePost'.PagerdutyApi.UpdateStatusPagePostmortem
Update a postmortem for a specific post by ID. This tool updates a postmortem for a given post on a status page using the post ID. It requires the 'status_pages.write' scope for OAuth authorization. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique ID of the resource to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
status_page_post_id | string | Optional | The ID of the Status Page Post to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateStatusPagePostmortem'.PagerdutyApi.UpdateTeam
Update the details of an existing team. Use this tool to modify the information of an existing team, which includes users and escalation policies within an organization. Ideal for updating team configurations in response to organizational changes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
team_id | string | Optional | The unique identifier of the team to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateTeam'.PagerdutyApi.UpdateTemplate
Update an existing template in PagerDuty. Use this tool to update an existing template in PagerDuty. Suitable when modifications to a template are required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the template to be updated. |
email_body_html | string | Optional | The HTML content for the email body of the template. |
email_subject | string | Optional | The subject of the email to be updated in the template. |
short_message_template | string | Optional | The short message content for the template used in SMS, Push notifications, Slack, etc. |
template_description | string | Optional | Provide a brief description of the template. This helps to explain its purpose and content. |
template_name | string | Optional | The name of the template to update in PagerDuty. |
template_type | string | Optional | The type of template. Only 'status_update' is supported. |
Requirements
Output
json— Response from the API endpoint 'updateTemplate'.PagerdutyApi.UpdateUnroutedEventRules
Update rules for Unrouted events in Global Event Orchestration. This tool updates the rules for handling Unrouted events in a Global Event Orchestration. Use it when you need to modify how unrouted events are processed, without routing them to a specific service. The tool evaluates events against its rules and can modify or enhance them for further processing. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
event_orchestration_id | string | Optional | The unique identifier for the Event Orchestration to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateOrchPathUnrouted'.PagerdutyApi.UpdateUserContactMethod
Update a user's contact method on PagerDuty. This tool updates the contact method of a specified user in a PagerDuty account. It's used when changes to a user's contact information are needed, such as updating an email or phone number for receiving notifications. Ensure the correct permissions (`users:contact_methods.write`) are in place before making this call. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier of the user whose contact method is being updated. It should be a string representing the user's ID in PagerDuty. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
user_contact_method_id | string | Optional | The unique identifier for the user's contact method to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateUserContactMethod'.PagerdutyApi.UpdateUserHandoffNotification
Update a user's handoff notification rule in PagerDuty. This tool updates a user's handoff notification rule in a PagerDuty account. It should be called when changes to a user's notification preferences are needed, such as updating contact methods or schedules for handoff alerts. Requires `users.write` scope in OAuth. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique ID of the resource to be updated, representing the user in PagerDuty. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
handoff_notification_rule_id | string | Optional | The ID of the oncall handoff notification rule to update for the user. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateUserHandoffNotification'.PagerdutyApi.UpdateUserNotificationRule
Update a user's notification rule in PagerDuty. Use this tool to modify an existing notification rule for a user on a PagerDuty account, allowing them to manage how they receive incident notifications. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique ID of the user's notification resource to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
notification_rule_id | string | Optional | The ID of the user's notification rule to update in PagerDuty. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateUserNotificationRule'.PagerdutyApi.UpdateUserStatusNotificationRule
Update a user's status update notification rule. Use this tool to modify the notification settings for a user's status updates in PagerDuty. Useful for managing how users receive notifications in an account. Requires appropriate OAuth permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_id | string | Optional | The unique identifier for the user resource to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
status_update_notification_rule_id | string | Optional | The ID of the user's status update notification rule to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateUserStatusUpdateNotificationRule'.PagerdutyApi.UpdateWebhookSubscription
Update an existing webhook subscription. This tool updates an existing webhook subscription in PagerDuty. It should be called when you need to change any details of a webhook subscription, except for the `delivery_method`. Ensure you have the required OAuth scope: `webhook_subscriptions.write`.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_id | string | Required | The unique identifier of the webhook subscription to be updated. |
filter_object_id | string | Optional | The ID of the object used as the filter. Required unless the filter type is account_reference. |
filter_object_type | string | Optional | Specify the type of object used as the filter: 'account_reference', 'service_reference', or 'team_reference'. |
oauth_client_id | string | Optional | The ID of the OAuth client for authenticating webhook requests. This field is optional. |
send_webhook | boolean | Optional | Set to true to send a webhook. Default is true. False to disable. |
webhook_events | array<string> | Optional | List of outbound event types the subscription will receive. |
webhook_subscription_description | string | Optional | A short description of the webhook subscription. |
Requirements
Output
json— Response from the API endpoint 'updateWebhookSubscription'.PagerdutyApi.UpdateWorkflowIntegrationConnection
Update an existing Workflow Integration Connection. Call this tool to update the connection details of a specific workflow integration in PagerDuty. Useful for modifying existing configurations in integrations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
integration_id | string | Required | The ID of the Workflow Integration to be updated. Required to specify which integration connection to modify. |
resource_id | string | Required | The ID of the resource to be updated. |
Requirements
Output
json— Response from the API endpoint 'updateWorkflowIntegrationConnection'.