pbs_notification_endpoint_create
Create a Proxmox Backup Server notification endpoint for gotify, sendmail, smtp, or webhook. Returns a plan preview by default; confirm to execute.
Instructions
MUTATION: create a PBS notification endpoint. ep_type = gotify|sendmail|smtp|webhook.
options carries the endpoint-specific config. Additive, RISK_LOW. Dry-run by default
(returns a PLAN — any secret in options is masked to "[redacted]" in the preview);
confirm=True executes (POST .../endpoints/{type}, synchronous — PBS returns null, not a task)
and returns {"status": "ok", "result": None}. To modify an existing endpoint use
pbs_notification_endpoint_update. Needs PROXIMO_PBS_* config.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Unique name for the new notification endpoint (2-32 chars, alnum start). | |
| comment | No | Optional free-text comment stored with the endpoint. | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the creation. | |
| disable | No | If True, create the endpoint disabled. | |
| ep_type | Yes | Notification endpoint type: 'gotify', 'sendmail', 'smtp', or 'webhook'. | |
| options | No | Type-specific config fields, e.g. gotify: {'server':.., 'token':..}; sendmail: {'mailto':[..]}; smtp: {'server':.., 'port':.., 'mailto':[..]}; webhook: {'url':.., 'method':.., 'header':[..], 'secret':[..]}. Credential-shaped keys (token/password/secret/header) are redacted from the PLAN preview and the audit ledger, but ARE sent to PBS on confirm=True. | |
| proximo_target | No | Which configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |