Dokploy

Notification

POST
/notification.createSlack

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

appBuildError*boolean
databaseBackup*boolean
volumeBackup*boolean
dokployRestart*boolean
name*string
appDeploy*boolean
dockerCleanup*boolean
serverThreshold*boolean
webhookUrl*string
Length1 <= length
channel*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.createSlack" \  -H "Content-Type: application/json" \  -d '{    "appBuildError": true,    "databaseBackup": true,    "volumeBackup": true,    "dokployRestart": true,    "name": "string",    "appDeploy": true,    "dockerCleanup": true,    "serverThreshold": true,    "webhookUrl": "string",    "channel": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.updateSlack

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

appBuildError?boolean
databaseBackup?boolean
volumeBackup?boolean
dokployRestart?boolean
name?string
appDeploy?boolean
dockerCleanup?boolean
serverThreshold?boolean
webhookUrl?string
Length1 <= length
channel?string
notificationId*string
Length1 <= length
slackId*string
organizationId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.updateSlack" \  -H "Content-Type: application/json" \  -d '{    "notificationId": "string",    "slackId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.testSlackConnection

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

webhookUrl*string
Length1 <= length
channel*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.testSlackConnection" \  -H "Content-Type: application/json" \  -d '{    "webhookUrl": "string",    "channel": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.createTelegram

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

appBuildError*boolean
databaseBackup*boolean
volumeBackup*boolean
dokployRestart*boolean
name*string
appDeploy*boolean
dockerCleanup*boolean
serverThreshold*boolean
botToken*string
Length1 <= length
chatId*string
Length1 <= length
messageThreadId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.createTelegram" \  -H "Content-Type: application/json" \  -d '{    "appBuildError": true,    "databaseBackup": true,    "volumeBackup": true,    "dokployRestart": true,    "name": "string",    "appDeploy": true,    "dockerCleanup": true,    "serverThreshold": true,    "botToken": "string",    "chatId": "string",    "messageThreadId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.updateTelegram

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

appBuildError?boolean
databaseBackup?boolean
volumeBackup?boolean
dokployRestart?boolean
name?string
appDeploy?boolean
dockerCleanup?boolean
serverThreshold?boolean
botToken?string
Length1 <= length
chatId?string
Length1 <= length
messageThreadId?string
notificationId*string
Length1 <= length
telegramId*string
Length1 <= length
organizationId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.updateTelegram" \  -H "Content-Type: application/json" \  -d '{    "notificationId": "string",    "telegramId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.testTelegramConnection

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

botToken*string
Length1 <= length
chatId*string
Length1 <= length
messageThreadId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.testTelegramConnection" \  -H "Content-Type: application/json" \  -d '{    "botToken": "string",    "chatId": "string",    "messageThreadId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.createDiscord

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

appBuildError*boolean
databaseBackup*boolean
volumeBackup*boolean
dokployRestart*boolean
name*string
appDeploy*boolean
dockerCleanup*boolean
serverThreshold*boolean
webhookUrl*string
Length1 <= length
decoration*boolean
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.createDiscord" \  -H "Content-Type: application/json" \  -d '{    "appBuildError": true,    "databaseBackup": true,    "volumeBackup": true,    "dokployRestart": true,    "name": "string",    "appDeploy": true,    "dockerCleanup": true,    "serverThreshold": true,    "webhookUrl": "string",    "decoration": true  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.updateDiscord

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

appBuildError?boolean
databaseBackup?boolean
volumeBackup?boolean
dokployRestart?boolean
name?string
appDeploy?boolean
dockerCleanup?boolean
serverThreshold?boolean
webhookUrl?string
Length1 <= length
decoration?boolean
notificationId*string
Length1 <= length
discordId*string
Length1 <= length
organizationId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.updateDiscord" \  -H "Content-Type: application/json" \  -d '{    "notificationId": "string",    "discordId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.testDiscordConnection

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

webhookUrl*string
Length1 <= length
decoration?boolean
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.testDiscordConnection" \  -H "Content-Type: application/json" \  -d '{    "webhookUrl": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.createEmail

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

appBuildError*boolean
databaseBackup*boolean
volumeBackup*boolean
dokployRestart*boolean
name*string
appDeploy*boolean
dockerCleanup*boolean
serverThreshold*boolean
smtpServer*string
Length1 <= length
smtpPort*number
Range1 <= value
username*string
Length1 <= length
password*string
Length1 <= length
fromAddress*string
Length1 <= length
toAddresses*array<string>
Items1 <= items
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.createEmail" \  -H "Content-Type: application/json" \  -d '{    "appBuildError": true,    "databaseBackup": true,    "volumeBackup": true,    "dokployRestart": true,    "name": "string",    "appDeploy": true,    "dockerCleanup": true,    "serverThreshold": true,    "smtpServer": "string",    "smtpPort": 1,    "username": "string",    "password": "string",    "fromAddress": "string",    "toAddresses": [      "string"    ]  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.updateEmail

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

appBuildError?boolean
databaseBackup?boolean
volumeBackup?boolean
dokployRestart?boolean
name?string
appDeploy?boolean
dockerCleanup?boolean
serverThreshold?boolean
smtpServer?string
Length1 <= length
smtpPort?number
Range1 <= value
username?string
Length1 <= length
password?string
Length1 <= length
fromAddress?string
Length1 <= length
toAddresses?array<string>
Items1 <= items
notificationId*string
Length1 <= length
emailId*string
Length1 <= length
organizationId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.updateEmail" \  -H "Content-Type: application/json" \  -d '{    "notificationId": "string",    "emailId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.testEmailConnection

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

