Dokploy

Notification

POST
/notification.createSlack

Notification create Slack

/notification.createSlack

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

appBuildError
Required
boolean

databaseBackup
Required
boolean

dokployRestart
Required
boolean

name
Required
string

appDeploy
Required
boolean

dockerCleanup
Required
boolean

webhookUrl
Required
string

Minimum length: 1

channel
Required
string

curl -X POST "http://your-dokploy-instance.com/api/notification.createSlack" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "appBuildError": true,
    "databaseBackup": true,
    "dokployRestart": true,
    "name": "string",
    "appDeploy": true,
    "dockerCleanup": true,
    "webhookUrl": "string",
    "channel": "string"
  }'

Successful response

POST
/notification.updateSlack

Notification update Slack

/notification.updateSlack

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

appBuildErrorboolean

databaseBackupboolean

dokployRestartboolean

namestring

appDeployboolean

dockerCleanupboolean

webhookUrlstring

Minimum length: 1

channelstring

notificationId
Required
string

Minimum length: 1

slackId
Required
string

adminIdstring

curl -X POST "http://your-dokploy-instance.com/api/notification.updateSlack" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "appBuildError": true,
    "databaseBackup": true,
    "dokployRestart": true,
    "name": "string",
    "appDeploy": true,
    "dockerCleanup": true,
    "webhookUrl": "string",
    "channel": "string",
    "notificationId": "string",
    "slackId": "string",
    "adminId": "string"
  }'

Successful response

POST
/notification.testSlackConnection

Notification test Slack Connection

/notification.testSlackConnection

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

webhookUrl
Required
string

Minimum length: 1

channel
Required
string

curl -X POST "http://your-dokploy-instance.com/api/notification.testSlackConnection" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "webhookUrl": "string",
    "channel": "string"
  }'

Successful response

POST
/notification.createTelegram

Notification create Telegram

/notification.createTelegram

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

appBuildError
Required
boolean

databaseBackup
Required
boolean

dokployRestart
Required
boolean

name
Required
string

appDeploy
Required
boolean

dockerCleanup
Required
boolean

botToken
Required
string

Minimum length: 1

chatId
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/notification.createTelegram" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "appBuildError": true,
    "databaseBackup": true,
    "dokployRestart": true,
    "name": "string",
    "appDeploy": true,
    "dockerCleanup": true,
    "botToken": "string",
    "chatId": "string"
  }'

Successful response

POST
/notification.updateTelegram

Notification update Telegram

/notification.updateTelegram

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

appBuildErrorboolean

databaseBackupboolean

dokployRestartboolean

namestring

appDeployboolean

dockerCleanupboolean

botTokenstring

Minimum length: 1

chatIdstring

Minimum length: 1

notificationId
Required
string

Minimum length: 1

telegramId
Required
string

Minimum length: 1

adminIdstring

curl -X POST "http://your-dokploy-instance.com/api/notification.updateTelegram" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "appBuildError": true,
    "databaseBackup": true,
    "dokployRestart": true,
    "name": "string",
    "appDeploy": true,
    "dockerCleanup": true,
    "botToken": "string",
    "chatId": "string",
    "notificationId": "string",
    "telegramId": "string",
    "adminId": "string"
  }'

Successful response

POST
/notification.testTelegramConnection

Notification test Telegram Connection

/notification.testTelegramConnection

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

botToken
Required
string

Minimum length: 1

chatId
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/notification.testTelegramConnection" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "botToken": "string",
    "chatId": "string"
  }'

Successful response

POST
/notification.createDiscord

Notification create Discord

/notification.createDiscord

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

appBuildError
Required
boolean

databaseBackup
Required
boolean

dokployRestart
Required
boolean

name
Required
string

appDeploy
Required
boolean

dockerCleanup
Required
boolean

webhookUrl
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/notification.createDiscord" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "appBuildError": true,
    "databaseBackup": true,
    "dokployRestart": true,
    "name": "string",
    "appDeploy": true,
    "dockerCleanup": true,
    "webhookUrl": "string"
  }'

Successful response

POST
/notification.updateDiscord

Notification update Discord

/notification.updateDiscord

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

