PagerDuty Connector 1.0 Reference | MuleSoft Documentation

Configurations

Config

Default configuration.

Parameters

Name	Type	Description	Required
Name	String	Name for this configuration. Connectors reference the configuration with this name.	x
Connection	Api Key	The connection types to provide to this configuration.	x
Name	String	ID used to reference this configuration.	x
Expiration Policy	Expiration Policy	Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Name

Type

Description

Default Value

Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Api Key

The connection types to provide to this configuration.

x

Name

String

ID used to reference this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

Api Key

Parameters

Name	Type	Description	Required
apiKey	String	API key used to authenticate requests.	x
baseUri	String	Base URI of the PagerDuty API.	x
TLS Configuration	TLS	Configures TLS. If using the HTTPS protocol, you must configure TLS.
Reconnection	Reconnection	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.

Name

Type

Description

Default Value

Required

apiKey

String

API key used to authenticate requests.

x

baseUri

String

Base URI of the PagerDuty API.

x

TLS Configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

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.

Supported Operations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
From	String	Email address of the user performing the operation.
body	Any	Request body.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

From

String

Email address of the user performing the operation.

body

Any

Request body.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
From	String	Email address of the user performing the operation.		x
body	Any	Request body.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

From

String

Email address of the user performing the operation.

x

body

Any

Request body.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
overflow	Boolean	If true, allow schedules to overflow to the next day.	false
body	Any	Request body.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

overflow

Boolean

If true, allow schedules to overflow to the next day.

false

body

Any

Request body.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
body	Any	Request body.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

body

Any

Request body.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
From	String	Email address of the user performing the operation.		x
body	Any	Request body.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

From

String

Email address of the user performing the operation.

x

body

Any

Request body.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
ID	String	Unique identifier of the resource.		x
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

ID

String

Unique identifier of the resource.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Null

Attributes Type

Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
ID	String	Unique identifier of the resource.		x
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

ID

String

Unique identifier of the resource.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Null

Attributes Type

Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
ID	String	Unique identifier of the resource.		x
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

ID

String

Unique identifier of the resource.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Null

Attributes Type

Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
ID	String	Unique identifier of the resource.		x
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

ID

String

Unique identifier of the resource.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Null

Attributes Type

Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
ID	String	Unique identifier of the resource.		x
include[]	Enumeration, one of: services teams targets	Additional fields to include in the response.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

ID

String

Unique identifier of the resource.

x

include[]

Enumeration, one of:

services
teams
targets

Additional fields to include in the response.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
ID	String	Unique identifier of the resource.		x
include[]	Enumeration, one of: acknowledgers agents assignees conference_bridge custom_fields escalation_policies first_trigger_log_entries priorities services teams users	Additional fields to include in the response.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

ID

String

Unique identifier of the resource.

x

include[]

Enumeration, one of:

acknowledgers
agents
assignees
conference_bridge
custom_fields
escalation_policies
first_trigger_log_entries
priorities
services
teams
users

Additional fields to include in the response.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

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

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

ID

String

Unique identifier of the resource.

x

time_zone

String

Time zone for the returned data.

since

DateTime

Start of the time range to include.

until

DateTime

End of the time range to include.

overflow

Boolean

If true, allow schedules to overflow to the next day.

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
ID	String	Unique identifier of the resource.		x
include[]	Enumeration, one of: escalation_policies teams auto_pause_notifications_parameters integrations	Additional fields to include in the response.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

ID

String

Unique identifier of the resource.

x

include[]

Enumeration, one of:

escalation_policies
teams
auto_pause_notifications_parameters
integrations

Additional fields to include in the response.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
ID	String	Unique identifier of the resource.		x
include[]	Enumeration, one of: contact_methods notification_rules teams subdomains	Additional fields to include in the response.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

ID

String

Unique identifier of the resource.

x

include[]

Enumeration, one of:

contact_methods
notification_rules
teams
subdomains

Additional fields to include in the response.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

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

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

limit

Number

Maximum number of records to return.

offset

Number

Offset to start returning records from.

total

Boolean

If true, include the total record count.

false

query

String

Filters results by the supplied query.

user_ids[]

Array of String

Filters results by user IDs.

team_ids[]

Array of String

Filters results by team IDs.

include[]

Enumeration, one of:

services
teams
targets

Additional fields to include in the response.

sort_by

Enumeration, one of:

name
name:asc
name:desc

Sort order for results.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type	Array of Any

For Configurations

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

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

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

limit

Number

Maximum number of records to return.

offset

Number

Offset to start returning records from.

total

Boolean

If true, include the total record count.

false

date_range

String

Time period to filter incidents.

incident_key

String

Incident key to filter results.

service_ids[]

Array of String

Filters results by service IDs.

team_ids[]

Array of String

Filters results by team IDs.

user_ids[]

