Notification
notification.createSlackNotification create Slack
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredappBuildErrorRequiredboolean
databaseBackupRequiredboolean
dokployRestartRequiredboolean
nameRequiredstring
appDeployRequiredboolean
dockerCleanupRequiredboolean
serverThresholdRequiredboolean
webhookUrlRequiredstring
1channelRequiredstring
Successful response
notification.updateSlackNotification update Slack
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredappBuildErrorboolean
databaseBackupboolean
dokployRestartboolean
namestring
appDeployboolean
dockerCleanupboolean
serverThresholdboolean
webhookUrlstring
1channelstring
notificationIdRequiredstring
1slackIdRequiredstring
organizationIdstring
Successful response
notification.testSlackConnectionNotification test Slack Connection
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredwebhookUrlRequiredstring
1channelRequiredstring
Successful response
notification.createTelegramNotification create Telegram
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredappBuildErrorRequiredboolean
databaseBackupRequiredboolean
dokployRestartRequiredboolean
nameRequiredstring
appDeployRequiredboolean
dockerCleanupRequiredboolean
serverThresholdRequiredboolean
botTokenRequiredstring
1chatIdRequiredstring
1messageThreadIdRequiredstring
Successful response
notification.updateTelegramNotification update Telegram
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredappBuildErrorboolean
databaseBackupboolean
dokployRestartboolean
namestring
appDeployboolean
dockerCleanupboolean
serverThresholdboolean
botTokenstring
1chatIdstring
1messageThreadIdstring
notificationIdRequiredstring
1telegramIdRequiredstring
1organizationIdstring
Successful response
notification.testTelegramConnectionNotification test Telegram Connection
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredbotTokenRequiredstring
1chatIdRequiredstring
1messageThreadIdRequiredstring
Successful response
notification.createDiscordNotification create Discord
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredappBuildErrorRequiredboolean
databaseBackupRequiredboolean
dokployRestartRequiredboolean
nameRequiredstring
appDeployRequiredboolean
dockerCleanupRequiredboolean
serverThresholdRequiredboolean
webhookUrlRequiredstring
1decorationRequiredboolean
Successful response
notification.updateDiscordNotification update Discord
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredappBuildErrorboolean
databaseBackupboolean
dokployRestartboolean
namestring
appDeployboolean
dockerCleanupboolean
serverThresholdboolean
webhookUrlstring
1decorationboolean
notificationIdRequiredstring
1discordIdRequiredstring
1organizationIdstring
Successful response
notification.testDiscordConnectionNotification test Discord Connection
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredwebhookUrlRequiredstring
1decorationboolean
Successful response
notification.createEmailNotification create Email
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredappBuildErrorRequiredboolean
databaseBackupRequiredboolean
dokployRestartRequiredboolean
nameRequiredstring
appDeployRequiredboolean
dockerCleanupRequiredboolean
serverThresholdRequiredboolean
smtpServerRequiredstring
1smtpPortRequirednumber
1usernameRequiredstring
1passwordRequiredstring
1fromAddressRequiredstring
1toAddressesRequiredarray<string>
Successful response
notification.updateEmailNotification update Email
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredappBuildErrorboolean
databaseBackupboolean
dokployRestartboolean
namestring
appDeployboolean
dockerCleanupboolean
serverThresholdboolean
smtpServerstring
1smtpPortnumber
1usernamestring
1passwordstring
1fromAddressstring
1toAddressesarray<string>
notificationIdRequiredstring
1emailIdRequiredstring
1organizationIdstring
Successful response
notification.testEmailConnectionNotification test Email Connection
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredsmtpServerRequiredstring
1smtpPortRequirednumber
1usernameRequiredstring
1passwordRequiredstring
1toAddressesRequiredarray<string>
fromAddressRequiredstring
1Successful response
notification.removeNotification remove
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequirednotificationIdRequiredstring
Successful response
notification.oneNotification one
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Query Parameters
notificationIdRequiredstring
Successful response
notification.allNotification all
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Successful response
notification.receiveNotificationNotification receive Notification
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredServerTypestring
"Dokploy"Value in: "Dokploy" | "Remote"TypeRequiredstring
"Memory" | "CPU"ValueRequirednumber
ThresholdRequirednumber
MessageRequiredstring
TimestampRequiredstring
TokenRequiredstring
Successful response
notification.createGotifyNotification create Gotify
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredappBuildErrorRequiredboolean
databaseBackupRequiredboolean
dokployRestartRequiredboolean
nameRequiredstring
appDeployRequiredboolean
dockerCleanupRequiredboolean
serverUrlRequiredstring
1appTokenRequiredstring
1priorityRequirednumber
1decorationRequiredboolean
Successful response
notification.updateGotifyNotification update Gotify
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredappBuildErrorboolean
databaseBackupboolean
dokployRestartboolean
namestring
appDeployboolean
dockerCleanupboolean
serverUrlstring
1appTokenstring
1prioritynumber
1decorationboolean
notificationIdRequiredstring
1gotifyIdRequiredstring
1organizationIdstring
Successful response
notification.testGotifyConnectionNotification test Gotify Connection
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredserverUrlRequiredstring
1appTokenRequiredstring
1priorityRequirednumber
1decorationboolean
Successful response
notification.createNtfyNotification create Ntfy
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredappBuildErrorRequiredboolean
databaseBackupRequiredboolean
dokployRestartRequiredboolean
nameRequiredstring
appDeployRequiredboolean
dockerCleanupRequiredboolean
serverUrlRequiredstring
1topicRequiredstring
1accessTokenRequiredstring
1priorityRequirednumber
1Successful response
notification.updateNtfyNotification update Ntfy
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredappBuildErrorboolean
databaseBackupboolean
dokployRestartboolean
namestring
appDeployboolean
dockerCleanupboolean
serverUrlstring
1topicstring
1accessTokenstring
1prioritynumber
1notificationIdRequiredstring
1ntfyIdRequiredstring
1organizationIdstring
Successful response
notification.testNtfyConnectionNotification test Ntfy Connection
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredserverUrlRequiredstring
1topicRequiredstring
1accessTokenRequiredstring
1priorityRequirednumber
1Successful response
notification.createLarkNotification create Lark
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredappBuildErrorRequiredboolean
databaseBackupRequiredboolean
dokployRestartRequiredboolean
nameRequiredstring
appDeployRequiredboolean
dockerCleanupRequiredboolean
serverThresholdRequiredboolean
webhookUrlRequiredstring
1Successful response
notification.updateLarkNotification update Lark
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredappBuildErrorboolean
databaseBackupboolean
dokployRestartboolean
namestring
appDeployboolean
dockerCleanupboolean
serverThresholdboolean
webhookUrlstring
1notificationIdRequiredstring
1larkIdRequiredstring
1organizationIdstring
Successful response
notification.testLarkConnectionNotification test Lark Connection
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Request Body
application/jsonRequiredwebhookUrlRequiredstring
1Successful response
notification.getEmailProvidersNotification get Email Providers
Authorization
Authorization<token>
API key authentication using Authorization header
In: header
Successful response