CLI
ankra alerts
Manage alert destinations and notification routes
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Manage alert destinations and notification routes
ankra alerts destinations channels [flags]
| Flag | Default | Description |
|---|---|---|
-o, --output | Output format: json or yaml (default: human-readable) | |
--provider | Only one provider: slack or teams (default both) |
ankra alerts destinations create [flags]
| Flag | Default | Description |
|---|---|---|
--channel-id | Slack or Teams channel id for a channel-based destination (instead of —url) | |
--channel-name | Display name of the channel behind —channel-id | |
--description | Free-text description | |
--disabled | false | Create the destination disabled |
--name | Destination name, unique within the organisation | |
-o, --output | Output format: json or yaml (default: human-readable) | |
--teams-tenant-id | Microsoft Teams tenant id (required with —channel-id for —type teams) | |
--template-file | File holding a custom payload template | |
--type | Receiver type: slack, teams, discord, pagerduty, or custom (default slack) | |
--url | Webhook URL to deliver to |
ankra alerts destinations delete <destination-id> [flags]
| Flag | Default | Description |
|---|---|---|
-y, --yes | false | Skip the confirmation prompt |
ankra alerts destinations get <destination-id> [flags]
| Flag | Default | Description |
|---|---|---|
-o, --output | Output format: json or yaml (default: human-readable) |
ankra alerts destinations list [flags]
| Flag | Default | Description |
|---|---|---|
--disabled | false | Only disabled destinations |
--enabled | false | Only enabled destinations |
-o, --output | Output format: json or yaml (default: human-readable) | |
--page | 1 | Page number |
--page-size | 20 | Destinations per page (max 100) |
--search | Filter destinations by name |
ankra alerts destinations test <destination-id> [flags]
| Flag | Default | Description |
|---|---|---|
-o, --output | Output format: json or yaml (default: human-readable) |
ankra alerts destinations test-url [flags]
| Flag | Default | Description |
|---|---|---|
-o, --output | Output format: json or yaml (default: human-readable) | |
--template-file | File holding a custom payload template | |
--url | Webhook URL to send the test notification to |
ankra alerts destinations update <destination-id> [flags]
| Flag | Default | Description |
|---|---|---|
--channel-id | New Slack or Teams channel id | |
--channel-name | New display name of the channel | |
--description | New description | |
--disabled | false | Disable the destination |
--enabled | false | Enable the destination |
--name | New destination name | |
-o, --output | Output format: json or yaml (default: human-readable) | |
--teams-tenant-id | New Microsoft Teams tenant id | |
--template-file | File holding the new payload template | |
--url | New webhook URL |
ankra alerts routes create [flags]
| Flag | Default | Description |
|---|---|---|
--cluster-id | Only notifications about this cluster (id) | |
--destination-id | Destination to deliver to (see ‘ankra alerts destinations list’) | |
--disabled | false | Create the route disabled |
--exclude-kinds | Every kind EXCEPT these (comma-separated) | |
--kind | Only notifications of this kind (for example execution_failed) | |
--kinds | Only notifications of these kinds (comma-separated) | |
--mode | include delivers matches, exclude withholds them (default include) | |
-o, --output | Output format: json or yaml (default: human-readable) | |
--priority | 0 | Evaluation order, lowest first (default 100) |
--severity | Only notifications of this severity: critical, warning, or info | |
--source-id | Only notifications from this source id | |
--stop-on-match | false | Stop evaluating lower-priority routes once this one matches |
ankra alerts routes delete <route-id> [flags]
| Flag | Default | Description |
|---|---|---|
-y, --yes | false | Skip the confirmation prompt |
ankra alerts routes list [flags]
| Flag | Default | Description |
|---|---|---|
-o, --output | Output format: json or yaml (default: human-readable) |
ankra alerts routes preview [flags]
| Flag | Default | Description |
|---|---|---|
--alert-id | Resolve as a firing of this alert, including its own destinations | |
--cluster-id | Resolve as a notification about this cluster | |
--kind | Notification kind to resolve (for example alert_trigger_fired) | |
-o, --output | Output format: json or yaml (default: human-readable) | |
--severity | critical | Notification severity: critical, warning, or info |
--source-id | Resolve as a notification from this source id |
ankra alerts routes test <route-id> [flags]
| Flag | Default | Description |
|---|---|---|
-o, --output | Output format: json or yaml (default: human-readable) |
ankra alerts routes update <route-id> [flags]
| Flag | Default | Description |
|---|---|---|
--cluster-id | Only notifications about this cluster (id) | |
--destination-id | Re-point the route at another destination | |
--disabled | false | Disable the route |
--enabled | false | Enable the route |
--exclude-kinds | Every kind EXCEPT these (comma-separated) | |
--kind | Only notifications of this kind (for example execution_failed) | |
--kinds | Only notifications of these kinds (comma-separated) | |
--mode | include delivers matches, exclude withholds them (default include) | |
-o, --output | Output format: json or yaml (default: human-readable) | |
--priority | 0 | Evaluation order, lowest first (default 100) |
--severity | Only notifications of this severity: critical, warning, or info | |
--source-id | Only notifications from this source id | |
--stop-on-match | false | Stop evaluating lower-priority routes once this one matches |