dokploy-api API reference · SKMTC Hub

/

/Dokploy API

APIs
Generators
Stacks
Projects

Docs
History
Schema

Checked 17m ago · Updated 12mo ago

Filter operations

admin1

post/admin.setupMonitoring

ai9

post/ai.create
post/ai.delete
post/ai.deploy
get/ai.get
get/ai.getAll
get/ai.getModels
get/ai.one
post/ai.suggest
post/ai.update

application26

post/application.cancelDeployment
post/application.cleanQueues
post/application.create
post/application.delete
post/application.deploy
post/application.disconnectGitProvider
post/application.markRunning
post/application.move
get/application.one
get/application.readAppMonitoring
get/application.readTraefikConfig
post/application.redeploy
post/application.refreshToken
post/application.reload
post/application.saveBitbucketProvider
post/application.saveBuildType
post/application.saveDockerProvider
post/application.saveEnvironment
post/application.saveGitProdiver
post/application.saveGiteaProvider
post/application.saveGithubProvider
post/application.saveGitlabProvider
post/application.start
post/application.stop
post/application.update
post/application.updateTraefikConfig

backup11

post/backup.create
get/backup.listBackupFiles
post/backup.manualBackupCompose
post/backup.manualBackupMariadb
post/backup.manualBackupMongo
post/backup.manualBackupMySql
post/backup.manualBackupPostgres
post/backup.manualBackupWebServer
get/backup.one
post/backup.remove
post/backup.update

bitbucket7

get/bitbucket.bitbucketProviders
post/bitbucket.create
get/bitbucket.getBitbucketBranches
get/bitbucket.getBitbucketRepositories
get/bitbucket.one
post/bitbucket.testConnection
post/bitbucket.update

certificates4

get/certificates.all
post/certificates.create
get/certificates.one
post/certificates.remove

cluster4

get/cluster.addManager
get/cluster.addWorker
get/cluster.getNodes
post/cluster.removeWorker

compose25

post/compose.cancelDeployment
post/compose.cleanQueues
post/compose.create
post/compose.delete
post/compose.deploy
post/compose.deployTemplate
post/compose.disconnectGitProvider
post/compose.fetchSourceType
get/compose.getConvertedCompose
get/compose.getDefaultCommand
get/compose.getTags
post/compose.import
post/compose.isolatedDeployment
get/compose.loadMountsByService
get/compose.loadServices
post/compose.move
get/compose.one
post/compose.processTemplate
post/compose.randomizeCompose
post/compose.redeploy
post/compose.refreshToken
post/compose.start
post/compose.stop
get/compose.templates
post/compose.update

deployment5

get/deployment.all
get/deployment.allByCompose
get/deployment.allByServer
get/deployment.allByType
post/deployment.killProcess

destination6

get/destination.all
post/destination.create
get/destination.one
post/destination.remove
post/destination.testConnection
post/destination.update

docker7

get/docker.getConfig
get/docker.getContainers
get/docker.getContainersByAppLabel
get/docker.getContainersByAppNameMatch
get/docker.getServiceContainersByAppName
get/docker.getStackContainersByAppName
post/docker.restartContainer

domain9

get/domain.byApplicationId
get/domain.byComposeId
get/domain.canGenerateTraefikMeDomains
post/domain.create
post/domain.delete
post/domain.generateDomain
get/domain.one
post/domain.update
post/domain.validateDomain

environment6

get/environment.byProjectId
post/environment.create
post/environment.duplicate
get/environment.one
post/environment.remove
post/environment.update

gitea8

post/gitea.create
get/gitea.getGiteaBranches
get/gitea.getGiteaRepositories
get/gitea.getGiteaUrl
get/gitea.giteaProviders
get/gitea.one
post/gitea.testConnection
post/gitea.update

github6

get/github.getGithubBranches
get/github.getGithubRepositories
get/github.githubProviders
get/github.one
post/github.testConnection
post/github.update

gitlab7

post/gitlab.create
get/gitlab.getGitlabBranches
get/gitlab.getGitlabRepositories
get/gitlab.gitlabProviders
get/gitlab.one
post/gitlab.testConnection
post/gitlab.update

gitProvider2

get/gitProvider.getAll
post/gitProvider.remove

mariadb13

post/mariadb.changeStatus
post/mariadb.create
post/mariadb.deploy
post/mariadb.move
get/mariadb.one
post/mariadb.rebuild
post/mariadb.reload
post/mariadb.remove
post/mariadb.saveEnvironment
post/mariadb.saveExternalPort
post/mariadb.start
post/mariadb.stop
post/mariadb.update

mongo13

post/mongo.changeStatus
post/mongo.create
post/mongo.deploy
post/mongo.move
get/mongo.one
post/mongo.rebuild
post/mongo.reload
post/mongo.remove
post/mongo.saveEnvironment
post/mongo.saveExternalPort
post/mongo.start
post/mongo.stop
post/mongo.update

mounts5

get/mounts.allNamedByApplicationId
post/mounts.create
get/mounts.one
post/mounts.remove
post/mounts.update

mysql13

post/mysql.changeStatus
post/mysql.create
post/mysql.deploy
post/mysql.move
get/mysql.one
post/mysql.rebuild
post/mysql.reload
post/mysql.remove
post/mysql.saveEnvironment
post/mysql.saveExternalPort
post/mysql.start
post/mysql.stop
post/mysql.update