smtpServer*string
Length1 <= length
smtpPort*number
Range1 <= value
username*string
Length1 <= length
password*string
Length1 <= length
toAddresses*array<string>
Items1 <= items
fromAddress*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.testEmailConnection" \  -H "Content-Type: application/json" \  -d '{    "smtpServer": "string",    "smtpPort": 1,    "username": "string",    "password": "string",    "toAddresses": [      "string"    ],    "fromAddress": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.remove

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

notificationId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.remove" \  -H "Content-Type: application/json" \  -d '{    "notificationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/notification.one

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

notificationId*string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/notification.one?notificationId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/notification.all

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/notification.all"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.receiveNotification

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

ServerType?string
Default"Dokploy"
Value in"Dokploy" | "Remote"
Type*string
Value in"Memory" | "CPU"
Value*number
Threshold*number
Message*string
Timestamp*string
Token*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.receiveNotification" \  -H "Content-Type: application/json" \  -d '{    "Type": "Memory",    "Value": 0,    "Threshold": 0,    "Message": "string",    "Timestamp": "string",    "Token": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.createGotify

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

appBuildError*boolean
databaseBackup*boolean
volumeBackup*boolean
dokployRestart*boolean
name*string
appDeploy*boolean
dockerCleanup*boolean
serverUrl*string
Length1 <= length
appToken*string
Length1 <= length
priority*number
Range1 <= value
decoration*boolean
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.createGotify" \  -H "Content-Type: application/json" \  -d '{    "appBuildError": true,    "databaseBackup": true,    "volumeBackup": true,    "dokployRestart": true,    "name": "string",    "appDeploy": true,    "dockerCleanup": true,    "serverUrl": "string",    "appToken": "string",    "priority": 1,    "decoration": true  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.updateGotify

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

appBuildError?boolean
databaseBackup?boolean
volumeBackup?boolean
dokployRestart?boolean
name?string
appDeploy?boolean
dockerCleanup?boolean
serverUrl?string
Length1 <= length
appToken?string
Length1 <= length
priority?number
Range1 <= value
decoration?boolean
notificationId*string
Length1 <= length
gotifyId*string
Length1 <= length
organizationId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.updateGotify" \  -H "Content-Type: application/json" \  -d '{    "notificationId": "string",    "gotifyId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.testGotifyConnection

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

serverUrl*string
Length1 <= length
appToken*string
Length1 <= length
priority*number
Range1 <= value
decoration?boolean
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.testGotifyConnection" \  -H "Content-Type: application/json" \  -d '{    "serverUrl": "string",    "appToken": "string",    "priority": 1  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.createNtfy

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

appBuildError*boolean
databaseBackup*boolean
volumeBackup*boolean
dokployRestart*boolean
name*string
appDeploy*boolean
dockerCleanup*boolean
serverUrl*string
Length1 <= length
topic*string
Length1 <= length
accessToken*string
priority*number
Range1 <= value
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.createNtfy" \  -H "Content-Type: application/json" \  -d '{    "appBuildError": true,    "databaseBackup": true,    "volumeBackup": true,    "dokployRestart": true,    "name": "string",    "appDeploy": true,    "dockerCleanup": true,    "serverUrl": "string",    "topic": "string",    "accessToken": "string",    "priority": 1  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.updateNtfy

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

appBuildError?boolean
databaseBackup?boolean
volumeBackup?boolean
dokployRestart?boolean
name?string
appDeploy?boolean
dockerCleanup?boolean
serverUrl?string
Length1 <= length
topic?string
Length1 <= length
accessToken?string
priority?number
Range1 <= value
notificationId*string
Length1 <= length
ntfyId*string
Length1 <= length
organizationId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.updateNtfy" \  -H "Content-Type: application/json" \  -d '{    "notificationId": "string",    "ntfyId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.testNtfyConnection

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

serverUrl*string
Length1 <= length
topic*string
Length1 <= length
accessToken*string
priority*number
Range1 <= value
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.testNtfyConnection" \  -H "Content-Type: application/json" \  -d '{    "serverUrl": "string",    "topic": "string",    "accessToken": "string",    "priority": 1  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.createLark

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

appBuildError*boolean
databaseBackup*boolean
volumeBackup*boolean
dokployRestart*boolean
name*string
appDeploy*boolean
dockerCleanup*boolean
serverThreshold*boolean
webhookUrl*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.createLark" \  -H "Content-Type: application/json" \  -d '{    "appBuildError": true,    "databaseBackup": true,    "volumeBackup": true,    "dokployRestart": true,    "name": "string",    "appDeploy": true,    "dockerCleanup": true,    "serverThreshold": true,    "webhookUrl": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.updateLark

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

appBuildError?boolean
databaseBackup?boolean
volumeBackup?boolean
dokployRestart?boolean
name?string
appDeploy?boolean
dockerCleanup?boolean
serverThreshold?boolean
webhookUrl?string
Length1 <= length
notificationId*string
Length1 <= length
larkId*string
Length1 <= length
organizationId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.updateLark" \  -H "Content-Type: application/json" \  -d '{    "notificationId": "string",    "larkId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/notification.testLarkConnection

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

webhookUrl*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/notification.testLarkConnection" \  -H "Content-Type: application/json" \  -d '{    "webhookUrl": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/notification.getEmailProviders

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/notification.getEmailProviders"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Mysql

Previous Page

Organization

Next Page