Notifications
Notification channels — Slack, Discord, Telegram, email and others — plus test deliveries. Generated from the `notploy` command surface.
Notification channels — Slack, Discord, Telegram, email and others — plus test deliveries.
notploy notification exposes 41 commands. They map one-to-one onto the notification.* API operations, so anything reachable from the dashboard is reachable from here.
Run notploy notification --help to list these commands in your terminal, or
notploy notification <command> --help for a single command.
Commands
notploy notification all
Calls GET /api/trpc/notification.all.
notploy notification all [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy notification create-custom
Calls POST /api/trpc/notification.createCustom.
notploy notification create-custom --name <value> --endpoint <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | No | — |
--no-appBuildError | boolean | No | — |
--databaseBackup [boolean] | boolean | No | — |
--no-databaseBackup | boolean | No | — |
--notployBackup [boolean] | boolean | No | — |
--no-notployBackup | boolean | No | — |
--volumeBackup [boolean] | boolean | No | — |
--no-volumeBackup | boolean | No | — |
--notployRestart [boolean] | boolean | No | — |
--no-notployRestart | boolean | No | — |
--name <value> | string | Yes | — |
--appDeploy [boolean] | boolean | No | — |
--no-appDeploy | boolean | No | — |
--dockerCleanup [boolean] | boolean | No | — |
--no-dockerCleanup | boolean | No | — |
--serverThreshold [boolean] | boolean | No | — |
--no-serverThreshold | boolean | No | — |
--endpoint <value> | string | Yes | — |
--headers <json> | object | No | — |
--profile <name> | string | No | — |
notploy notification create-discord
Calls POST /api/trpc/notification.createDiscord.
notploy notification create-discord --appBuildError --databaseBackup --notployBackup --volumeBackup --notployRestart --name <value> --appDeploy --dockerCleanup --serverThreshold --webhookUrl <value> --decoration [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | Yes | — |
--databaseBackup [boolean] | boolean | Yes | — |
--notployBackup [boolean] | boolean | Yes | — |
--volumeBackup [boolean] | boolean | Yes | — |
--notployRestart [boolean] | boolean | Yes | — |
--name <value> | string | Yes | — |
--appDeploy [boolean] | boolean | Yes | — |
--dockerCleanup [boolean] | boolean | Yes | — |
--serverThreshold [boolean] | boolean | Yes | — |
--webhookUrl <value> | string | Yes | — |
--decoration [boolean] | boolean | Yes | — |
--profile <name> | string | No | — |
notploy notification create-email
Calls POST /api/trpc/notification.createEmail.
notploy notification create-email --appBuildError --databaseBackup --notployBackup --volumeBackup --notployRestart --name <value> --appDeploy --dockerCleanup --serverThreshold --smtpServer <value> --smtpPort <value> --username <value> --password <value> --fromAddress <value> --toAddresses <json> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | Yes | — |
--databaseBackup [boolean] | boolean | Yes | — |
--notployBackup [boolean] | boolean | Yes | — |
--volumeBackup [boolean] | boolean | Yes | — |
--notployRestart [boolean] | boolean | Yes | — |
--name <value> | string | Yes | — |
--appDeploy [boolean] | boolean | Yes | — |
--dockerCleanup [boolean] | boolean | Yes | — |
--serverThreshold [boolean] | boolean | Yes | — |
--smtpServer <value> | string | Yes | — |
--smtpPort <value> | number | Yes | — |
--username <value> | string | Yes | — |
--password <value> | string | Yes | — |
--fromAddress <value> | string | Yes | — |
--toAddresses <json> | array | Yes | — |
--profile <name> | string | No | — |
notploy notification create-gotify
Calls POST /api/trpc/notification.createGotify.
notploy notification create-gotify --appBuildError --databaseBackup --notployBackup --volumeBackup --notployRestart --name <value> --appDeploy --dockerCleanup --serverThreshold --serverUrl <value> --appToken <value> --priority <value> --decoration [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | Yes | — |
--databaseBackup [boolean] | boolean | Yes | — |
--notployBackup [boolean] | boolean | Yes | — |
--volumeBackup [boolean] | boolean | Yes | — |
--notployRestart [boolean] | boolean | Yes | — |
--name <value> | string | Yes | — |
--appDeploy [boolean] | boolean | Yes | — |
--dockerCleanup [boolean] | boolean | Yes | — |
--serverThreshold [boolean] | boolean | Yes | — |
--serverUrl <value> | string | Yes | — |
--appToken <value> | string | Yes | — |
--priority <value> | number | Yes | — |
--decoration [boolean] | boolean | Yes | — |
--profile <name> | string | No | — |
notploy notification create-lark
Calls POST /api/trpc/notification.createLark.
notploy notification create-lark --appBuildError --databaseBackup --notployBackup --volumeBackup --notployRestart --name <value> --appDeploy --dockerCleanup --serverThreshold --webhookUrl <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | Yes | — |
--databaseBackup [boolean] | boolean | Yes | — |
--notployBackup [boolean] | boolean | Yes | — |
--volumeBackup [boolean] | boolean | Yes | — |
--notployRestart [boolean] | boolean | Yes | — |
--name <value> | string | Yes | — |
--appDeploy [boolean] | boolean | Yes | — |
--dockerCleanup [boolean] | boolean | Yes | — |
--serverThreshold [boolean] | boolean | Yes | — |
--webhookUrl <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy notification create-mattermost
Calls POST /api/trpc/notification.createMattermost.
notploy notification create-mattermost --appBuildError --databaseBackup --notployBackup --volumeBackup --notployRestart --name <value> --appDeploy --dockerCleanup --serverThreshold --webhookUrl <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | Yes | — |
--databaseBackup [boolean] | boolean | Yes | — |
--notployBackup [boolean] | boolean | Yes | — |
--volumeBackup [boolean] | boolean | Yes | — |
--notployRestart [boolean] | boolean | Yes | — |
--name <value> | string | Yes | — |
--appDeploy [boolean] | boolean | Yes | — |
--dockerCleanup [boolean] | boolean | Yes | — |
--serverThreshold [boolean] | boolean | Yes | — |
--webhookUrl <value> | string | Yes | — |
--channel <value> | string | No | — |
--username <value> | string | No | — |
--profile <name> | string | No | — |
notploy notification create-ntfy
Calls POST /api/trpc/notification.createNtfy.
notploy notification create-ntfy --appBuildError --databaseBackup --notployBackup --volumeBackup --notployRestart --name <value> --appDeploy --dockerCleanup --serverThreshold --serverUrl <value> --topic <value> --accessToken <value> --priority <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | Yes | — |
--databaseBackup [boolean] | boolean | Yes | — |
--notployBackup [boolean] | boolean | Yes | — |
--volumeBackup [boolean] | boolean | Yes | — |
--notployRestart [boolean] | boolean | Yes | — |
--name <value> | string | Yes | — |
--appDeploy [boolean] | boolean | Yes | — |
--dockerCleanup [boolean] | boolean | Yes | — |
--serverThreshold [boolean] | boolean | Yes | — |
--serverUrl <value> | string | Yes | — |
--topic <value> | string | Yes | — |
--accessToken <value> | string | Yes | — |
--priority <value> | number | Yes | — |
--profile <name> | string | No | — |
notploy notification create-pushover
Calls POST /api/trpc/notification.createPushover.
notploy notification create-pushover --name <value> --userKey <value> --apiToken <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | No | — |
--no-appBuildError | boolean | No | — |
--databaseBackup [boolean] | boolean | No | — |
--no-databaseBackup | boolean | No | — |
--notployBackup [boolean] | boolean | No | — |
--no-notployBackup | boolean | No | — |
--volumeBackup [boolean] | boolean | No | — |
--no-volumeBackup | boolean | No | — |
--notployRestart [boolean] | boolean | No | — |
--no-notployRestart | boolean | No | — |
--name <value> | string | Yes | — |
--appDeploy [boolean] | boolean | No | — |
--no-appDeploy | boolean | No | — |
--dockerCleanup [boolean] | boolean | No | — |
--no-dockerCleanup | boolean | No | — |
--serverThreshold [boolean] | boolean | No | — |
--no-serverThreshold | boolean | No | — |
--userKey <value> | string | Yes | — |
--apiToken <value> | string | Yes | — |
--priority <value> | number | No | — |
--retry <value> | number | No | — |
--expire <value> | number | No | — |
--profile <name> | string | No | — |
notploy notification create-resend
Calls POST /api/trpc/notification.createResend.
notploy notification create-resend --appBuildError --databaseBackup --notployBackup --volumeBackup --notployRestart --name <value> --appDeploy --dockerCleanup --serverThreshold --apiKey <value> --fromAddress <value> --toAddresses <json> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | Yes | — |
--databaseBackup [boolean] | boolean | Yes | — |
--notployBackup [boolean] | boolean | Yes | — |
--volumeBackup [boolean] | boolean | Yes | — |
--notployRestart [boolean] | boolean | Yes | — |
--name <value> | string | Yes | — |
--appDeploy [boolean] | boolean | Yes | — |
--dockerCleanup [boolean] | boolean | Yes | — |
--serverThreshold [boolean] | boolean | Yes | — |
--apiKey <value> | string | Yes | — |
--fromAddress <value> | string | Yes | — |
--toAddresses <json> | array | Yes | — |
--profile <name> | string | No | — |
notploy notification create-slack
Calls POST /api/trpc/notification.createSlack.
notploy notification create-slack --appBuildError --databaseBackup --notployBackup --volumeBackup --notployRestart --name <value> --appDeploy --dockerCleanup --serverThreshold --webhookUrl <value> --channel <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | Yes | — |
--databaseBackup [boolean] | boolean | Yes | — |
--notployBackup [boolean] | boolean | Yes | — |
--volumeBackup [boolean] | boolean | Yes | — |
--notployRestart [boolean] | boolean | Yes | — |
--name <value> | string | Yes | — |
--appDeploy [boolean] | boolean | Yes | — |
--dockerCleanup [boolean] | boolean | Yes | — |
--serverThreshold [boolean] | boolean | Yes | — |
--webhookUrl <value> | string | Yes | — |
--channel <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy notification create-teams
Calls POST /api/trpc/notification.createTeams.
notploy notification create-teams --appBuildError --databaseBackup --notployBackup --volumeBackup --notployRestart --name <value> --appDeploy --dockerCleanup --serverThreshold --webhookUrl <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | Yes | — |
--databaseBackup [boolean] | boolean | Yes | — |
--notployBackup [boolean] | boolean | Yes | — |
--volumeBackup [boolean] | boolean | Yes | — |
--notployRestart [boolean] | boolean | Yes | — |
--name <value> | string | Yes | — |
--appDeploy [boolean] | boolean | Yes | — |
--dockerCleanup [boolean] | boolean | Yes | — |
--serverThreshold [boolean] | boolean | Yes | — |
--webhookUrl <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy notification create-telegram
Calls POST /api/trpc/notification.createTelegram.
notploy notification create-telegram --appBuildError --databaseBackup --notployBackup --volumeBackup --notployRestart --name <value> --appDeploy --dockerCleanup --serverThreshold --botToken <value> --chatId <value> --messageThreadId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | Yes | — |
--databaseBackup [boolean] | boolean | Yes | — |
--notployBackup [boolean] | boolean | Yes | — |
--volumeBackup [boolean] | boolean | Yes | — |
--notployRestart [boolean] | boolean | Yes | — |
--name <value> | string | Yes | — |
--appDeploy [boolean] | boolean | Yes | — |
--dockerCleanup [boolean] | boolean | Yes | — |
--serverThreshold [boolean] | boolean | Yes | — |
--botToken <value> | string | Yes | — |
--chatId <value> | string | Yes | — |
--messageThreadId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy notification get-email-providers
Calls GET /api/trpc/notification.getEmailProviders.
notploy notification get-email-providers [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy notification one
Calls GET /api/trpc/notification.one.
notploy notification one --notificationId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--notificationId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy notification receive-notification
Calls POST /api/trpc/notification.receiveNotification.
notploy notification receive-notification --Type <value> --Value <value> --Threshold <value> --Message <value> --Timestamp <value> --Token <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--ServerType <value> | string | No | Notploy, Remote |
--Type <value> | string | Yes | Memory, CPU |
--Value <value> | number | Yes | — |
--Threshold <value> | number | Yes | — |
--Message <value> | string | Yes | — |
--Timestamp <value> | string | Yes | — |
--Token <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy notification remove
Calls POST /api/trpc/notification.remove.
notploy notification remove --notificationId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--notificationId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy notification test-custom-connection
Calls POST /api/trpc/notification.testCustomConnection.
notploy notification test-custom-connection --endpoint <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--endpoint <value> | string | Yes | — |
--headers <json> | object | No | — |
--profile <name> | string | No | — |
notploy notification test-discord-connection
Calls POST /api/trpc/notification.testDiscordConnection.
notploy notification test-discord-connection --webhookUrl <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--webhookUrl <value> | string | Yes | — |
--decoration [boolean] | boolean | No | — |
--no-decoration | boolean | No | — |
--profile <name> | string | No | — |
notploy notification test-email-connection
Calls POST /api/trpc/notification.testEmailConnection.
notploy notification test-email-connection --smtpServer <value> --smtpPort <value> --username <value> --password <value> --toAddresses <json> --fromAddress <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--smtpServer <value> | string | Yes | — |
--smtpPort <value> | number | Yes | — |
--username <value> | string | Yes | — |
--password <value> | string | Yes | — |
--toAddresses <json> | array | Yes | — |
--fromAddress <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy notification test-gotify-connection
Calls POST /api/trpc/notification.testGotifyConnection.
notploy notification test-gotify-connection --serverUrl <value> --appToken <value> --priority <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverUrl <value> | string | Yes | — |
--appToken <value> | string | Yes | — |
--priority <value> | number | Yes | — |
--decoration [boolean] | boolean | No | — |
--no-decoration | boolean | No | — |
--profile <name> | string | No | — |
notploy notification test-lark-connection
Calls POST /api/trpc/notification.testLarkConnection.
notploy notification test-lark-connection --webhookUrl <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--webhookUrl <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy notification test-mattermost-connection
Calls POST /api/trpc/notification.testMattermostConnection.
notploy notification test-mattermost-connection --webhookUrl <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--webhookUrl <value> | string | Yes | — |
--channel <value> | string | No | — |
--username <value> | string | No | — |
--profile <name> | string | No | — |
notploy notification test-ntfy-connection
Calls POST /api/trpc/notification.testNtfyConnection.
notploy notification test-ntfy-connection --serverUrl <value> --topic <value> --accessToken <value> --priority <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverUrl <value> | string | Yes | — |
--topic <value> | string | Yes | — |
--accessToken <value> | string | Yes | — |
--priority <value> | number | Yes | — |
--profile <name> | string | No | — |
notploy notification test-pushover-connection
Calls POST /api/trpc/notification.testPushoverConnection.
notploy notification test-pushover-connection --userKey <value> --apiToken <value> --priority <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--userKey <value> | string | Yes | — |
--apiToken <value> | string | Yes | — |
--priority <value> | number | Yes | — |
--retry <value> | number | No | — |
--expire <value> | number | No | — |
--profile <name> | string | No | — |
notploy notification test-resend-connection
Calls POST /api/trpc/notification.testResendConnection.
notploy notification test-resend-connection --apiKey <value> --fromAddress <value> --toAddresses <json> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--apiKey <value> | string | Yes | — |
--fromAddress <value> | string | Yes | — |
--toAddresses <json> | array | Yes | — |
--profile <name> | string | No | — |
notploy notification test-slack-connection
Calls POST /api/trpc/notification.testSlackConnection.
notploy notification test-slack-connection --webhookUrl <value> --channel <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--webhookUrl <value> | string | Yes | — |
--channel <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy notification test-teams-connection
Calls POST /api/trpc/notification.testTeamsConnection.
notploy notification test-teams-connection --webhookUrl <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--webhookUrl <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy notification test-telegram-connection
Calls POST /api/trpc/notification.testTelegramConnection.
notploy notification test-telegram-connection --botToken <value> --chatId <value> --messageThreadId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--botToken <value> | string | Yes | — |
--chatId <value> | string | Yes | — |
--messageThreadId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy notification update-custom
Calls POST /api/trpc/notification.updateCustom.
notploy notification update-custom --notificationId <value> --customId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | No | — |
--no-appBuildError | boolean | No | — |
--databaseBackup [boolean] | boolean | No | — |
--no-databaseBackup | boolean | No | — |
--notployBackup [boolean] | boolean | No | — |
--no-notployBackup | boolean | No | — |
--volumeBackup [boolean] | boolean | No | — |
--no-volumeBackup | boolean | No | — |
--notployRestart [boolean] | boolean | No | — |
--no-notployRestart | boolean | No | — |
--name <value> | string | No | — |
--appDeploy [boolean] | boolean | No | — |
--no-appDeploy | boolean | No | — |
--dockerCleanup [boolean] | boolean | No | — |
--no-dockerCleanup | boolean | No | — |
--serverThreshold [boolean] | boolean | No | — |
--no-serverThreshold | boolean | No | — |
--endpoint <value> | string | No | — |
--headers <json> | object | No | — |
--notificationId <value> | string | Yes | — |
--customId <value> | string | Yes | — |
--organizationId <value> | string | No | — |
--profile <name> | string | No | — |
notploy notification update-discord
Calls POST /api/trpc/notification.updateDiscord.
notploy notification update-discord --notificationId <value> --discordId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | No | — |
--no-appBuildError | boolean | No | — |
--databaseBackup [boolean] | boolean | No | — |
--no-databaseBackup | boolean | No | — |
--notployBackup [boolean] | boolean | No | — |
--no-notployBackup | boolean | No | — |
--volumeBackup [boolean] | boolean | No | — |
--no-volumeBackup | boolean | No | — |
--notployRestart [boolean] | boolean | No | — |
--no-notployRestart | boolean | No | — |
--name <value> | string | No | — |
--appDeploy [boolean] | boolean | No | — |
--no-appDeploy | boolean | No | — |
--dockerCleanup [boolean] | boolean | No | — |
--no-dockerCleanup | boolean | No | — |
--serverThreshold [boolean] | boolean | No | — |
--no-serverThreshold | boolean | No | — |
--webhookUrl <value> | string | No | — |
--decoration [boolean] | boolean | No | — |
--no-decoration | boolean | No | — |
--notificationId <value> | string | Yes | — |
--discordId <value> | string | Yes | — |
--organizationId <value> | string | No | — |
--profile <name> | string | No | — |
notploy notification update-email
Calls POST /api/trpc/notification.updateEmail.
notploy notification update-email --notificationId <value> --emailId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | No | — |
--no-appBuildError | boolean | No | — |
--databaseBackup [boolean] | boolean | No | — |
--no-databaseBackup | boolean | No | — |
--notployBackup [boolean] | boolean | No | — |
--no-notployBackup | boolean | No | — |
--volumeBackup [boolean] | boolean | No | — |
--no-volumeBackup | boolean | No | — |
--notployRestart [boolean] | boolean | No | — |
--no-notployRestart | boolean | No | — |
--name <value> | string | No | — |
--appDeploy [boolean] | boolean | No | — |
--no-appDeploy | boolean | No | — |
--dockerCleanup [boolean] | boolean | No | — |
--no-dockerCleanup | boolean | No | — |
--serverThreshold [boolean] | boolean | No | — |
--no-serverThreshold | boolean | No | — |
--smtpServer <value> | string | No | — |
--smtpPort <value> | number | No | — |
--username <value> | string | No | — |
--password <value> | string | No | — |
--fromAddress <value> | string | No | — |
--toAddresses <json> | array | No | — |
--notificationId <value> | string | Yes | — |
--emailId <value> | string | Yes | — |
--organizationId <value> | string | No | — |
--profile <name> | string | No | — |
notploy notification update-gotify
Calls POST /api/trpc/notification.updateGotify.
notploy notification update-gotify --notificationId <value> --gotifyId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | No | — |
--no-appBuildError | boolean | No | — |
--databaseBackup [boolean] | boolean | No | — |
--no-databaseBackup | boolean | No | — |
--notployBackup [boolean] | boolean | No | — |
--no-notployBackup | boolean | No | — |
--volumeBackup [boolean] | boolean | No | — |
--no-volumeBackup | boolean | No | — |
--notployRestart [boolean] | boolean | No | — |
--no-notployRestart | boolean | No | — |
--name <value> | string | No | — |
--appDeploy [boolean] | boolean | No | — |
--no-appDeploy | boolean | No | — |
--dockerCleanup [boolean] | boolean | No | — |
--no-dockerCleanup | boolean | No | — |
--serverThreshold [boolean] | boolean | No | — |
--no-serverThreshold | boolean | No | — |
--serverUrl <value> | string | No | — |
--appToken <value> | string | No | — |
--priority <value> | number | No | — |
--decoration [boolean] | boolean | No | — |
--no-decoration | boolean | No | — |
--notificationId <value> | string | Yes | — |
--gotifyId <value> | string | Yes | — |
--organizationId <value> | string | No | — |
--profile <name> | string | No | — |
notploy notification update-lark
Calls POST /api/trpc/notification.updateLark.
notploy notification update-lark --notificationId <value> --larkId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | No | — |
--no-appBuildError | boolean | No | — |
--databaseBackup [boolean] | boolean | No | — |
--no-databaseBackup | boolean | No | — |
--notployBackup [boolean] | boolean | No | — |
--no-notployBackup | boolean | No | — |
--volumeBackup [boolean] | boolean | No | — |
--no-volumeBackup | boolean | No | — |
--notployRestart [boolean] | boolean | No | — |
--no-notployRestart | boolean | No | — |
--name <value> | string | No | — |
--appDeploy [boolean] | boolean | No | — |
--no-appDeploy | boolean | No | — |
--dockerCleanup [boolean] | boolean | No | — |
--no-dockerCleanup | boolean | No | — |
--serverThreshold [boolean] | boolean | No | — |
--no-serverThreshold | boolean | No | — |
--webhookUrl <value> | string | No | — |
--notificationId <value> | string | Yes | — |
--larkId <value> | string | Yes | — |
--organizationId <value> | string | No | — |
--profile <name> | string | No | — |
notploy notification update-mattermost
Calls POST /api/trpc/notification.updateMattermost.
notploy notification update-mattermost --notificationId <value> --mattermostId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | No | — |
--no-appBuildError | boolean | No | — |
--databaseBackup [boolean] | boolean | No | — |
--no-databaseBackup | boolean | No | — |
--notployBackup [boolean] | boolean | No | — |
--no-notployBackup | boolean | No | — |
--volumeBackup [boolean] | boolean | No | — |
--no-volumeBackup | boolean | No | — |
--notployRestart [boolean] | boolean | No | — |
--no-notployRestart | boolean | No | — |
--name <value> | string | No | — |
--appDeploy [boolean] | boolean | No | — |
--no-appDeploy | boolean | No | — |
--dockerCleanup [boolean] | boolean | No | — |
--no-dockerCleanup | boolean | No | — |
--serverThreshold [boolean] | boolean | No | — |
--no-serverThreshold | boolean | No | — |
--webhookUrl <value> | string | No | — |
--channel <value> | string | No | — |
--username <value> | string | No | — |
--notificationId <value> | string | Yes | — |
--mattermostId <value> | string | Yes | — |
--organizationId <value> | string | No | — |
--profile <name> | string | No | — |
notploy notification update-ntfy
Calls POST /api/trpc/notification.updateNtfy.
notploy notification update-ntfy --notificationId <value> --ntfyId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | No | — |
--no-appBuildError | boolean | No | — |
--databaseBackup [boolean] | boolean | No | — |
--no-databaseBackup | boolean | No | — |
--notployBackup [boolean] | boolean | No | — |
--no-notployBackup | boolean | No | — |
--volumeBackup [boolean] | boolean | No | — |
--no-volumeBackup | boolean | No | — |
--notployRestart [boolean] | boolean | No | — |
--no-notployRestart | boolean | No | — |
--name <value> | string | No | — |
--appDeploy [boolean] | boolean | No | — |
--no-appDeploy | boolean | No | — |
--dockerCleanup [boolean] | boolean | No | — |
--no-dockerCleanup | boolean | No | — |
--serverThreshold [boolean] | boolean | No | — |
--no-serverThreshold | boolean | No | — |
--serverUrl <value> | string | No | — |
--topic <value> | string | No | — |
--accessToken <value> | string | No | — |
--priority <value> | number | No | — |
--notificationId <value> | string | Yes | — |
--ntfyId <value> | string | Yes | — |
--organizationId <value> | string | No | — |
--profile <name> | string | No | — |
notploy notification update-pushover
Calls POST /api/trpc/notification.updatePushover.
notploy notification update-pushover --notificationId <value> --pushoverId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--notificationId <value> | string | Yes | — |
--pushoverId <value> | string | Yes | — |
--organizationId <value> | string | No | — |
--userKey <value> | string | No | — |
--apiToken <value> | string | No | — |
--priority <value> | number | No | — |
--retry <value> | number | No | — |
--expire <value> | number | No | — |
--appBuildError [boolean] | boolean | No | — |
--no-appBuildError | boolean | No | — |
--databaseBackup [boolean] | boolean | No | — |
--no-databaseBackup | boolean | No | — |
--notployBackup [boolean] | boolean | No | — |
--no-notployBackup | boolean | No | — |
--volumeBackup [boolean] | boolean | No | — |
--no-volumeBackup | boolean | No | — |
--notployRestart [boolean] | boolean | No | — |
--no-notployRestart | boolean | No | — |
--name <value> | string | No | — |
--appDeploy [boolean] | boolean | No | — |
--no-appDeploy | boolean | No | — |
--dockerCleanup [boolean] | boolean | No | — |
--no-dockerCleanup | boolean | No | — |
--serverThreshold [boolean] | boolean | No | — |
--no-serverThreshold | boolean | No | — |
--profile <name> | string | No | — |
notploy notification update-resend
Calls POST /api/trpc/notification.updateResend.
notploy notification update-resend --notificationId <value> --resendId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | No | — |
--no-appBuildError | boolean | No | — |
--databaseBackup [boolean] | boolean | No | — |
--no-databaseBackup | boolean | No | — |
--notployBackup [boolean] | boolean | No | — |
--no-notployBackup | boolean | No | — |
--volumeBackup [boolean] | boolean | No | — |
--no-volumeBackup | boolean | No | — |
--notployRestart [boolean] | boolean | No | — |
--no-notployRestart | boolean | No | — |
--name <value> | string | No | — |
--appDeploy [boolean] | boolean | No | — |
--no-appDeploy | boolean | No | — |
--dockerCleanup [boolean] | boolean | No | — |
--no-dockerCleanup | boolean | No | — |
--serverThreshold [boolean] | boolean | No | — |
--no-serverThreshold | boolean | No | — |
--apiKey <value> | string | No | — |
--fromAddress <value> | string | No | — |
--toAddresses <json> | array | No | — |
--notificationId <value> | string | Yes | — |
--resendId <value> | string | Yes | — |
--organizationId <value> | string | No | — |
--profile <name> | string | No | — |
notploy notification update-slack
Calls POST /api/trpc/notification.updateSlack.
notploy notification update-slack --notificationId <value> --slackId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | No | — |
--no-appBuildError | boolean | No | — |
--databaseBackup [boolean] | boolean | No | — |
--no-databaseBackup | boolean | No | — |
--notployBackup [boolean] | boolean | No | — |
--no-notployBackup | boolean | No | — |
--volumeBackup [boolean] | boolean | No | — |
--no-volumeBackup | boolean | No | — |
--notployRestart [boolean] | boolean | No | — |
--no-notployRestart | boolean | No | — |
--name <value> | string | No | — |
--appDeploy [boolean] | boolean | No | — |
--no-appDeploy | boolean | No | — |
--dockerCleanup [boolean] | boolean | No | — |
--no-dockerCleanup | boolean | No | — |
--serverThreshold [boolean] | boolean | No | — |
--no-serverThreshold | boolean | No | — |
--webhookUrl <value> | string | No | — |
--channel <value> | string | No | — |
--notificationId <value> | string | Yes | — |
--slackId <value> | string | Yes | — |
--organizationId <value> | string | No | — |
--profile <name> | string | No | — |
notploy notification update-teams
Calls POST /api/trpc/notification.updateTeams.
notploy notification update-teams --notificationId <value> --teamsId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | No | — |
--no-appBuildError | boolean | No | — |
--databaseBackup [boolean] | boolean | No | — |
--no-databaseBackup | boolean | No | — |
--notployBackup [boolean] | boolean | No | — |
--no-notployBackup | boolean | No | — |
--volumeBackup [boolean] | boolean | No | — |
--no-volumeBackup | boolean | No | — |
--notployRestart [boolean] | boolean | No | — |
--no-notployRestart | boolean | No | — |
--name <value> | string | No | — |
--appDeploy [boolean] | boolean | No | — |
--no-appDeploy | boolean | No | — |
--dockerCleanup [boolean] | boolean | No | — |
--no-dockerCleanup | boolean | No | — |
--serverThreshold [boolean] | boolean | No | — |
--no-serverThreshold | boolean | No | — |
--webhookUrl <value> | string | No | — |
--notificationId <value> | string | Yes | — |
--teamsId <value> | string | Yes | — |
--organizationId <value> | string | No | — |
--profile <name> | string | No | — |
notploy notification update-telegram
Calls POST /api/trpc/notification.updateTelegram.
notploy notification update-telegram --notificationId <value> --telegramId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appBuildError [boolean] | boolean | No | — |
--no-appBuildError | boolean | No | — |
--databaseBackup [boolean] | boolean | No | — |
--no-databaseBackup | boolean | No | — |
--notployBackup [boolean] | boolean | No | — |
--no-notployBackup | boolean | No | — |
--volumeBackup [boolean] | boolean | No | — |
--no-volumeBackup | boolean | No | — |
--notployRestart [boolean] | boolean | No | — |
--no-notployRestart | boolean | No | — |
--name <value> | string | No | — |
--appDeploy [boolean] | boolean | No | — |
--no-appDeploy | boolean | No | — |
--dockerCleanup [boolean] | boolean | No | — |
--no-dockerCleanup | boolean | No | — |
--serverThreshold [boolean] | boolean | No | — |
--no-serverThreshold | boolean | No | — |
--botToken <value> | string | No | — |
--chatId <value> | string | No | — |
--messageThreadId <value> | string | No | — |
--notificationId <value> | string | Yes | — |
--telegramId <value> | string | Yes | — |
--organizationId <value> | string | No | — |
--profile <name> | string | No | — |