User

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/user.all"

curl -X GET "https://your-dokploy-instance.com/api/user.all"

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

userId*string

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/user.one?userId=string"

curl -X GET "https://your-dokploy-instance.com/api/user.one?userId=string"

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/user.get"

curl -X GET "https://your-dokploy-instance.com/api/user.get"

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/user.haveRootAccess"

curl -X GET "https://your-dokploy-instance.com/api/user.haveRootAccess"

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/user.getBackups"

curl -X GET "https://your-dokploy-instance.com/api/user.getBackups"

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/user.getServerMetrics"

curl -X GET "https://your-dokploy-instance.com/api/user.getServerMetrics"

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

id?string

Length1 <= length

firstName?string

lastName?string

isRegistered?boolean

expirationDate?string

createdAt2?string

createdAt?string|null

Formatdate-time

twoFactorEnabled?boolean|null

email?string

Formatemail

Length1 <= length

emailVerified?boolean

image?string|null

banned?boolean|null

banReason?string|null

banExpires?string|null

Formatdate-time

updatedAt?string

Formatdate-time

serverIp?string|null

certificateType?string

Value in"letsencrypt" | "none" | "custom"

https?boolean

host?string|null

letsEncryptEmail?string|null

sshPrivateKey?string|null

enableDockerCleanup?boolean

logCleanupCron?string|null

enablePaidFeatures?boolean

allowImpersonation?boolean

metricsConfig?

cleanupCacheApplications?boolean

cleanupCacheOnPreviews?boolean

cleanupCacheOnCompose?boolean

stripeCustomerId?string|null

stripeSubscriptionId?string|null

serversQuantity?number

password?string

currentPassword?string

name?string

[key: string]?never

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/user.update" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://your-dokploy-instance.com/api/user.update" \  -H "Content-Type: application/json" \  -d '{}'

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

token*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/user.getUserByToken?token=string"

curl -X GET "https://your-dokploy-instance.com/api/user.getUserByToken?token=string"

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/user.getMetricsToken"

curl -X GET "https://your-dokploy-instance.com/api/user.getMetricsToken"

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

userId*string

[key: string]?never

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/user.remove" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "string"
  }'

curl -X POST "https://your-dokploy-instance.com/api/user.remove" \  -H "Content-Type: application/json" \  -d '{    "userId": "string"  }'

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

id*string

Length1 <= length

accessedProjects*array<string>

accessedEnvironments*array<string>

accessedServices*array<string>

canCreateProjects*boolean

canCreateServices*boolean

canDeleteProjects*boolean

canDeleteServices*boolean

canAccessToDocker*boolean

canAccessToTraefikFiles*boolean

canAccessToAPI*boolean

canAccessToSSHKeys*boolean

canAccessToGitProviders*boolean

canDeleteEnvironments*boolean

canCreateEnvironments*boolean

[key: string]?never

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/user.assignPermissions" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "accessedProjects": [
      "string"
    ],
    "accessedEnvironments": [
      "string"
    ],
    "accessedServices": [
      "string"
    ],
    "canCreateProjects": true,
    "canCreateServices": true,
    "canDeleteProjects": true,
    "canDeleteServices": true,
    "canAccessToDocker": true,
    "canAccessToTraefikFiles": true,
    "canAccessToAPI": true,
    "canAccessToSSHKeys": true,
    "canAccessToGitProviders": true,
    "canDeleteEnvironments": true,
    "canCreateEnvironments": true
  }'

curl -X POST "https://your-dokploy-instance.com/api/user.assignPermissions" \  -H "Content-Type: application/json" \  -d '{    "id": "string",    "accessedProjects": [      "string"    ],    "accessedEnvironments": [      "string"    ],    "accessedServices": [      "string"    ],    "canCreateProjects": true,    "canCreateServices": true,    "canDeleteProjects": true,    "canDeleteServices": true,    "canAccessToDocker": true,    "canAccessToTraefikFiles": true,    "canAccessToAPI": true,    "canAccessToSSHKeys": true,    "canAccessToGitProviders": true,    "canDeleteEnvironments": true,    "canCreateEnvironments": true  }'

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/user.getInvitations"

curl -X GET "https://your-dokploy-instance.com/api/user.getInvitations"

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

url*string

token*string

appName*string

dataPoints*string

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/user.getContainerMetrics?url=string&token=string&appName=string&dataPoints=string"

curl -X GET "https://your-dokploy-instance.com/api/user.getContainerMetrics?url=string&token=string&appName=string&dataPoints=string"

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/user.generateToken"

curl -X POST "https://your-dokploy-instance.com/api/user.generateToken"

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

apiKeyId*string

[key: string]?never

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/user.deleteApiKey" \
  -H "Content-Type: application/json" \
  -d '{
    "apiKeyId": "string"
  }'

curl -X POST "https://your-dokploy-instance.com/api/user.deleteApiKey" \  -H "Content-Type: application/json" \  -d '{    "apiKeyId": "string"  }'

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

name*string

Length1 <= length

prefix?string

expiresIn?number

metadata*

rateLimitEnabled?boolean

rateLimitTimeWindow?number

rateLimitMax?number

remaining?number

refillAmount?number

refillInterval?number

[key: string]?never

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/user.createApiKey" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "metadata": {
      "organizationId": "string"
    }
  }'

curl -X POST "https://your-dokploy-instance.com/api/user.createApiKey" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "metadata": {      "organizationId": "string"    }  }'

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

userId*string

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/user.checkUserOrganizations?userId=string"

curl -X GET "https://your-dokploy-instance.com/api/user.checkUserOrganizations?userId=string"

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

invitationId*string

Length1 <= length

notificationId*string

Length1 <= length

[key: string]?never

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/user.sendInvitation" \
  -H "Content-Type: application/json" \
  -d '{
    "invitationId": "string",
    "notificationId": "string"
  }'

curl -X POST "https://your-dokploy-instance.com/api/user.sendInvitation" \  -H "Content-Type: application/json" \  -d '{    "invitationId": "string",    "notificationId": "string"  }'

{}

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`