Dokploy API
GET/admin.one
admin-one
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/admin.createUserInvitation
admin-createUserInvitation
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
email
Requiredstring
Format: "email"
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/admin.removeUser
admin-removeUser
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
authId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/admin.getUserByToken
admin-getUserByToken
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
token
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/admin.assignPermissions
admin-assignPermissions
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
userId
Requiredstring
Minimum length: 1
canCreateProjects
Requiredboolean
canCreateServices
Requiredboolean
canDeleteProjects
Requiredboolean
canDeleteServices
Requiredboolean
accesedProjects
Requiredarray of string
accesedServices
Requiredarray of string
canAccessToTraefikFiles
Requiredboolean
canAccessToDocker
Requiredboolean
canAccessToAPI
Requiredboolean
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/admin.cleanGithubApp
admin-cleanGithubApp
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/admin.getRepositories
admin-getRepositories
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/admin.getBranches
admin-getBranches
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
repo
Requiredstring
Minimum length: 1
owner
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/admin.haveGithubConfigured
admin-haveGithubConfigured
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/docker.getContainers
docker-getContainers
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/docker.getConfig
docker-getConfig
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
containerId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/docker.getContainersByAppNameMatch
docker-getContainersByAppNameMatch
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
appName
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/docker.getContainersByAppLabel
docker-getContainersByAppLabel
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
appName
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/auth.createAdmin
auth-createAdmin
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
email
Requiredstring
Format: "email"
password
Requiredstring
Minimum length: 8
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/auth.createUser
auth-createUser
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
password
Requiredstring
Minimum length: 8
id
Requiredstring
token
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/auth.login
auth-login
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
email
Requiredstring
Format: "email"
password
Requiredstring
Minimum length: 8
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/auth.get
auth-get
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/auth.logout
auth-logout
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/auth.update
auth-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
id
string
email
Requiredstring | null
password
Requiredstring | null
rol
string
Value in: "admin" | "user"
image
string
secret
string | null
token
string | null
is2FAEnabled
boolean
createdAt
string
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/auth.generateToken
auth-generateToken
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/auth.one
auth-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
id
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/auth.updateByAdmin
auth-updateByAdmin
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
id
Requiredstring
Minimum length: 1
email
Requiredstring | null
password
Requiredstring | null
rol
string
Value in: "admin" | "user"
image
string
secret
string | null
token
string | null
is2FAEnabled
boolean
createdAt
string
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/auth.generate2FASecret
auth-generate2FASecret
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/auth.verify2FASetup
auth-verify2FASetup
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
pin
Requiredstring
Minimum length: 6
secret
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/auth.verifyLogin2FA
auth-verifyLogin2FA
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
pin
Requiredstring
Minimum length: 6
id
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/auth.disable2FA
auth-disable2FA
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/auth.verifyToken
auth-verifyToken
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/project.create
project-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
name
Requiredstring
Minimum length: 1
description
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/project.one
project-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
projectId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/project.all
project-all
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/project.remove
project-remove
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
projectId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/project.update
project-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
name
Requiredstring
Minimum length: 1
description
string | null
projectId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.create
application-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
name
Requiredstring
Minimum length: 1
appName
string
description
string | null
projectId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/application.one
application-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
applicationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.reload
application-reload
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
appName
Requiredstring
applicationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.delete
application-delete
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
applicationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.stop
application-stop
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
applicationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.start
application-start
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
applicationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.redeploy
application-redeploy
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
applicationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.saveEnvironment
application-saveEnvironment
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
applicationId
Requiredstring
env
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.saveBuildType
application-saveBuildType
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
applicationId
Requiredstring
buildType
Requiredstring
Value in: "dockerfile" | "heroku_buildpacks" | "paketo_buildpacks" | "nixpacks"
dockerfile
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.saveGithubProvider
application-saveGithubProvider
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
applicationId
Requiredstring
repository
string | null
branch
string | null
owner
Requiredstring | null
buildPath
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.saveDockerProvider
application-saveDockerProvider
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
dockerImage
string | null
applicationId
Requiredstring
username
string | null
password
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.saveGitProdiver
application-saveGitProdiver
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
customGitBranch
string | null
applicationId
Requiredstring
customGitBuildPath
string | null
customGitUrl
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.generateSSHKey
application-generateSSHKey
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
applicationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.removeSSHKey
application-removeSSHKey
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
applicationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.markRunning
application-markRunning
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
applicationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.update
application-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
applicationId
Requiredstring
Minimum length: 1
name
string
Minimum length: 1
appName
string
description
string | null
env
string | null
memoryReservation
number | null
memoryLimit
number | null
cpuReservation
number | null
cpuLimit
number | null
title
string | null
enabled
boolean | null
subtitle
string | null
command
string | null
refreshToken
string | null
sourceType
string
Value in: "github" | "docker" | "git"
repository
string | null
owner
string | null
branch
string | null
buildPath
string | null
autoDeploy
boolean | null
username
string | null
password
string | null
dockerImage
string | null
customGitUrl
string | null
customGitBranch
string | null
customGitBuildPath
string | null
customGitSSHKey
string | null
dockerfile
string | null
healthCheckSwarm
object | null
restartPolicySwarm
object | null
placementSwarm
object | null
updateConfigSwarm
object | null
rollbackConfigSwarm
object | null
modeSwarm
object | null
labelsSwarm
object | null
networkSwarm
array of object | null
replicas
number
applicationStatus
string
Value in: "idle" | "running" | "done" | "error"
buildType
string
Value in: "dockerfile" | "heroku_buildpacks" | "paketo_buildpacks" | "nixpacks"
createdAt
string
registryId
string | null
projectId
string
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.refreshToken
application-refreshToken
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
applicationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.deploy
application-deploy
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
applicationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.cleanQueues
application-cleanQueues
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
applicationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/application.readTraefikConfig
application-readTraefikConfig
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
applicationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/application.updateTraefikConfig
application-updateTraefikConfig
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
applicationId
Requiredstring
traefikConfig
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/application.readAppMonitoring
application-readAppMonitoring
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
appName
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mysql.create
mysql-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
name
Requiredstring
Minimum length: 1
appName
Requiredstring
Minimum length: 1
dockerImage
string
Default: "mysql:8"
projectId
Requiredstring
description
string | null
databaseName
Requiredstring
Minimum length: 1
databaseUser
Requiredstring
Minimum length: 1
databasePassword
Requiredstring
databaseRootPassword
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/mysql.one
mysql-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
mysqlId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mysql.start
mysql-start
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mysqlId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mysql.stop
mysql-stop
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mysqlId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mysql.saveExternalPort
mysql-saveExternalPort
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mysqlId
Requiredstring
externalPort
Requirednumber | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mysql.deploy
mysql-deploy
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mysqlId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mysql.changeStatus
mysql-changeStatus
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mysqlId
Requiredstring
applicationStatus
Requiredstring
Value in: "idle" | "running" | "done" | "error"
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mysql.reload
mysql-reload
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mysqlId
Requiredstring
appName
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mysql.remove
mysql-remove
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mysqlId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mysql.saveEnvironment
mysql-saveEnvironment
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mysqlId
Requiredstring
env
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mysql.update
mysql-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mysqlId
Requiredstring
Minimum length: 1
name
string
Minimum length: 1
appName
string
Minimum length: 1
description
string | null
databaseName
string
Minimum length: 1
databaseUser
string
Minimum length: 1
databasePassword
string
databaseRootPassword
string
dockerImage
string
Default: "mysql:8"
command
string | null
env
string | null
memoryReservation
number | null
memoryLimit
number | null
cpuReservation
number | null
cpuLimit
number | null
externalPort
number | null
applicationStatus
string
Value in: "idle" | "running" | "done" | "error"
createdAt
string
projectId
string
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/postgres.create
postgres-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
name
Requiredstring
Minimum length: 1
appName
Requiredstring
databaseName
Requiredstring
Minimum length: 1
databaseUser
Requiredstring
Minimum length: 1
databasePassword
Requiredstring
dockerImage
string
Default: "postgres:15"
projectId
Requiredstring
description
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/postgres.one
postgres-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
postgresId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/postgres.start
postgres-start
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
postgresId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/postgres.stop
postgres-stop
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
postgresId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/postgres.saveExternalPort
postgres-saveExternalPort
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
postgresId
Requiredstring
externalPort
Requirednumber | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/postgres.deploy
postgres-deploy
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
postgresId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/postgres.changeStatus
postgres-changeStatus
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
postgresId
Requiredstring
applicationStatus
Requiredstring
Value in: "idle" | "running" | "done" | "error"
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/postgres.remove
postgres-remove
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
postgresId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/postgres.saveEnvironment
postgres-saveEnvironment
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
postgresId
Requiredstring
env
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/postgres.reload
postgres-reload
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
postgresId
Requiredstring
appName
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/postgres.update
postgres-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
postgresId
Requiredstring
Minimum length: 1
name
string
Minimum length: 1
appName
string
databaseName
string
Minimum length: 1
databaseUser
string
Minimum length: 1
databasePassword
string
description
string | null
dockerImage
string
Default: "postgres:15"
command
string | null
env
string | null
memoryReservation
number | null
externalPort
number | null
memoryLimit
number | null
cpuReservation
number | null
cpuLimit
number | null
applicationStatus
string
Value in: "idle" | "running" | "done" | "error"
createdAt
string
projectId
string
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/redis.create
redis-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
name
Requiredstring
Minimum length: 1
appName
Requiredstring
Minimum length: 1
databasePassword
Requiredstring
dockerImage
string
Default: "redis:8"
projectId
Requiredstring
description
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/redis.one
redis-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
redisId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/redis.start
redis-start
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
redisId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/redis.reload
redis-reload
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
redisId
Requiredstring
appName
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/redis.stop
redis-stop
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
redisId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/redis.saveExternalPort
redis-saveExternalPort
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
redisId
Requiredstring
externalPort
Requirednumber | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/redis.deploy
redis-deploy
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
redisId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/redis.changeStatus
redis-changeStatus
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
redisId
Requiredstring
applicationStatus
Requiredstring
Value in: "idle" | "running" | "done" | "error"
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/redis.remove
redis-remove
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
redisId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/redis.saveEnvironment
redis-saveEnvironment
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
redisId
Requiredstring
env
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/redis.update
redis-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
redisId
Requiredstring
Minimum length: 1
name
string
Minimum length: 1
appName
string
Minimum length: 1
description
string | null
databasePassword
string
dockerImage
string
Default: "redis:8"
command
string | null
env
string | null
memoryReservation
number | null
memoryLimit
number | null
cpuReservation
number | null
cpuLimit
number | null
externalPort
number | null
createdAt
string
applicationStatus
string
Value in: "idle" | "running" | "done" | "error"
projectId
string
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mongo.create
mongo-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
name
Requiredstring
Minimum length: 1
appName
Requiredstring
Minimum length: 1
dockerImage
string
Default: "mongo:15"
projectId
Requiredstring
description
string | null
databaseUser
Requiredstring
Minimum length: 1
databasePassword
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/mongo.one
mongo-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
mongoId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mongo.start
mongo-start
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mongoId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mongo.stop
mongo-stop
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mongoId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mongo.saveExternalPort
mongo-saveExternalPort
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mongoId
Requiredstring
externalPort
Requirednumber | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mongo.deploy
mongo-deploy
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mongoId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mongo.changeStatus
mongo-changeStatus
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mongoId
Requiredstring
applicationStatus
Requiredstring
Value in: "idle" | "running" | "done" | "error"
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mongo.reload
mongo-reload
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mongoId
Requiredstring
appName
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mongo.remove
mongo-remove
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mongoId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mongo.saveEnvironment
mongo-saveEnvironment
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mongoId
Requiredstring
env
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mongo.update
mongo-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mongoId
Requiredstring
Minimum length: 1
name
string
Minimum length: 1
appName
string
Minimum length: 1
description
string | null
databaseUser
string
Minimum length: 1
databasePassword
string
dockerImage
string
Default: "mongo:15"
command
string | null
env
string | null
memoryReservation
number | null
memoryLimit
number | null
cpuReservation
number | null
cpuLimit
number | null
externalPort
number | null
applicationStatus
string
Value in: "idle" | "running" | "done" | "error"
createdAt
string
projectId
string
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mariadb.create
mariadb-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
name
Requiredstring
Minimum length: 1
appName
Requiredstring
Minimum length: 1
dockerImage
string
Default: "mariadb:6"
databaseRootPassword
Requiredstring
projectId
Requiredstring
description
string | null
databaseName
Requiredstring
Minimum length: 1
databaseUser
Requiredstring
Minimum length: 1
databasePassword
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/mariadb.one
mariadb-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
mariadbId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mariadb.start
mariadb-start
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mariadbId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mariadb.stop
mariadb-stop
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mariadbId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mariadb.saveExternalPort
mariadb-saveExternalPort
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mariadbId
Requiredstring
externalPort
Requirednumber | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mariadb.deploy
mariadb-deploy
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mariadbId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mariadb.changeStatus
mariadb-changeStatus
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mariadbId
Requiredstring
applicationStatus
Requiredstring
Value in: "idle" | "running" | "done" | "error"
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mariadb.remove
mariadb-remove
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mariadbId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mariadb.saveEnvironment
mariadb-saveEnvironment
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mariadbId
Requiredstring
env
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mariadb.reload
mariadb-reload
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mariadbId
Requiredstring
appName
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mariadb.update
mariadb-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mariadbId
Requiredstring
Minimum length: 1
name
string
Minimum length: 1
appName
string
Minimum length: 1
description
string | null
databaseName
string
Minimum length: 1
databaseUser
string
Minimum length: 1
databasePassword
string
databaseRootPassword
string
dockerImage
string
Default: "mariadb:6"
command
string | null
env
string | null
memoryReservation
number | null
memoryLimit
number | null
cpuReservation
number | null
cpuLimit
number | null
externalPort
number | null
applicationStatus
string
Value in: "idle" | "running" | "done" | "error"
createdAt
string
projectId
string
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.create
compose-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
name
Requiredstring
Minimum length: 1
description
string | null
projectId
Requiredstring
composeType
string
Value in: "docker-compose" | "stack"
appName
string
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/compose.one
compose-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.update
compose-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
name
string
Minimum length: 1
appName
string
description
string | null
env
string | null
composeFile
string
refreshToken
string | null
sourceType
string
Value in: "git" | "github" | "raw"
composeType
string
Value in: "docker-compose" | "stack"
repository
string | null
owner
string | null
branch
string | null
autoDeploy
boolean | null
customGitUrl
string | null
customGitBranch
string | null
customGitSSHKey
string | null
command
string
composePath
string
Minimum length: 1
composeStatus
string
Value in: "idle" | "running" | "done" | "error"
projectId
string
createdAt
string
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.delete
compose-delete
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.cleanQueues
compose-cleanQueues
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/compose.allServices
compose-allServices
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.randomizeCompose
compose-randomizeCompose
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
prefix
string
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.deploy
compose-deploy
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.redeploy
compose-redeploy
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.stop
compose-stop
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/compose.getDefaultCommand
compose-getDefaultCommand
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.generateSSHKey
compose-generateSSHKey
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.refreshToken
compose-refreshToken
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.removeSSHKey
compose-removeSSHKey
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.deployTemplate
compose-deployTemplate
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
projectId
Requiredstring
id
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/compose.templates
compose-templates
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/user.all
user-all
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/user.byAuthId
user-byAuthId
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
authId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/user.byUserId
user-byUserId
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
userId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/domain.create
domain-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
host
Requiredstring
Minimum length: 1
path
Requiredstring | null
Minimum length: 1
port
Requirednumber | null
https
Requiredboolean
applicationId
Requiredstring
certificateType
Requiredstring
Value in: "letsencrypt" | "none"
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/domain.byApplicationId
domain-byApplicationId
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
applicationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/domain.update
domain-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
domainId
Requiredstring
Minimum length: 1
host
Requiredstring
Minimum length: 1
path
Requiredstring | null
Minimum length: 1
port
Requirednumber | null
https
Requiredboolean
certificateType
Requiredstring
Value in: "letsencrypt" | "none"
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/domain.one
domain-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
domainId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/domain.delete
domain-delete
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
domainId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/destination.create
destination-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
name
Requiredstring
Minimum length: 1
accessKey
Requiredstring
bucket
Requiredstring
region
Requiredstring
endpoint
Requiredstring
secretAccessKey
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/destination.testConnection
destination-testConnection
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
name
Requiredstring
Minimum length: 1
accessKey
Requiredstring
bucket
Requiredstring
region
Requiredstring
endpoint
Requiredstring
secretAccessKey
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/destination.one
destination-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
destinationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/destination.all
destination-all
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/destination.remove
destination-remove
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
destinationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/destination.update
destination-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
name
Requiredstring
Minimum length: 1
accessKey
Requiredstring
bucket
Requiredstring
region
Requiredstring
endpoint
Requiredstring
secretAccessKey
Requiredstring
destinationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/backup.create
backup-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
schedule
Requiredstring
enabled
boolean | null
prefix
Requiredstring
Minimum length: 1
destinationId
Requiredstring
database
Requiredstring
Minimum length: 1
mariadbId
string | null
mysqlId
string | null
postgresId
string | null
mongoId
string | null
databaseType
Requiredstring
Value in: "postgres" | "mariadb" | "mysql" | "mongo"
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/backup.one
backup-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
backupId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/backup.update
backup-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
schedule
Requiredstring
enabled
boolean | null
prefix
Requiredstring
Minimum length: 1
backupId
Requiredstring
destinationId
Requiredstring
database
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/backup.remove
backup-remove
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
backupId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/backup.manualBackupPostgres
backup-manualBackupPostgres
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
backupId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/backup.manualBackupMySql
backup-manualBackupMySql
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
backupId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/backup.manualBackupMariadb
backup-manualBackupMariadb
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
backupId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/backup.manualBackupMongo
backup-manualBackupMongo
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
backupId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/deployment.all
deployment-all
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
applicationId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/deployment.allByCompose
deployment-allByCompose
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mounts.create
mounts-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
type
Requiredstring
Value in: "bind" | "volume" | "file"
hostPath
string | null
volumeName
string | null
content
string | null
mountPath
Requiredstring
Minimum length: 1
serviceType
string
Default: "application"
Value in: "application" | "postgres" | "mysql" | "mariadb" | "mongo" | "redis" | "compose"
serviceId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mounts.remove
mounts-remove
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mountId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/mounts.one
mounts-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
mountId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/mounts.update
mounts-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
mountId
Requiredstring
Minimum length: 1
type
string
Value in: "bind" | "volume" | "file"
hostPath
string | null
volumeName
string | null
content
string | null
serviceType
string
Default: "application"
Value in: "application" | "postgres" | "mysql" | "mariadb" | "mongo" | "redis" | "compose"
mountPath
string
Minimum length: 1
applicationId
string | null
postgresId
string | null
mariadbId
string | null
mongoId
string | null
mysqlId
string | null
redisId
string | null
composeId
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/certificates.create
certificates-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
certificateId
string
name
Requiredstring
Minimum length: 1
certificateData
Requiredstring
Minimum length: 1
privateKey
Requiredstring
Minimum length: 1
certificatePath
string
autoRenew
boolean | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/certificates.one
certificates-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
certificateId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/certificates.remove
certificates-remove
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
certificateId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/certificates.all
certificates-all
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.reloadServer
settings-reloadServer
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.reloadTraefik
settings-reloadTraefik
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.cleanUnusedImages
settings-cleanUnusedImages
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.cleanUnusedVolumes
settings-cleanUnusedVolumes
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.cleanStoppedContainers
settings-cleanStoppedContainers
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.cleanDockerBuilder
settings-cleanDockerBuilder
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.cleanDockerPrune
settings-cleanDockerPrune
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.cleanAll
settings-cleanAll
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.cleanMonitoring
settings-cleanMonitoring
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.saveSSHPrivateKey
settings-saveSSHPrivateKey
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
sshPrivateKey
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.assignDomainServer
settings-assignDomainServer
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
letsEncryptEmail
Requiredstring | null
host
Requiredstring | null
certificateType
string
Default: "none"
Value in: "letsencrypt" | "none"
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.cleanSSHPrivateKey
settings-cleanSSHPrivateKey
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.updateDockerCleanup
settings-updateDockerCleanup
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
enableDockerCleanup
Requiredboolean
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.readTraefikConfig
settings-readTraefikConfig
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.updateTraefikConfig
settings-updateTraefikConfig
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
traefikConfig
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.readWebServerTraefikConfig
settings-readWebServerTraefikConfig
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.updateWebServerTraefikConfig
settings-updateWebServerTraefikConfig
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
traefikConfig
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.readMiddlewareTraefikConfig
settings-readMiddlewareTraefikConfig
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.updateMiddlewareTraefikConfig
settings-updateMiddlewareTraefikConfig
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
traefikConfig
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.checkAndUpdateImage
settings-checkAndUpdateImage
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.updateServer
settings-updateServer
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.getDokployVersion
settings-getDokployVersion
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.readDirectories
settings-readDirectories
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/settings.updateTraefikFile
settings-updateTraefikFile
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
path
Requiredstring
Minimum length: 1
traefikConfig
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.readTraefikFile
settings-readTraefikFile
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
path
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/settings.getOpenApiDocument
settings-getOpenApiDocument
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/security.create
security-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
applicationId
Requiredstring
username
Requiredstring
Minimum length: 1
password
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/security.one
security-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
securityId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/security.delete
security-delete
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
securityId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/security.update
security-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
securityId
Requiredstring
Minimum length: 1
username
Requiredstring
Minimum length: 1
password
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/redirects.create
redirects-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
regex
Requiredstring
Minimum length: 1
replacement
Requiredstring
Minimum length: 1
permanent
Requiredboolean
applicationId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/redirects.one
redirects-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
redirectId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/redirects.delete
redirects-delete
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
redirectId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/redirects.update
redirects-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
redirectId
Requiredstring
Minimum length: 1
regex
Requiredstring
Minimum length: 1
replacement
Requiredstring
Minimum length: 1
permanent
Requiredboolean
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/port.create
port-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
publishedPort
Requirednumber
targetPort
Requirednumber
protocol
string
Default: "tcp"
Value in: "tcp" | "udp"
applicationId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/port.one
port-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
portId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/port.delete
port-delete
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
portId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/port.update
port-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
portId
Requiredstring
Minimum length: 1
publishedPort
Requirednumber
targetPort
Requirednumber
protocol
string
Default: "tcp"
Value in: "tcp" | "udp"
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/registry.create
registry-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
registryName
Requiredstring
Minimum length: 1
username
Requiredstring
Minimum length: 1
password
Requiredstring
Minimum length: 1
registryUrl
Requiredstring
registryType
Requiredstring
Value in: "selfHosted" | "cloud"
imagePrefix
Requiredstring | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/registry.remove
registry-remove
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
registryId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/registry.update
registry-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
registryId
Requiredstring
Minimum length: 1
registryName
string
Minimum length: 1
imagePrefix
string | null
username
string
Minimum length: 1
password
string
Minimum length: 1
registryUrl
string
Minimum length: 1
createdAt
string
registryType
string
Value in: "selfHosted" | "cloud"
adminId
string
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/registry.all
registry-all
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/registry.one
registry-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
registryId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/registry.testRegistry
registry-testRegistry
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
registryName
Requiredstring
Minimum length: 1
username
Requiredstring
Minimum length: 1
password
Requiredstring
Minimum length: 1
registryUrl
Requiredstring
registryType
Requiredstring
Value in: "selfHosted" | "cloud"
imagePrefix
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/registry.enableSelfHostedRegistry
registry-enableSelfHostedRegistry
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
registryUrl
Requiredstring
Minimum length: 1
username
Requiredstring
Minimum length: 1
password
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/cluster.getNodes
cluster-getNodes
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/cluster.removeWorker
cluster-removeWorker
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
nodeId
Requiredstring
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/cluster.addWorker
cluster-addWorker
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/cluster.addManager
cluster-addManager
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |