dokploy-api API reference · SKMTC Hub

/

/Dokploy API

APIs
Generators
Stacks
Projects

Docs
History
Schema
Sources

v3

latestOpenAPI 3.1.0Apache 2.02026-08-0654651.6 MB

admin

post/admin.setupMonitoring

Request body

Response

Successful response

object required

All 546 operations

post /admin.setupMonitoring
post /application.create
get /application.one
post /application.reload
post /application.delete
post /application.stop
post /application.start
post /application.redeploy
post /application.saveEnvironment
post /application.saveBuildType
post /application.saveGithubProvider
post /application.saveGitlabProvider
post /application.saveBitbucketProvider
post /application.saveGiteaProvider
post /application.saveDockerProvider
post /application.saveGitProvider
post /application.disconnectGitProvider
post /application.markRunning
post /application.update
post /application.refreshToken
post /application.deploy
post /application.cleanQueues
post /application.clearDeployments
post /application.killBuild
get /application.readTraefikConfig
post /application.dropDeployment
post /application.updateTraefikConfig
get /application.readAppMonitoring
post /application.move
post /application.cancelDeployment
get /application.search
get /application.readLogs
post /backup.create
get /backup.one
post /backup.update
post /backup.remove
post /backup.manualBackupPostgres
post /backup.manualBackupMySql
post /backup.manualBackupMariadb
post /backup.manualBackupCompose
post /backup.manualBackupMongo
post /backup.manualBackupLibsql
post /backup.manualBackupWebServer
get /backup.listBackupFiles
post /bitbucket.create
get /bitbucket.one
get /bitbucket.bitbucketProviders
get /bitbucket.getBitbucketRepositories
get /bitbucket.getBitbucketBranches
post /bitbucket.testConnection
post /bitbucket.update
post /certificates.create
get /certificates.one
post /certificates.remove
get /certificates.all
post /certificates.update
get /cluster.getNodes
post /cluster.removeWorker
get /cluster.addWorker
get /cluster.addManager
post /compose.create
get /compose.one
post /compose.update
post /compose.saveEnvironment
post /compose.delete
post /compose.cleanQueues
post /compose.clearDeployments
post /compose.killBuild
get /compose.loadServices
get /compose.loadMountsByService
post /compose.fetchSourceType
post /compose.randomizeCompose
post /compose.isolatedDeployment
get /compose.getConvertedCompose
post /compose.deploy
post /compose.redeploy
post /compose.stop
post /compose.start
get /compose.getDefaultCommand
post /compose.refreshToken
post /compose.deployTemplate
get /compose.templates
get /compose.getTags
post /compose.disconnectGitProvider
post /compose.move
post /compose.processTemplate
post /compose.previewTemplate
post /compose.import
post /compose.cancelDeployment
get /compose.search
get /compose.readLogs
get /deployment.all
get /deployment.allByCompose
get /deployment.allByServer
get /deployment.allCentralized
get /deployment.queueList
get /deployment.allByType
post /deployment.killProcess
post /deployment.removeDeployment
get /deployment.readLogs
post /destination.create
post /destination.testConnection
get /destination.one
get /destination.all
post /destination.remove
post /destination.update
get /docker.getContainers
post /docker.restartContainer
post /docker.startContainer
post /docker.stopContainer
post /docker.killContainer
post /docker.removeContainer
get /docker.getConfig
get /docker.getContainersByAppNameMatch
get /docker.getContainersByAppLabel
get /docker.getStackContainersByAppName
get /docker.getServiceContainersByAppName
post /docker.uploadFileToContainer
post /domain.create
get /domain.byApplicationId
get /domain.byComposeId
post /domain.generateDomain
get /domain.canGenerateTraefikMeDomains
post /domain.update
get /domain.one
post /domain.delete
post /domain.validateDomain
post /gitea.create
get /gitea.one
get /gitea.giteaProviders
get /gitea.getGiteaRepositories
get /gitea.getGiteaBranches
post /gitea.testConnection
post /gitea.update
get /gitea.getGiteaUrl
get /gitProvider.getAll
post /gitProvider.toggleShare
get /gitProvider.allForPermissions
post /gitProvider.remove
get /github.one
get /github.getGithubRepositories
get /github.getGithubBranches
get /github.githubProviders
post /github.testConnection
post /github.update
post /gitlab.create
get /gitlab.one
get /gitlab.gitlabProviders
get /gitlab.getGitlabRepositories
get /gitlab.getGitlabBranches
post /gitlab.testConnection
post /gitlab.update
post /libsql.create
get /libsql.one
post /libsql.start
post /libsql.stop
post /libsql.saveExternalPorts
post /libsql.deploy
post /libsql.changeStatus
post /libsql.remove
post /libsql.saveEnvironment
post /libsql.reload
post /libsql.update
post /libsql.move
post /libsql.rebuild
get /libsql.readLogs
post /mariadb.create
get /mariadb.one
post /mariadb.start
post /mariadb.stop
post /mariadb.saveExternalPort
post /mariadb.deploy
post /mariadb.changeStatus
post /mariadb.remove
post /mariadb.saveEnvironment
post /mariadb.reload
post /mariadb.update
post /mariadb.changePassword
post /mariadb.move
post /mariadb.rebuild
get /mariadb.search
get /mariadb.readLogs
post /mongo.create
get /mongo.one
post /mongo.start
post /mongo.stop
post /mongo.saveExternalPort
post /mongo.deploy
post /mongo.changeStatus
post /mongo.reload
post /mongo.remove
post /mongo.saveEnvironment
post /mongo.update
post /mongo.changePassword
post /mongo.move
post /mongo.rebuild
get /mongo.search
get /mongo.readLogs
post /mounts.create
post /mounts.remove
get /mounts.one
post /mounts.update
get /mounts.allNamedByApplicationId
get /mounts.listByServiceId
post /mysql.create
get /mysql.one
post /mysql.start
post /mysql.stop
post /mysql.saveExternalPort
post /mysql.deploy
post /mysql.changeStatus
post /mysql.reload
post /mysql.remove
post /mysql.saveEnvironment
post /mysql.update
post /mysql.changePassword
post /mysql.move
post /mysql.rebuild
get /mysql.search
get /mysql.readLogs
post /notification.createSlack
post /notification.updateSlack
post /notification.testSlackConnection
post /notification.createTelegram
post /notification.updateTelegram
post /notification.testTelegramConnection
post /notification.createDiscord
post /notification.updateDiscord
post /notification.testDiscordConnection
post /notification.createEmail
post /notification.updateEmail
post /notification.testEmailConnection
post /notification.createResend
post /notification.updateResend
post /notification.testResendConnection
post /notification.remove
get /notification.one
get /notification.all
post /notification.receiveNotification
post /notification.createGotify
post /notification.updateGotify
post /notification.testGotifyConnection
post /notification.createNtfy
post /notification.updateNtfy
post /notification.testNtfyConnection
post /notification.createMattermost
post /notification.updateMattermost
post /notification.testMattermostConnection
post /notification.createCustom
post /notification.updateCustom
post /notification.testCustomConnection
post /notification.createLark
post /notification.updateLark
post /notification.testLarkConnection
post /notification.createTeams
post /notification.updateTeams
post /notification.testTeamsConnection
post /notification.createPushover
post /notification.updatePushover
post /notification.testPushoverConnection
get /notification.getEmailProviders
post /port.create
get /port.one
post /port.delete
post /port.update
post /postgres.create
get /postgres.one
post /postgres.start
post /postgres.stop
post /postgres.saveExternalPort
post /postgres.deploy
post /postgres.changeStatus
post /postgres.remove
post /postgres.saveEnvironment
post /postgres.reload
post /postgres.update
post /postgres.changePassword
post /postgres.move
post /postgres.rebuild
get /postgres.search
get /postgres.readLogs
get /previewDeployment.all
get /previewDeployment.one
post /previewDeployment.delete
post /previewDeployment.redeploy
post /project.create
get /project.one
get /project.all
get /project.allForPermissions
get /project.homeStats
get /project.search
post /project.remove
post /project.update
post /project.duplicate
post /redirects.create
get /redirects.one
post /redirects.delete
post /redirects.update
post /redis.create
get /redis.one
post /redis.start
post /redis.reload
post /redis.stop
post /redis.saveExternalPort
post /redis.deploy
post /redis.changeStatus
post /redis.remove
post /redis.saveEnvironment
post /redis.update
post /redis.changePassword
post /redis.move
post /redis.rebuild
get /redis.search
get /redis.readLogs
post /registry.create
post /registry.remove
post /registry.update
get /registry.all
get /registry.one
post /registry.testRegistry
post /registry.testRegistryById
post /security.create
get /security.one
post /security.delete
post /security.update
post /server.create
get /server.one
get /server.getDefaultCommand
get /server.all
get /server.allForPermissions
get /server.count
get /server.withSSHKey
get /server.buildServers
post /server.setup
get /server.validate
get /server.security
post /server.setupMonitoring
post /server.remove
post /server.update
post /server.updateBuildsConcurrency
get /server.publicIp
get /server.getServerTime
get /server.getServerMetrics
get /settings.getWebServerSettings
post /settings.reloadServer
post /settings.cleanRedis
post /settings.reloadRedis
post /settings.cleanAllDeploymentQueue
post /settings.reloadTraefik
post /settings.toggleDashboard
post /settings.cleanUnusedImages
post /settings.cleanUnusedVolumes
post /settings.cleanStoppedContainers
post /settings.cleanDockerBuilder
post /settings.cleanDockerPrune
post /settings.cleanAll
post /settings.cleanMonitoring
get /settings.getDockerDiskUsage
post /settings.saveSSHPrivateKey
post /settings.assignDomainServer
post /settings.cleanSSHPrivateKey
post /settings.updateDockerCleanup
post /settings.updateRemoteServersOnly
post /settings.updateBuildsConcurrency
post /settings.updateEnforceSSO
get /settings.readTraefikConfig
post /settings.updateTraefikConfig
get /settings.readWebServerTraefikConfig
post /settings.updateWebServerTraefikConfig
get /settings.readMiddlewareTraefikConfig
post /settings.updateMiddlewareTraefikConfig
post /settings.getUpdateData
post /settings.updateServer
get /settings.getDokployVersion
get /settings.getReleaseTag
get /settings.readDirectories
post /settings.updateTraefikFile
get /settings.readTraefikFile
get /settings.getIp
post /settings.updateServerIp
get /settings.getOpenApiDocument
get /settings.readTraefikEnv
post /settings.writeTraefikEnv
get /settings.haveTraefikDashboardPortEnabled
get /settings.haveActivateRequests
post /settings.toggleRequests
get /settings.isCloud
get /settings.isUserSubscribed
get /settings.health
get /settings.checkInfrastructureHealth
post /settings.setupGPU
get /settings.checkGPUStatus
post /settings.updateTraefikPorts
get /settings.getTraefikPorts
post /settings.updateLogCleanup
get /settings.getLogCleanupStatus
get /settings.getDokployCloudIps
post /sshKey.create
post /sshKey.remove
get /sshKey.one
get /sshKey.all
get /sshKey.allForApps
post /sshKey.generate
post /sshKey.update
get /stripe.getCurrentPlan
get /stripe.getProducts
post /stripe.createCheckoutSession
post /stripe.createCustomerPortalSession
post /stripe.upgradeSubscription
get /stripe.canCreateMoreServers
post /stripe.updateInvoiceNotifications
get /stripe.getInvoices
get /swarm.getNodes
get /swarm.getNodeInfo
get /swarm.getNodeApps
get /swarm.getContainerStats
get /user.all
get /user.one
get /user.session
get /user.get
get /user.getPermissions
get /user.haveRootAccess
get /user.getBackups
get /user.getServerMetrics
post /user.update
get /user.getUserByToken
get /user.getMetricsToken
post /user.remove
post /user.assignPermissions
get /user.getInvitations
get /user.getContainerMetrics
post /user.generateToken
post /user.deleteApiKey
post /user.createApiKey
get /user.checkUserOrganizations
post /user.createUserWithCredentials
post /user.sendInvitation
get /user.getBookmarkedTemplates
post /user.toggleTemplateBookmark
get /ai.one
get /ai.getModels
post /ai.create
post /ai.update
get /ai.getAll
get /ai.get
post /ai.delete
get /ai.getCustomProviders
post /ai.saveCustomProviders
get /ai.getEnabledProviders
post /ai.analyzeLogs
post /ai.testConnection
post /ai.suggest
post /ai.deploy
post /organization.create
get /organization.all
get /organization.one
post /organization.update
post /organization.delete
post /organization.inviteMember
get /organization.allInvitations
post /organization.removeInvitation
post /organization.updateMemberRole
post /organization.setDefault
get /organization.active
post /licenseKey.activate
post /licenseKey.validate
post /licenseKey.deactivate
get /licenseKey.getEnterpriseSettings
get /licenseKey.haveValidLicenseKey
post /licenseKey.updateEnterpriseSettings
get /sso.showSignInWithSSO
get /sso.enforceSSO
get /sso.listProviders
get /sso.getTrustedOrigins
get /sso.one
post /sso.update
post /sso.deleteProvider
post /sso.register
post /sso.addTrustedOrigin
post /sso.removeTrustedOrigin
post /sso.updateTrustedOrigin
get /scim.listProviders
post /scim.generateToken
post /scim.deleteProvider
get /forwardAuth.getAuthDomain
post /forwardAuth.setAuthDomain
post /forwardAuth.removeAuthDomain
get /forwardAuth.listProviders
get /forwardAuth.serverStatus
post /forwardAuth.deployOnServer
post /forwardAuth.removeOnServer
get /forwardAuth.status
post /forwardAuth.enable
post /forwardAuth.disable
get /whitelabeling.get
post /whitelabeling.update
post /whitelabeling.reset
get /whitelabeling.getPublic
get /customRole.all
post /customRole.create
post /customRole.update
post /customRole.remove
get /customRole.membersByRole
get /customRole.getStatements
get /auditLog.all
post /schedule.create
post /schedule.update
post /schedule.delete
get /schedule.list
get /schedule.one
post /schedule.runManually
post /rollback.delete
post /rollback.rollback
get /volumeBackups.list
post /volumeBackups.create
get /volumeBackups.one
post /volumeBackups.delete
post /volumeBackups.update
post /volumeBackups.runManually
post /environment.create
get /environment.one
get /environment.byProjectId
post /environment.remove
post /environment.update
post /environment.duplicate
get /environment.search
post /tag.create
get /tag.all
get /tag.one
post /tag.update
post /tag.remove
post /tag.assignToProject
post /tag.removeFromProject
post /tag.bulkAssign
post /patch.create
get /patch.one
get /patch.byEntityId
post /patch.update
post /patch.delete
post /patch.toggleEnabled
post /patch.ensureRepo
get /patch.readRepoDirectories
get /patch.readRepoFile
post /patch.saveFileAsPatch
post /patch.markFileForDeletion
post /patch.cleanPatchRepos