/
DO
dokploy
/
Dokploy API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 11h ago · Updated 2w ago
Details
Filter operations
admin
1
ai
14
application
31
auditLog
1
backup
12
bitbucket
7
certificates
5
cluster
4
compose
31
customRole
6
deployment
9
destination
6
dnsProvider
11
docker
18
dockerDiskUsage
3
dockerImage
3
dockerVolume
8
domain
10
environment
7
forwardAuth
10
gitea
8
github
6
gitlab
7
gitProvider
4
libsql
14
licenseKey
6
mariadb
16
mongo
16
mounts
6
mysql
16
network
8
notification
41
organization
11
overview
3
patch
12
port
4
postgres
16
previewDeployment
4
project
9
redirects
4
redis
16
registry
7
rollback
2
schedule
6
scim
3
security
4
server
18
settings
52
sshKey
7
sso
11
stripe
8
swarm
4
tag
8
user
26
get
/user.all
get
/user.one
get
/user.session
get
/user.get
get
/user.getPermissions
get
/user.listPasskeys
get
/user.haveRootAccess
get
/user.getBackups
get
/user.getServerMetrics
post
/user.update
get
/user.listSessions
post
/user.revokeSession
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
vaultProvider
7
volumeBackups
6
whitelabeling
4
user
post
/user.createApiKey
Request body
object
required
name
string
required
prefix
string
expiresIn
number
metadata
object
required
rateLimitEnabled
boolean
rateLimitTimeWindow
number
rateLimitMax
number
remaining
number
refillAmount
number
refillInterval
number
Response
Successful response
object
required
Changes