- Elasticsearch Guide: other versions:
- Elasticsearch introduction
- Getting started with Elasticsearch
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- Important Elasticsearch configuration
- Important System Configuration
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Max file size check
- Maximum size virtual memory check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- G1GC check
- All permission check
- Discovery configuration check
- Starting Elasticsearch
- Stopping Elasticsearch
- Adding nodes to your cluster
- Set up X-Pack
- Configuring X-Pack Java Clients
- Bootstrap Checks for X-Pack
- Upgrade Elasticsearch
- API conventions
- Document APIs
- Search APIs
- Aggregations
- Metrics Aggregations
- Avg Aggregation
- Weighted Avg Aggregation
- Cardinality Aggregation
- Extended Stats Aggregation
- Geo Bounds Aggregation
- Geo Centroid Aggregation
- Max Aggregation
- Min Aggregation
- Percentiles Aggregation
- Percentile Ranks Aggregation
- Scripted Metric Aggregation
- Stats Aggregation
- Sum Aggregation
- Top Hits Aggregation
- Value Count Aggregation
- Median Absolute Deviation Aggregation
- Bucket Aggregations
- Adjacency Matrix Aggregation
- Auto-interval Date Histogram Aggregation
- Children Aggregation
- Composite Aggregation
- Date Histogram Aggregation
- Date Range Aggregation
- Diversified Sampler Aggregation
- Filter Aggregation
- Filters Aggregation
- Geo Distance Aggregation
- GeoHash grid Aggregation
- GeoTile Grid Aggregation
- Global Aggregation
- Histogram Aggregation
- IP Range Aggregation
- Missing Aggregation
- Nested Aggregation
- Parent Aggregation
- Range Aggregation
- Reverse nested Aggregation
- Sampler Aggregation
- Significant Terms Aggregation
- Significant Text Aggregation
- Terms Aggregation
- Pipeline Aggregations
- Avg Bucket Aggregation
- Derivative Aggregation
- Max Bucket Aggregation
- Min Bucket Aggregation
- Sum Bucket Aggregation
- Stats Bucket Aggregation
- Extended Stats Bucket Aggregation
- Percentiles Bucket Aggregation
- Moving Average Aggregation
- Moving Function Aggregation
- Cumulative Sum Aggregation
- Bucket Script Aggregation
- Bucket Selector Aggregation
- Bucket Sort Aggregation
- Serial Differencing Aggregation
- Matrix Aggregations
- Caching heavy aggregations
- Returning only aggregation results
- Aggregation Metadata
- Returning the type of the aggregation
- Metrics Aggregations
- Indices APIs
- Create Index
- Delete Index
- Get Index
- Indices Exists
- Open / Close Index API
- Shrink Index
- Split Index
- Rollover Index
- Put Mapping
- Get Mapping
- Get Field Mapping
- Types Exists
- Index Aliases
- Update Indices Settings
- Get Settings
- Analyze
- Index Templates
- Indices Stats
- Indices Segments
- Indices Recovery
- Indices Shard Stores
- Clear Cache
- Flush
- Refresh
- Force Merge
- cat APIs
- Cluster APIs
- Query DSL
- Scripting
- Mapping
- Analysis
- Anatomy of an analyzer
- Testing analyzers
- Analyzers
- Normalizers
- Tokenizers
- Standard Tokenizer
- Letter Tokenizer
- Lowercase Tokenizer
- Whitespace Tokenizer
- UAX URL Email Tokenizer
- Classic Tokenizer
- Thai Tokenizer
- NGram Tokenizer
- Edge NGram Tokenizer
- Keyword Tokenizer
- Pattern Tokenizer
- Char Group Tokenizer
- Simple Pattern Tokenizer
- Simple Pattern Split Tokenizer
- Path Hierarchy Tokenizer
- Path Hierarchy Tokenizer Examples
- Token Filters
- ASCII Folding Token Filter
- Flatten Graph Token Filter
- Length Token Filter
- Lowercase Token Filter
- Uppercase Token Filter
- NGram Token Filter
- Edge NGram Token Filter
- Porter Stem Token Filter
- Shingle Token Filter
- Stop Token Filter
- Word Delimiter Token Filter
- Word Delimiter Graph Token Filter
- Multiplexer Token Filter
- Conditional Token Filter
- Predicate Token Filter Script
- Stemmer Token Filter
- Stemmer Override Token Filter
- Keyword Marker Token Filter
- Keyword Repeat Token Filter
- KStem Token Filter
- Snowball Token Filter
- Phonetic Token Filter
- Synonym Token Filter
- Parsing synonym files
- Synonym Graph Token Filter
- Compound Word Token Filters
- Reverse Token Filter
- Elision Token Filter
- Truncate Token Filter
- Unique Token Filter
- Pattern Capture Token Filter
- Pattern Replace Token Filter
- Trim Token Filter
- Limit Token Count Token Filter
- Hunspell Token Filter
- Common Grams Token Filter
- Normalization Token Filter
- CJK Width Token Filter
- CJK Bigram Token Filter
- Delimited Payload Token Filter
- Keep Words Token Filter
- Keep Types Token Filter
- Exclude mode settings example
- Classic Token Filter
- Apostrophe Token Filter
- Decimal Digit Token Filter
- Fingerprint Token Filter
- MinHash Token Filter
- Remove Duplicates Token Filter
- Character Filters
- Modules
- Index modules
- Ingest node
- Pipeline Definition
- Ingest APIs
- Accessing Data in Pipelines
- Conditional Execution in Pipelines
- Handling Failures in Pipelines
- Processors
- Append Processor
- Bytes Processor
- Convert Processor
- Date Processor
- Date Index Name Processor
- Dissect Processor
- Dot Expander Processor
- Drop Processor
- Fail Processor
- Foreach Processor
- GeoIP Processor
- Grok Processor
- Gsub Processor
- HTML Strip Processor
- Join Processor
- JSON Processor
- KV Processor
- Lowercase Processor
- Pipeline Processor
- Remove Processor
- Rename Processor
- Script Processor
- Set Processor
- Set Security User Processor
- Split Processor
- Sort Processor
- Trim Processor
- Uppercase Processor
- URL Decode Processor
- User Agent processor
- Managing the index lifecycle
- Getting started with index lifecycle management
- Policy phases and actions
- Set up index lifecycle management policy
- Using policies to manage index rollover
- Update policy
- Index lifecycle error handling
- Restoring snapshots of managed indices
- Start and stop index lifecycle management
- Using ILM with existing indices
- SQL access
- Overview
- Getting Started with SQL
- Conventions and Terminology
- Security
- SQL REST API
- SQL Translate API
- SQL CLI
- SQL JDBC
- SQL ODBC
- SQL Client Applications
- SQL Language
- Functions and Operators
- Comparison Operators
- Logical Operators
- Math Operators
- Cast Operators
- LIKE and RLIKE Operators
- Aggregate Functions
- Grouping Functions
- Date/Time and Interval Functions and Operators
- Full-Text Search Functions
- Mathematical Functions
- String Functions
- Type Conversion Functions
- Geo Functions
- Conditional Functions And Expressions
- System Functions
- Reserved keywords
- SQL Limitations
- Monitor a cluster
- Frozen indices
- Set up a cluster for high availability
- Roll up or transform your data
- X-Pack APIs
- Info API
- Cross-cluster replication APIs
- Explore API
- Freeze index
- Index lifecycle management API
- Licensing APIs
- Machine learning APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendar
- Create datafeeds
- Create filter
- Delete calendar
- Delete datafeeds
- Delete events from calendar
- Delete filter
- Delete forecast
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Find file structure
- Flush jobs
- Forecast jobs
- Get calendars
- Get buckets
- Get overall buckets
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get machine learning info
- Get model snapshots
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Revert model snapshots
- Set upgrade mode
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filter
- Update jobs
- Update model snapshots
- Migration APIs
- Rollup APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Create or update users
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete users
- Disable users
- Enable users
- Get API key information
- Get application privileges
- Get role mappings
- Get roles
- Get token
- Get users
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect Prepare Authentication API
- OpenID Connect Authenticate API
- OpenID Connect Logout API
- SSL certificate
- Transform APIs
- Unfreeze index
- Watcher APIs
- Definitions
- Secure a cluster
- Overview
- Configuring security
- Encrypting communications in Elasticsearch
- Encrypting communications in an Elasticsearch Docker Container
- Enabling cipher suites for stronger encryption
- Separating node-to-node and client traffic
- Configuring an Active Directory realm
- Configuring a file realm
- Configuring an LDAP realm
- Configuring a native realm
- Configuring a PKI realm
- Configuring a SAML realm
- Configuring a Kerberos realm
- Security files
- FIPS 140-2
- How security works
- User authentication
- Built-in users
- Internal users
- Token-based authentication services
- Realms
- Realm chains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- Integrating with other authentication systems
- Enabling anonymous access
- Controlling the user cache
- Configuring SAML single-sign-on on the Elastic Stack
- Configuring single sign-on to the Elastic Stack using OpenID Connect
- User authorization
- Auditing security events
- Encrypting communications
- Restricting connections with IP filtering
- Cross cluster search, clients, and integrations
- Tutorial: Getting started with security
- Tutorial: Encrypting communications
- Troubleshooting
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Common Kerberos exceptions
- Common SAML issues
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- Failures due to relocation of the configuration files
- Limitations
- Alerting on cluster and index events
- Command line tools
- How To
- Testing
- Glossary of terms
- Release highlights
- Breaking changes
- Release notes
- Elasticsearch version 7.2.1
- Elasticsearch version 7.2.0
- Elasticsearch version 7.1.1
- Elasticsearch version 7.1.0
- Elasticsearch version 7.0.0
- Elasticsearch version 7.0.0-rc2
- Elasticsearch version 7.0.0-rc1
- Elasticsearch version 7.0.0-beta1
- Elasticsearch version 7.0.0-alpha2
- Elasticsearch version 7.0.0-alpha1
Watcher settings in Elasticsearch
editWatcher settings in Elasticsearch
editYou configure Watcher settings to set up Watcher and send notifications via email, Slack, and PagerDuty.
All of these settings can be added to the elasticsearch.yml
configuration file,
with the exception of the secure settings, which you add to the Elasticsearch keystore.
For more information about creating and updating the Elasticsearch keystore, see
Secure settings. Dynamic settings can also be updated across a cluster with the
cluster update settings API.
General Watcher Settings
edit-
xpack.watcher.enabled
-
Set to
false
to disable Watcher on the node. -
xpack.watcher.encrypt_sensitive_data
-
Set to
true
to encrypt sensitive data. If this setting is enabled, you must also specify thexpack.watcher.encryption_key
setting. For more information, see Encrypting sensitive data in Watcher. -
xpack.watcher.encryption_key
(Secure) -
Specifies the path to a file that contains a key for encrypting sensitive data.
If
xpack.watcher.encrypt_sensitive_data
is set totrue
, this setting is required. For more information, see Encrypting sensitive data in Watcher. -
xpack.watcher.history.cleaner_service.enabled
-
[6.3.0] Added in 6.3.0. Default changed to
true
. [7.0.0] Deprecated in 7.0.0. Watcher history indices are now managed by thewatch-history-ilm-policy
ILM policySet to
true
(default) to enable the cleaner service. If this setting istrue
, thexpack.monitoring.enabled
setting must also be set totrue
with a local exporter enabled. The cleaner service removes previous versions of Watcher indices (for example,.watcher-history*
) when it determines that they are old. The duration of Watcher indices is determined by thexpack.monitoring.history.duration
setting, which defaults to 7 days. For more information about that setting, see Monitoring settings. -
xpack.http.proxy.host
- Specifies the address of the proxy server to use to connect to HTTP services.
-
xpack.http.proxy.port
- Specifies the port number to use to connect to the proxy server.
-
xpack.http.default_connection_timeout
- The maximum period to wait until abortion of the request, when a connection is being initiated.
-
xpack.http.default_read_timeout
- The maximum period of inactivity between two data packets, before the request is aborted.
-
xpack.http.max_response_size
-
Specifies the maximum size an HTTP response is allowed to have, defaults to
10mb
, the maximum configurable value is50mb
. -
xpack.http.whitelist
-
A list of URLs, that the internal HTTP client is allowed to connect to. This
client is used in the HTTP input, the webhook, the slack, pagerduty,
and jira actions. This setting can be updated dynamically. It defaults to
*
allowing everything. Note: If you configure this setting and you are using one of the slack/pagerduty actions, you have to ensure that the corresponding endpoints are whitelisted as well.
Watcher TLS/SSL Settings
editYou can configure the following TLS/SSL settings. If the settings are not configured, the Default TLS/SSL Settings are used.
-
xpack.http.ssl.supported_protocols
-
Supported protocols with versions. Valid protocols:
SSLv2Hello
,SSLv3
,TLSv1
,TLSv1.1
,TLSv1.2
,TLSv1.3
. Defaults toTLSv1.3,TLSv1.2,TLSv1.1
if the JVM supports TLSv1.3, otherwiseTLSv1.2,TLSv1.1
. -
xpack.http.ssl.verification_mode
-
Controls the verification of certificates. Valid values are
none
,certificate
, andfull
. Defaults tofull
. -
xpack.http.ssl.cipher_suites
- Supported cipher suites can be found in Oracle’s Java Cryptography Architecture documentation. Defaults to ``.
Watcher TLS/SSL Key and Trusted Certificate Settings
editThe following settings are used to specify a private key, certificate, and the trusted certificates that should be used when communicating over an SSL/TLS connection. A private key and certificate are optional and would be used if the server requires client authentication for PKI authentication. If none of the settings below are specified, the Default TLS/SSL Settings are used.
PEM Encoded Files
editWhen using PEM encoded files, use the following settings:
-
xpack.http.ssl.key
- Path to a PEM encoded file containing the private key.
-
xpack.http.ssl.key_passphrase
- The passphrase that is used to decrypt the private key. This value is optional as the key might not be encrypted.
-
xpack.http.ssl.secure_key_passphrase
(Secure) - The passphrase that is used to decrypt the private key. This value is optional as the key might not be encrypted.
-
xpack.http.ssl.certificate
- Path to a PEM encoded file containing the certificate (or certificate chain) that will be presented when requested.
-
xpack.http.ssl.certificate_authorities
- List of paths to the PEM encoded certificate files that should be trusted.
Java Keystore Files
editWhen using Java keystore files (JKS), which contain the private key, certificate and certificates that should be trusted, use the following settings:
-
xpack.http.ssl.keystore.path
- Path to the keystore that holds the private key and certificate.
-
xpack.http.ssl.keystore.password
- Password to the keystore.
-
xpack.http.ssl.keystore.secure_password
(Secure) - Password to the keystore.
-
xpack.http.ssl.keystore.key_password
-
Password for the private key in the keystore. Defaults to the
same value as
xpack.http.ssl.keystore.password
. -
xpack.http.ssl.keystore.secure_key_password
(Secure) - Password for the private key in the keystore.
-
xpack.http.ssl.truststore.path
- Path to the truststore file.
-
xpack.http.ssl.truststore.password
- Password to the truststore.
-
xpack.http.ssl.truststore.secure_password
(Secure) - Password to the truststore.
PKCS#12 Files
editElasticsearch can be configured to use PKCS#12 container files (.p12
or .pfx
files)
that contain the private key, certificate and certificates that should be trusted.
PKCS#12 files are configured in the same way as Java Keystore Files:
-
xpack.http.ssl.keystore.path
- Path to the PKCS#12 file that holds the private key and certificate.
-
xpack.http.ssl.keystore.type
-
Set this to
PKCS12
to indicate that the keystore is a PKCS#12 file. -
xpack.http.ssl.keystore.password
- Password to the PKCS#12 file.
-
xpack.http.ssl.keystore.secure_password
(Secure) - Password to the PKCS#12 file.
-
xpack.http.ssl.keystore.key_password
-
Password for the private key stored in the PKCS#12 file.
Defaults to the same value as
xpack.http.ssl.keystore.password
. -
xpack.http.ssl.keystore.secure_key_password
(Secure) - Password for the private key stored in the PKCS#12 file.
-
xpack.http.ssl.truststore.path
- Path to the PKCS#12 file that holds the certificates to be trusted.
-
xpack.http.ssl.truststore.type
-
Set this to
PKCS12
to indicate that the truststore is a PKCS#12 file. -
xpack.http.ssl.truststore.password
- Password to the PKCS#12 file.
-
xpack.http.ssl.truststore.secure_password
(Secure) - Password to the PKCS#12 file.
PKCS#11 Tokens
editElasticsearch can be configured to use a PKCS#11 token that contains the private key, certificate and certificates that should be trusted.
PKCS#11 token require additional configuration on the JVM level and can be enabled via the following settings:
-
xpack.http.keystore.type
-
Set this to
PKCS11
to indicate that the PKCS#11 token should be used as a keystore. -
xpack.http.truststore.type
-
Set this to
PKCS11
to indicate that the PKCS#11 token should be used as a truststore.
When configuring the PKCS#11 token that your JVM is configured to use as
a keystore or a truststore for Elasticsearch, the PIN for the token can be
configured by setting the appropriate value to ssl.truststore.password
or ssl.truststore.secure_password
in the context that you are configuring.
Since there can only be one PKCS#11 token configured, only one keystore and
truststore will be usable for configuration in Elasticsearch. This in turn means
that only one certificate can be used for TLS both in the transport and the
http layer.
Email Notification Settings
editYou can configure the following email notification settings in
elasticsearch.yml
. For more information about sending notifications
via email, see Configuring email actions.
-
xpack.notification.email.account
-
Specifies account information for sending notifications via email. You can specify the following email account attributes:
-
profile
(Dynamic) -
The email profile to use to build the MIME
messages that are sent from the account. Valid values:
standard
,gmail
andoutlook
. Defaults tostandard
. -
email_defaults.*
(Dynamic) - An optional set of email attributes to use as defaults for the emails sent from the account. See Email action attributes for the supported attributes.
-
smtp.auth
(Dynamic) -
Set to
true
to attempt to authenticate the user using the AUTH command. Defaults tofalse
. -
smtp.host
(Dynamic) - The SMTP server to connect to. Required.
-
smtp.port
(Dynamic) - The SMTP server port to connect to. Defaults to 25.
-
smtp.user
(Dynamic) - The user name for SMTP. Required.
-
smtp.secure_password
(Secure) - The password for the specified SMTP user.
-
smtp.starttls.enable
(Dynamic) -
Set to
true
to enable the use of theSTARTTLS
command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. Note that an appropriate trust store must configured so that the client will trust the server’s certificate. Defaults tofalse
. -
smtp.starttls.required
(Dynamic) -
If
true
, thenSTARTTLS
will be required. If that command fails, the connection will fail. Defaults tofalse
. -
smtp.ssl.trust
(Dynamic) - A list of SMTP server hosts that are assumed trusted and for which certificate verification is disabled. If set to "*", all hosts are trusted. If set to a whitespace separated list of hosts, those hosts are trusted. Otherwise, trust depends on the certificate the server presents.
-
smtp.timeout
(Dynamic) - The socket read timeout. Default is two minutes.
-
smtp.connection_timeout
(Dynamic) - The socket connection timeout. Default is two minutes.
-
smtp.write_timeout
(Dynamic) - The socket write timeout. Default is two minutes.
-
smtp.local_address
(Dynamic) - A configurable local address when sending emails. Not configured by default.
-
smtp.local_port
(Dynamic) - A configurable local port when sending emails. Not configured by default.
-
smtp.send_partial
(Dynamic) - Send an email, despite one of the receiver addresses being invalid.
-
smtp.wait_on_quit
(Dynamic) - If set to false the QUIT command is sent and the connection closed. If set to true, the QUIT command is sent and a reply is waited for. True by default.
-
-
xpack.notification.email.html.sanitization.allow
-
Specifies the HTML elements that are allowed in email notifications. For more information, see Configuring HTML sanitization options. You can specify individual HTML elements and the following HTML feature groups:
-
_tables
-
All table related elements:
<table>
,<th>
,<tr>
and<td>
. -
_blocks
-
The following block elements:
<p>
,<div>
,<h1>
,<h2>
,<h3>
,<h4>
,<h5>
,<h6>
,<ul>
,<ol>
,<li>
, and<blockquote>
. -
_formatting
-
The following inline formatting elements:
<b>
,<i>
,<s>
,<u>
,<o>
,<sup>
,<sub>
,<ins>
,<del>
,<strong>
,<strike>
,<tt>
,<code>
,<big>
,<small>
,<br>
,<span>
, and<em>
. -
_links
-
The
<a>
element with anhref
attribute that points to a URL using the following protocols:http
,https
andmailto
. -
_styles
-
The
style
attribute on all elements. Note that CSS attributes are also sanitized to prevent XSS attacks. -
img
-
img:all
- All images (external and embedded).
-
img:embedded
-
Only embedded images. Embedded images can only use the
cid:
URL protocol in theirsrc
attribute.
-
-
xpack.notification.email.html.sanitization.disallow
- Specifies the HTML elements that are NOT allowed in email notifications. You can specify individual HTML elements and HTML feature groups.
-
xpack.notification.email.html.sanitization.enabled
-
Set to
false
to completely disable HTML sanitation. Not recommended. Defaults totrue
.
Slack Notification Settings
editYou can configure the following Slack notification settings in
elasticsearch.yml
. For more information about sending notifications
via Slack, see Configuring Slack actions.
-
xpack.notification.slack
-
Specifies account information for sending notifications via Slack. You can specify the following Slack account attributes:
-
secure_url
(Secure) - The Incoming Webhook URL to use to post messages to Slack. Required.
-
message_defaults.from
- The sender name to display in the Slack message. Defaults to the watch ID.
-
message_defaults.to
- The default Slack channels or groups you want to send messages to.
-
message_defaults.icon
- The icon to display in the Slack messages. Overrides the incoming webhook’s configured icon. Accepts a public URL to an image.
-
message_defaults.text
- The default message content.
-
message_defaults.attachment
- Default message attachments. Slack message attachments enable you to create more richly-formatted messages. Specified as an array as defined in the Slack attachments documentation.
-
Jira Notification Settings
editYou can configure the following Jira notification settings in
elasticsearch.yml
. For more information about using notifications
to create issues in Jira, see Configuring Jira actions.
-
xpack.notification.jira
-
Specifies account information for using notifications to create issues in Jira. You can specify the following Jira account attributes:
-
secure_url
(Secure) - The URL of the Jira Software server. Required.
-
secure_user
(Secure) - The name of the user to connect to the Jira Software server. Required.
-
secure_password
(Secure) - The password of the user to connect to the Jira Software server. Required.
-
issue_defaults
- Default fields values for the issue created in Jira. See Jira action attributes for more information. Optional.
-
PagerDuty Notification Settings
editYou can configure the following PagerDuty notification settings in
elasticsearch.yml
. For more information about sending notifications
via PagerDuty, see Configuring PagerDuty actions.
-
xpack.notification.pagerduty
-
Specifies account information for sending notifications via PagerDuty. You can specify the following PagerDuty account attributes:
-
name
- A name for the PagerDuty account associated with the API key you are using to access PagerDuty. Required.
-
secure_service_api_key
(Secure) - The PagerDuty API key to use to access PagerDuty. Required.
-
event_defaults
-
Default values for PagerDuty event attributes. Optional.
-
description
-
A string that contains the default description for PagerDuty events.
If no default is configured, each PagerDuty action must specify a
description
. -
incident_key
- A string that contains the default incident key to use when sending PagerDuty events.
-
client
- A string that specifies the default monitoring client.
-
client_url
- The URL of the default monitoring client.
-
event_type
-
The default event type. Valid values:
trigger
,resolve
,acknowledge
. -
attach_payload
-
Whether or not to provide the watch payload as context for
the event by default. Valid values:
true
,false
.
-
-
On this page