notification23

get/notification.all
post/notification.createDiscord
post/notification.createEmail
post/notification.createGotify
post/notification.createNtfy
post/notification.createSlack
post/notification.createTelegram
get/notification.getEmailProviders
get/notification.one
post/notification.receiveNotification
post/notification.remove
post/notification.testDiscordConnection
post/notification.testEmailConnection
post/notification.testGotifyConnection
post/notification.testNtfyConnection
post/notification.testSlackConnection
post/notification.testTelegramConnection
post/notification.updateDiscord
post/notification.updateEmail
post/notification.updateGotify
post/notification.updateNtfy
post/notification.updateSlack
post/notification.updateTelegram

organization7

get/organization.all
get/organization.allInvitations
post/organization.create
post/organization.delete
get/organization.one
post/organization.removeInvitation
post/organization.update

port4

post/port.create
post/port.delete
get/port.one
post/port.update

postgres13

post/postgres.changeStatus
post/postgres.create
post/postgres.deploy
post/postgres.move
get/postgres.one
post/postgres.rebuild
post/postgres.reload
post/postgres.remove
post/postgres.saveEnvironment
post/postgres.saveExternalPort
post/postgres.start
post/postgres.stop
post/postgres.update

previewDeployment3

get/previewDeployment.all
post/previewDeployment.delete
get/previewDeployment.one

project6

get/project.all
post/project.create
post/project.duplicate
get/project.one
post/project.remove
post/project.update

redirects4

post/redirects.create
post/redirects.delete
get/redirects.one
post/redirects.update

redis13

post/redis.changeStatus
post/redis.create
post/redis.deploy
post/redis.move
get/redis.one
post/redis.rebuild
post/redis.reload
post/redis.remove
post/redis.saveEnvironment
post/redis.saveExternalPort
post/redis.start
post/redis.stop
post/redis.update

registry6

get/registry.all
post/registry.create
get/registry.one
post/registry.remove
post/registry.testRegistry
post/registry.update

rollback2

post/rollback.delete
post/rollback.rollback

schedule6

post/schedule.create
post/schedule.delete
get/schedule.list
get/schedule.one
post/schedule.runManually
post/schedule.update

security4

post/security.create
post/security.delete
get/security.one
post/security.update

server14

get/server.all
get/server.count
post/server.create
get/server.getDefaultCommand
get/server.getServerMetrics
get/server.one
get/server.publicIp
post/server.remove
get/server.security
post/server.setup
post/server.setupMonitoring
post/server.update
get/server.validate
get/server.withSSHKey

settings46

post/settings.assignDomainServer
get/settings.checkGPUStatus
post/settings.cleanAll
post/settings.cleanDockerBuilder
post/settings.cleanDockerPrune
post/settings.cleanMonitoring
post/settings.cleanRedis
post/settings.cleanSSHPrivateKey
post/settings.cleanStoppedContainers
post/settings.cleanUnusedImages
post/settings.cleanUnusedVolumes
get/settings.getDokployCloudIps
get/settings.getDokployVersion
get/settings.getIp
get/settings.getLogCleanupStatus
get/settings.getOpenApiDocument
get/settings.getReleaseTag
get/settings.getTraefikPorts
post/settings.getUpdateData
get/settings.haveActivateRequests
get/settings.haveTraefikDashboardPortEnabled
get/settings.health
get/settings.isCloud
get/settings.isUserSubscribed
get/settings.readDirectories
get/settings.readMiddlewareTraefikConfig
get/settings.readTraefikConfig
get/settings.readTraefikEnv
get/settings.readTraefikFile
get/settings.readWebServerTraefikConfig
post/settings.reloadRedis
post/settings.reloadServer
post/settings.reloadTraefik
post/settings.saveSSHPrivateKey
post/settings.setupGPU
post/settings.toggleDashboard
post/settings.toggleRequests
post/settings.updateDockerCleanup
post/settings.updateLogCleanup
post/settings.updateMiddlewareTraefikConfig
post/settings.updateServer
post/settings.updateTraefikConfig
post/settings.updateTraefikFile
post/settings.updateTraefikPorts
post/settings.updateWebServerTraefikConfig
post/settings.writeTraefikEnv

sshKey6

get/sshKey.all
post/sshKey.create
post/sshKey.generate
get/sshKey.one
post/sshKey.remove
post/sshKey.update

stripe4

get/stripe.canCreateMoreServers
post/stripe.createCheckoutSession
post/stripe.createCustomerPortalSession
get/stripe.getProducts

swarm3

get/swarm.getNodeApps
get/swarm.getNodeInfo
get/swarm.getNodes

user18

get/user.all
post/user.assignPermissions
get/user.checkUserOrganizations
post/user.createApiKey
post/user.deleteApiKey
post/user.generateToken
get/user.get
get/user.getBackups
get/user.getContainerMetrics
get/user.getInvitations
get/user.getMetricsToken
get/user.getServerMetrics
get/user.getUserByToken
get/user.haveRootAccess
get/user.one
post/user.remove
post/user.sendInvitation
post/user.update

volumeBackups6

post/volumeBackups.create
post/volumeBackups.delete
get/volumeBackups.list
get/volumeBackups.one
post/volumeBackups.runManually
post/volumeBackups.update

admin

post/admin.setupMonitoring

Request body

Response

Successful response

Changes