notifications.cfg(5)
| NOTIFICATIONS.CFG(5) | Proxmox Backup | NOTIFICATIONS.CFG(5) |
NAME
notifications.cfg - Notification target/matcher configuration
DESCRIPTION
The file /etc/proxmox-backup/notifications.cfg is a configuration file for Proxmox Backup Server. It contains the configuration for the notification system configuration.
FILE FORMAT
This file contains configuration for notification targets and notification matchers.
OPTIONS
Section type 'gotify': Config for Gotify notification endpoints
Required properties:
- server (<string>)
- Gotify Server URL.
Optional properties:
- comment (<string>)
- Comment.
- disable (<boolean>)
- Disable this target.
- filter (<string>)
- Deprecated.
- origin (user-created|builtin|modified-builtin)
- The origin of a notification configuration entry.
Section type 'matcher': Config for Sendmail notification endpoints
Optional properties:
- comment (<string>)
- Comment.
- disable (<boolean>)
- Disable this matcher.
- invert-match (<boolean>)
- Invert match of the whole filter.
- match-calendar (<string>)
- List of matched severity levels. Can be specified more than once.
- match-field (<string>)
- List of matched metadata fields. Can be specified more than once.
- match-severity (<string>)
- List of matched severity levels. Can be specified more than once.
- mode (all|any (default=all))
- The mode in which the results of matches are combined.
- origin (user-created|builtin|modified-builtin)
- The origin of a notification configuration entry.
- target (<string>)
- Targets to notify. Can be specified more than once.
Section type 'sendmail': Config for Sendmail notification endpoints
Optional properties:
- Author of the mail. Defaults to 'Proxmox Backup Server ($hostname)'
- comment (<string>)
- Comment.
- disable (<boolean>)
- Disable this target.
- filter (<string>)
- Deprecated.
- from-address (<string>)
- From address for sent E-Mails. If the parameter is not set, the plugin will fall back to the email-from setting from node.cfg (PBS). If that is also not set, the plugin will default to <root@$hostname>, where $hostname is the hostname of the node.
- mailto (<string>)
- Mail address to send a mail to. Can be specified more than once.
- mailto-user (<string>)
- Users to send a mail to. The email address of the user will be looked up in users.cfg. Can be specified more than once.
- origin (user-created|builtin|modified-builtin)
- The origin of a notification configuration entry.
Section type 'smtp': Config for Sendmail notification endpoints
Required properties:
- from-address (<string>)
- From address for the mail. SMTP relays might require that this address is owned by the user in order to avoid spoofing. The From header in the email will be set to $author <$from-address>.
- server (<string>)
- Host name or IP of the SMTP relay.
Optional properties:
- Author of the mail. Defaults to 'Proxmox Backup Server ($hostname)'
- comment (<string>)
- Comment.
- disable (<boolean>)
- Disable this target.
- mailto (<string>)
- Mail address to send a mail to. Can be specified more than once.
- mailto-user (<string>)
- Users to send a mail to. The email address of the user will be looked up in users.cfg. Can be specified more than once.
- mode (insecure|starttls|tls (default=tls))
- Connection security
- origin (user-created|builtin|modified-builtin)
- The origin of a notification configuration entry.
- port (<integer> (0 - 65535))
- The port to connect to. If not set, the used port defaults to 25 (insecure), 465 (tls) or 587 (starttls), depending on the value of mode
- username (<string>)
- Username to use during authentication. If no username is set, no authentication will be performed. The PLAIN and LOGIN authentication methods are supported
Section type 'webhook': Config for Webhook notification endpoints
Required properties:
- method (post|put|get (default=post))
- HTTP Method to use.
- url (<string>)
- HTTP(s) url with optional port.
Optional properties:
- body (<string>)
- The HTTP body to send. Supports templating.
- comment (<string>)
- Comment.
- disable (<boolean>)
- Disable this target.
- header ([name=<string> [,value=<string>]])
- Array of HTTP headers. Each entry is a property string with a name and a value. The value property contains the header in base64 encoding. Supports templating. Can be specified more than once.
- origin (user-created|builtin|modified-builtin)
- The origin of a notification configuration entry.
- secret ([name=<string> [,value=<string>]])
- Array of secrets. Each entry is a property string with a name and an optional value. The value property contains the secret in base64 encoding. For any API endpoints returning the endpoint config, only the secret name but not the value will be returned. When updating the config, also send all secrets that you want to keep, setting only the name but not the value. Can be accessed from templates. Can be specified more than once.
COPYRIGHT AND DISCLAIMER
Copyright (C) 2019-2025, Proxmox Server Solutions GmbH
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>
Author
Proxmox Support Team
Copyright
2019-2025, Proxmox Server Solutions GmbH
| Thursday, 21 May 2026 | <devbuild> |