Array of String

Filters results by user IDs.

urgencies[]

Enumeration, one of:

high
low

Urgency levels to filter by.

time_zone

String

Time zone for the returned data.

statuses[]

Enumeration, one of:

triggered
acknowledged
resolved

Incident statuses to filter by.

sort_by

Array of String

Fields to sort results by.

include[]

Enumeration, one of:

acknowledgers
agents
assignees
conference_bridge
escalation_policies
first_trigger_log_entries
priorities
services
teams
users

Additional fields to include in the response.

since

String

Start time to filter incidents.

until

String

End time to filter incidents.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type	Array of Any

For Configurations

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

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

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

limit

Number

Maximum number of records to return.

offset

Number

Offset to start returning records from.

total

Boolean

If true, include the total record count.

false

query

String

Filters results by the supplied query.

include[]

String

Additional fields to include in the response.

time_zone

String

Time zone for the returned data.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type	Array of Any

For Configurations

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

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

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

query

String

Filters results by the supplied query.

limit

Number

Maximum number of records to return.

offset

Number

Offset to start returning records from.

total

Boolean

If true, include the total record count.

false

team_ids[]

Array of String

Filters results by team IDs.

time_zone

String

Time zone for the returned data.

sort_by

Enumeration, one of:

name
name:asc
name:desc

Sort order for results.

include[]

Enumeration, one of:

escalation_policies
teams
integrations
auto_pause_notifications_parameters

Additional fields to include in the response.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type	Array of Any

For Configurations

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

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

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

query

String

Filters results by the supplied query.

team_ids[]

Array of String

Filters results by team IDs.

limit

Number

Maximum number of records to return.

offset

Number

Offset to start returning records from.

total

Boolean

If true, include the total record count.

false

include[]

Enumeration, one of:

contact_methods
notification_rules
teams
subdomains

Additional fields to include in the response.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type	Array of Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
ID	String	Unique identifier of the resource.		x
body	Any	Request body.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

ID

String

Unique identifier of the resource.

x

body

Any

Request body.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
ID	String	Unique identifier of the resource.		x
From	String	Email address of the user performing the operation.		x
body	Any	Request body.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

ID

String

Unique identifier of the resource.

x

From

String

Email address of the user performing the operation.

x

body

Any

Request body.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
ID	String	Unique identifier of the resource.		x
overflow	Boolean	If true, allow schedules to overflow to the next day.	false
body	Any	Request body.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

ID

String

Unique identifier of the resource.

x

overflow

Boolean

If true, allow schedules to overflow to the next day.

false

body

Any

Request body.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
ID	String	Unique identifier of the resource.		x
body	Any	Request body.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

ID

String

Unique identifier of the resource.

x

body

Any

Request body.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
ID	String	Unique identifier of the resource.		x
body	Any	Request body.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable where the operation’s output will be placed.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

Name

Type

Description

Default Value

Required

Configuration

String

Name of the configuration to use.

x

ID

String

Unique identifier of the resource.

x

body

Any

Request body.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable where the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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.

Field

Type

Description

Default Value

Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Truststore

Configures the TLS truststore.

Key Store

Keystore

Configures the TLS keystore.

Revocation Check

Standard Revocation Check
Custom OCSP Responder
CRL File

Configures a revocation checking mechanism.

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of store.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

Keystore

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

Field

Type

Description

Default Value

Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of store.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

true

Verify only the last element in the certificate chain.

false

Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

true

Check the Certification Revocation List (CRL) for certificate validity.

false

Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

true

Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

false

Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

true

Avoid verification failure.

false

Allow the verification to fail.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field

Type

Description

Default Value

Required

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

CRL File

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

Field

Type

Description

Default Value

Required

Path

String

Path to the CRL file.

Reconnection

Configures a reconnection strategy for an operation.

Field

Type

Description

Default Value

Required

Fails Deployment

Boolean

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.

Reconnection Strategy

Reconnect
Reconnect Forever

Reconnection strategy to use.

Reconnect

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

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

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.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Expiration Policy

Configures an expiration policy strategy.

Field

Type

Description

Default Value

Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit for the Max Idle Time field.

Error Mapping

Field

Type

Description

Default Value

Required

Source

Enumeration, one of:

ANY
REDELIVERY_EXHAUSTED
TRANSFORMATION
EXPRESSION
SECURITY
CLIENT_SECURITY
SERVER_SECURITY
ROUTING
CONNECTIVITY
RETRY_EXHAUSTED
TIMEOUT

Error source type to map.

Target

String

Target error type.

x

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

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.

Buffer Size Increment

Number

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.

Max Buffer Size

Number

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Repeatable File Store Iterable

Field

Type

Description

Default Value

Required

In Memory Objects

Number

The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

BYTE
KB
MB
GB

Unit for the In Memory Objects field.