appBuildErrorboolean

databaseBackupboolean

dokployRestartboolean

namestring

appDeployboolean

dockerCleanupboolean

webhookUrlstring

Minimum length: 1

notificationId
Required
string

Minimum length: 1

discordId
Required
string

Minimum length: 1

adminIdstring

curl -X POST "http://your-dokploy-instance.com/api/notification.updateDiscord" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "appBuildError": true,
    "databaseBackup": true,
    "dokployRestart": true,
    "name": "string",
    "appDeploy": true,
    "dockerCleanup": true,
    "webhookUrl": "string",
    "notificationId": "string",
    "discordId": "string",
    "adminId": "string"
  }'

Successful response

POST
/notification.testDiscordConnection

Notification test Discord Connection

/notification.testDiscordConnection

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

webhookUrl
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/notification.testDiscordConnection" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "webhookUrl": "string"
  }'

Successful response

POST
/notification.createEmail

Notification create Email

/notification.createEmail

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

appBuildError
Required
boolean

databaseBackup
Required
boolean

dokployRestart
Required
boolean

name
Required
string

appDeploy
Required
boolean

dockerCleanup
Required
boolean

smtpServer
Required
string

Minimum length: 1

smtpPort
Required
number

Minimum: 1

username
Required
string

Minimum length: 1

password
Required
string

Minimum length: 1

fromAddress
Required
string

Minimum length: 1

toAddresses
Required
array<string>

curl -X POST "http://your-dokploy-instance.com/api/notification.createEmail" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "appBuildError": true,
    "databaseBackup": true,
    "dokployRestart": true,
    "name": "string",
    "appDeploy": true,
    "dockerCleanup": true,
    "smtpServer": "string",
    "smtpPort": 1,
    "username": "string",
    "password": "string",
    "fromAddress": "string",
    "toAddresses": [
      "string"
    ]
  }'

Successful response

POST
/notification.updateEmail

Notification update Email

/notification.updateEmail

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

appBuildErrorboolean

databaseBackupboolean

dokployRestartboolean

namestring

appDeployboolean

dockerCleanupboolean

smtpServerstring

Minimum length: 1

smtpPortnumber

Minimum: 1

usernamestring

Minimum length: 1

passwordstring

Minimum length: 1

fromAddressstring

Minimum length: 1

toAddressesarray<string>

notificationId
Required
string

Minimum length: 1

emailId
Required
string

Minimum length: 1

adminIdstring

curl -X POST "http://your-dokploy-instance.com/api/notification.updateEmail" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "appBuildError": true,
    "databaseBackup": true,
    "dokployRestart": true,
    "name": "string",
    "appDeploy": true,
    "dockerCleanup": true,
    "smtpServer": "string",
    "smtpPort": 1,
    "username": "string",
    "password": "string",
    "fromAddress": "string",
    "toAddresses": [
      "string"
    ],
    "notificationId": "string",
    "emailId": "string",
    "adminId": "string"
  }'

Successful response

POST
/notification.testEmailConnection

Notification test Email Connection

/notification.testEmailConnection

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

smtpServer
Required
string

Minimum length: 1

smtpPort
Required
number

Minimum: 1

username
Required
string

Minimum length: 1

password
Required
string

Minimum length: 1

toAddresses
Required
array<string>

fromAddress
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/notification.testEmailConnection" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "smtpServer": "string",
    "smtpPort": 1,
    "username": "string",
    "password": "string",
    "toAddresses": [
      "string"
    ],
    "fromAddress": "string"
  }'

Successful response

POST
/notification.remove

Notification remove

/notification.remove

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

notificationId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/notification.remove" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "notificationId": "string"
  }'

Successful response

GET
/notification.one

Notification one

/notification.one

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

notificationId
Required
string

curl -X GET "http://your-dokploy-instance.com/api/notification.one?notificationId=string" \
  -H "Authorization: Bearer <token>"

Successful response

GET
/notification.all

Notification all

/notification.all

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

curl -X GET "http://your-dokploy-instance.com/api/notification.all" \
  -H "Authorization: Bearer <token>"

Successful response

Previous

Mysql

Next

Port