---
schema_version: "1"
id: ac4f7d969d00e3e09f655c4b1eb943489cd627a5f04040c4edf94677fe5ace83
title: PagerDuty Connector 1.0 Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/pagerduty-connector/latest/pagerduty-connector-reference.md
canonical_url: https://docs.mulesoft.com/pagerduty-connector/latest/pagerduty-connector-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: d9ffe95800bfa768af9dbd3d1eaa69f52bf408a1587e4c163bc28a61d36b8c50
description: MuleSoft Documentation Site
release: "1.0"
latest: true
---
---
product: PagerDuty Connector
version: 1.0
is-latest-version: true
---

# PagerDuty Connector 1.0 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## Configurations

---

### Config

Default configuration.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>Name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><p><a href="#Config_Api_key">Api Key</a></p></div></div></td><td><p>The connection types to provide to this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>ID used to reference this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></td><td></td><td></td></tr></tbody></table>

#### Connection Types

##### Api Key

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>apiKey</p></td><td><div><div><p>String</p></div></div></td><td><p>API key used to authenticate requests.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>baseUri</p></td><td><div><div><p>String</p></div></div></td><td><p>Base URI of the PagerDuty API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>Configures TLS. If using the HTTPS protocol, you must configure TLS.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

## Supported Operations

- [Create Escalation Policy](#CreateEscalationPolicy)

- [Create Incident](#CreateIncident)

- [Create Schedule](#CreateSchedule)

- [Create Service](#CreateService)

- [Create User](#CreateUser)

- [Delete Escalation Policy](#DeleteEscalationPolicy)

- [Delete Schedule](#DeleteSchedule)

- [Delete Service](#DeleteService)

- [Delete User](#DeleteUser)

- [Get Escalation Policy](#GetEscalationPolicy)

- [Get Incident](#GetIncident)

- [Get Schedule](#GetSchedule)

- [Get Service](#GetService)

- [Get User](#GetUser)

- [List Escalation Policies](#ListEscalationPolicies)

- [List Incidents](#ListIncidents)

- [List Schedules](#ListSchedules)

- [List Services](#ListServices)

- [List Users](#ListUsers)

- [Update Escalation Policy](#UpdateEscalationPolicy)

- [Update Incident](#UpdateIncident)

- [Update Schedule](#UpdateSchedule)

- [Update Service](#UpdateService)

- [Update User](#UpdateUser)

## Operations

## Create Escalation Policy

`<pagerduty:create-escalation-policy>`

Creates a new escalation policy, which defines the order and timing of notifications to on-call
users or schedules when an incident occurs.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>From</p></td><td><div><div><p>String</p></div></div></td><td><p>Email address of the user performing the operation.</p></td><td></td><td></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:PAYMENT\_REQUIRED

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## Create Incident

`<pagerduty:create-incident>`

Creates an incident synchronously without a corresponding event, typically used in response to user
action.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>From</p></td><td><div><div><p>String</p></div></div></td><td><p>Email address of the user performing the operation.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## Create Schedule

`<pagerduty:create-schedule>`

Creates a new on-call schedule that determines the time periods users are on-call.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>overflow</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If true, allow schedules to overflow to the next day.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## Create Service

`<pagerduty:create-service>`

Creates a new service, which is an external system or business component that you monitor.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:PAYMENT\_REQUIRED

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:UNAUTHORIZED

## Create User

`<pagerduty:create-user>`

Creates a new user in the PagerDuty account.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>From</p></td><td><div><div><p>String</p></div></div></td><td><p>Email address of the user performing the operation.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:PAYMENT\_REQUIRED

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## Delete Escalation Policy

`<pagerduty:delete-escalation-policy>`

Deletes an existing escalation policy and its rules; the policy must not be in use by any services.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the resource.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Null</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:NOT\_FOUND

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## Delete Schedule

`<pagerduty:delete-schedule>`

Deletes an on-call schedule.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the resource.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Null</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:NOT\_FOUND

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## Delete Service

`<pagerduty:delete-service>`

Deletes an existing service.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the resource.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Null</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:UNAUTHORIZED

## Delete User

`<pagerduty:delete-user>`

Deletes a user from the PagerDuty account.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the resource.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Null</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:NOT\_FOUND

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## Get Escalation Policy

`<pagerduty:get-escalation-policy>`

Retrieves information about a specific existing escalation policy and its rules.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the resource.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>include[]</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>services</p></li><li><p>teams</p></li><li><p>targets</p></li></ul></div></div></td><td><p>Additional fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:NOT\_FOUND

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:UNAUTHORIZED

## Get Incident

`<pagerduty:get-incident>`

Retrieves details for a specific incident by ID.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the resource.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>include[]</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>acknowledgers</p></li><li><p>agents</p></li><li><p>assignees</p></li><li><p>conference_bridge</p></li><li><p>custom_fields</p></li><li><p>escalation_policies</p></li><li><p>first_trigger_log_entries</p></li><li><p>priorities</p></li><li><p>services</p></li><li><p>teams</p></li><li><p>users</p></li></ul></div></div></td><td><p>Additional fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:NOT\_FOUND

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## Get Schedule

`<pagerduty:get-schedule>`

Retrieves information about a specific on-call schedule.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the resource.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>time_zone</p></td><td><div><div><p>String</p></div></div></td><td><p>Time zone for the returned data.</p></td><td></td><td></td></tr><tr><td><p>since</p></td><td><div><div><p>DateTime</p></div></div></td><td><p>Start of the time range to include.</p></td><td></td><td></td></tr><tr><td><p>until</p></td><td><div><div><p>DateTime</p></div></div></td><td><p>End of the time range to include.</p></td><td></td><td></td></tr><tr><td><p>overflow</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If true, allow schedules to overflow to the next day.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:NOT\_FOUND

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## Get Service

`<pagerduty:get-service>`

Retrieves information about a specific service.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the resource.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>include[]</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>escalation_policies</p></li><li><p>teams</p></li><li><p>auto_pause_notifications_parameters</p></li><li><p>integrations</p></li></ul></div></div></td><td><p>Additional fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:NOT\_FOUND

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:UNAUTHORIZED

## Get User

`<pagerduty:get-user>`

Retrieves information about a specific user.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the resource.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>include[]</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>contact_methods</p></li><li><p>notification_rules</p></li><li><p>teams</p></li><li><p>subdomains</p></li></ul></div></div></td><td><p>Additional fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:NOT\_FOUND

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## List Escalation Policies

`<pagerduty:list-escalation-policies>`

Retrieves a list of all escalation policies in the account.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of records to return.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Offset to start returning records from.</p></td><td></td><td></td></tr><tr><td><p>total</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If true, include the total record count.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>query</p></td><td><div><div><p>String</p></div></div></td><td><p>Filters results by the supplied query.</p></td><td></td><td></td></tr><tr><td><p>user_ids[]</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>Filters results by user IDs.</p></td><td></td><td></td></tr><tr><td><p>team_ids[]</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>Filters results by team IDs.</p></td><td></td><td></td></tr><tr><td><p>include[]</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>services</p></li><li><p>teams</p></li><li><p>targets</p></li></ul></div></div></td><td><p>Additional fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>sort_by</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>name</p></li><li><p>name:asc</p></li><li><p>name:desc</p></li></ul></div></div></td><td><p>Sort order for results.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## List Incidents

`<pagerduty:list-incidents>`

Retrieves a list of incidents, which can be filtered by various parameters like status, urgency, or
service.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of records to return.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Offset to start returning records from.</p></td><td></td><td></td></tr><tr><td><p>total</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If true, include the total record count.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>date_range</p></td><td><div><div><p>String</p></div></div></td><td><p>Time period to filter incidents.</p></td><td></td><td></td></tr><tr><td><p>incident_key</p></td><td><div><div><p>String</p></div></div></td><td><p>Incident key to filter results.</p></td><td></td><td></td></tr><tr><td><p>service_ids[]</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>Filters results by service IDs.</p></td><td></td><td></td></tr><tr><td><p>team_ids[]</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>Filters results by team IDs.</p></td><td></td><td></td></tr><tr><td><p>user_ids[]</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>Filters results by user IDs.</p></td><td></td><td></td></tr><tr><td><p>urgencies[]</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>high</p></li><li><p>low</p></li></ul></div></div></td><td><p>Urgency levels to filter by.</p></td><td></td><td></td></tr><tr><td><p>time_zone</p></td><td><div><div><p>String</p></div></div></td><td><p>Time zone for the returned data.</p></td><td></td><td></td></tr><tr><td><p>statuses[]</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>triggered</p></li><li><p>acknowledged</p></li><li><p>resolved</p></li></ul></div></div></td><td><p>Incident statuses to filter by.</p></td><td></td><td></td></tr><tr><td><p>sort_by</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>Fields to sort results by.</p></td><td></td><td></td></tr><tr><td><p>include[]</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>acknowledgers</p></li><li><p>agents</p></li><li><p>assignees</p></li><li><p>conference_bridge</p></li><li><p>escalation_policies</p></li><li><p>first_trigger_log_entries</p></li><li><p>priorities</p></li><li><p>services</p></li><li><p>teams</p></li><li><p>users</p></li></ul></div></div></td><td><p>Additional fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>since</p></td><td><div><div><p>String</p></div></div></td><td><p>Start time to filter incidents.</p></td><td></td><td></td></tr><tr><td><p>until</p></td><td><div><div><p>String</p></div></div></td><td><p>End time to filter incidents.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:PAYMENT\_REQUIRED

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## List Schedules

`<pagerduty:list-schedules>`

Retrieves a list of all on-call schedules in the account.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of records to return.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Offset to start returning records from.</p></td><td></td><td></td></tr><tr><td><p>total</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If true, include the total record count.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>query</p></td><td><div><div><p>String</p></div></div></td><td><p>Filters results by the supplied query.</p></td><td></td><td></td></tr><tr><td><p>include[]</p></td><td><div><div><p>String</p></div></div></td><td><p>Additional fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>time_zone</p></td><td><div><div><p>String</p></div></div></td><td><p>Time zone for the returned data.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## List Services

`<pagerduty:list-services>`

Retrieves a list of all services in the account.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>query</p></td><td><div><div><p>String</p></div></div></td><td><p>Filters results by the supplied query.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of records to return.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Offset to start returning records from.</p></td><td></td><td></td></tr><tr><td><p>total</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If true, include the total record count.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>team_ids[]</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>Filters results by team IDs.</p></td><td></td><td></td></tr><tr><td><p>time_zone</p></td><td><div><div><p>String</p></div></div></td><td><p>Time zone for the returned data.</p></td><td></td><td></td></tr><tr><td><p>sort_by</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>name</p></li><li><p>name:asc</p></li><li><p>name:desc</p></li></ul></div></div></td><td><p>Sort order for results.</p></td><td></td><td></td></tr><tr><td><p>include[]</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>escalation_policies</p></li><li><p>teams</p></li><li><p>integrations</p></li><li><p>auto_pause_notifications_parameters</p></li></ul></div></div></td><td><p>Additional fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:UNAUTHORIZED

## List Users

`<pagerduty:list-users>`

Retrieves a list of all users in the account.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>query</p></td><td><div><div><p>String</p></div></div></td><td><p>Filters results by the supplied query.</p></td><td></td><td></td></tr><tr><td><p>team_ids[]</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>Filters results by team IDs.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of records to return.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Offset to start returning records from.</p></td><td></td><td></td></tr><tr><td><p>total</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If true, include the total record count.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>include[]</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>contact_methods</p></li><li><p>notification_rules</p></li><li><p>teams</p></li><li><p>subdomains</p></li></ul></div></div></td><td><p>Additional fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## Update Escalation Policy

`<pagerduty:update-escalation-policy>`

Modifies an existing escalation policy’s settings and rules.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the resource.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:NOT\_FOUND

- PAGERDUTY:PAYMENT\_REQUIRED

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## Update Incident

`<pagerduty:update-incident>`

Modifies an existing incident’s status (acknowledge, resolve, trigger), priority, or assignment.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the resource.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>From</p></td><td><div><div><p>String</p></div></div></td><td><p>Email address of the user performing the operation.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:NOT\_FOUND

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## Update Schedule

`<pagerduty:update-schedule>`

Modifies an existing on-call schedule.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the resource.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>overflow</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If true, allow schedules to overflow to the next day.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:NOT\_FOUND

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## Update Service

`<pagerduty:update-service>`

Modifies an existing service’s settings.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the resource.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:NOT\_FOUND

- PAGERDUTY:PAYMENT\_REQUIRED

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:UNAUTHORIZED

## Update User

`<pagerduty:update-user>`

Modifies an existing user’s information.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Unique identifier of the resource.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable where the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- PAGERDUTY:BAD\_REQUEST

- PAGERDUTY:CLIENT\_ERROR

- PAGERDUTY:CONNECTIVITY

- PAGERDUTY:FORBIDDEN

- PAGERDUTY:NOT\_FOUND

- PAGERDUTY:PAYMENT\_REQUIRED

- PAGERDUTY:SECURITY

- PAGERDUTY:SERVER\_ERROR

- PAGERDUTY:TIMEOUT

- PAGERDUTY:TOO\_MANY\_REQUESTS

- PAGERDUTY:UNAUTHORIZED

## Types

### TLS

Configures TLS to provide secure communications for the Mule app.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Truststore</a></p></div></div></td><td><div><div><p>Configures the TLS truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Keystore</a></p></div></div></td><td><div><div><p>Configures the TLS keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#StandardRevocationCheck">Standard Revocation Check</a></p></li><li><p><a href="#CustomOcspResponder">Custom OCSP Responder</a></p></li><li><p><a href="#CrlFile">CRL File</a></p></li></ul></div></div></td><td><div><div><p>Configures a revocation checking mechanism.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Truststore

Configures the truststore for TLS.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the truststore. Mule resolves the path relative to the current classpath and file system.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the truststore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, Mule stops performing certificate validations. Setting this to <code>true</code> can make connections vulnerable to attacks.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a
public certificate.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the keystore. Mule resolves the path relative to the current classpath and file system.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the keystore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

Configures standard revocation checks for TLS certificates.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Which elements to verify in the certificate chain:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Verify only the last element in the certificate chain.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Verify all elements in the certificate chain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>How to check certificate validity:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Check the Certification Revocation List (CRL) for certificate validity.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Use the Online Certificate Status Protocol (OCSP) to check certificate validity.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use the secondary method to check certificate validity:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Use the method that wasn’t specified in the <strong>Prefer Crls</strong> field (the secondary method) to check certificate validity.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Do not use the secondary method to check certificate validity.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if the revocation server can’t be reached or is busy:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Avoid verification failure.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Allow the verification to fail.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### CRL File

Specifies the location of the certification revocation list (CRL) file.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

Configures a reconnection strategy for an operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many
reconnection attempts the connector source or operation can make.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts the Mule app can make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to
reconnect at a specified frequency for as long as the Mule app runs.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

Configures an expiration policy strategy.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Max Idle Time</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Error Mapping

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Source</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td><div><div><p>Error source type to map.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Target error type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Repeatable In Memory Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error. A value of less than or equal to <code>0</code> means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Objects</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>In Memory Objects</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>