User

GET

/user.all

User all

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/user.all" \
  -H "Authorization: <token>"

Successful response

{}

GET

/user.one

User one

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`userId`
Required
string

curl -X GET "https://your-dokploy-instance.com/api/user.one?userId=string" \
  -H "Authorization: <token>"

Successful response

{}

GET

/user.get

User get

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/user.get" \
  -H "Authorization: <token>"

Successful response

{}

GET

/user.haveRootAccess

User have Root Access

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/user.haveRootAccess" \
  -H "Authorization: <token>"

Successful response

{}

GET

/user.getBackups

User get Backups

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/user.getBackups" \
  -H "Authorization: <token>"

Successful response

{}

GET

/user.getServerMetrics

User get Server Metrics

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/user.getServerMetrics" \
  -H "Authorization: <token>"

Successful response

{}

POST

/user.update

User update

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`id`string

Minimum length: 1

`name`string

`isRegistered`boolean

`expirationDate`string

`createdAt2`string

`createdAt`string | null

Format: "date-time"

`twoFactorEnabled`boolean | null

`email`string

Minimum length: 1Format: "email"

`emailVerified`boolean

`image`string | null

`banned`boolean | null

`banReason`string | null

`banExpires`string | null

Format: "date-time"

`updatedAt`string

Format: "date-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`object

`cleanupCacheApplications`boolean

`cleanupCacheOnPreviews`boolean

`cleanupCacheOnCompose`boolean

`stripeCustomerId`string | null

`stripeSubscriptionId`string | null

`serversQuantity`number

`password`string

`currentPassword`string

curl -X POST "https://your-dokploy-instance.com/api/user.update" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "name": "string",
    "isRegistered": true,
    "expirationDate": "string",
    "createdAt2": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "twoFactorEnabled": true,
    "email": "[email protected]",
    "emailVerified": true,
    "image": "string",
    "banned": true,
    "banReason": "string",
    "banExpires": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "serverIp": "string",
    "certificateType": "letsencrypt",
    "https": true,
    "host": "string",
    "letsEncryptEmail": "string",
    "sshPrivateKey": "string",
    "enableDockerCleanup": true,
    "logCleanupCron": "string",
    "enablePaidFeatures": true,
    "allowImpersonation": true,
    "metricsConfig": {
      "server": {
        "type": "Dokploy",
        "refreshRate": 0,
        "port": 0,
        "token": "string",
        "urlCallback": "string",
        "retentionDays": 0,
        "cronJob": "string",
        "thresholds": {
          "cpu": 0,
          "memory": 0
        }
      },
      "containers": {
        "refreshRate": 0,
        "services": {
          "include": [
            "string"
          ],
          "exclude": [
            "string"
          ]
        }
      }
    },
    "cleanupCacheApplications": true,
    "cleanupCacheOnPreviews": true,
    "cleanupCacheOnCompose": true,
    "stripeCustomerId": "string",
    "stripeSubscriptionId": "string",
    "serversQuantity": 0,
    "password": "string",
    "currentPassword": "string"
  }'

Successful response

{}

GET

/user.getUserByToken

User get User By Token

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`token`
Required
string

Minimum length: 1

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

Successful response

{}

GET

/user.getMetricsToken

User get Metrics Token

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/user.getMetricsToken" \
  -H "Authorization: <token>"

Successful response

{}

POST

/user.remove

User remove

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`userId`
Required
string

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

Successful response

{}

POST

/user.assignPermissions

User assign Permissions

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`id`
Required
string

Minimum length: 1

`accessedProjects`
Required
array<string>

`accessedEnvironments`
Required
array<string>

`accessedServices`
Required
array<string>

`canCreateProjects`
Required
boolean

`canCreateServices`
Required
boolean

`canDeleteProjects`
Required
boolean

`canDeleteServices`
Required
boolean

`canAccessToDocker`
Required
boolean

`canAccessToTraefikFiles`
Required
boolean

`canAccessToAPI`
Required
boolean

`canAccessToSSHKeys`
Required
boolean

`canAccessToGitProviders`
Required
boolean

`canDeleteEnvironments`
Required
boolean

`canCreateEnvironments`
Required
boolean

curl -X POST "https://your-dokploy-instance.com/api/user.assignPermissions" \
  -H "Authorization: <token>" \
  -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
  }'

Successful response

{}

GET

/user.getInvitations

User get Invitations

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/user.getInvitations" \
  -H "Authorization: <token>"

Successful response

{}

GET

/user.getContainerMetrics

User get Container Metrics

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`url`
Required
string

`token`
Required
string

`appName`
Required
string

`dataPoints`
Required
string

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

Successful response

{}

POST

/user.generateToken

User generate Token

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

curl -X POST "https://your-dokploy-instance.com/api/user.generateToken" \
  -H "Authorization: <token>"

Successful response

{}

POST

/user.deleteApiKey

User delete Api Key

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`apiKeyId`
Required
string

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

Successful response

{}

POST

/user.createApiKey

User create Api Key

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`name`
Required
string

Minimum length: 1

`prefix`string

`expiresIn`number

`metadata`
Required
object

`rateLimitEnabled`boolean

`rateLimitTimeWindow`number

`rateLimitMax`number

`remaining`number

`refillAmount`number

`refillInterval`number

curl -X POST "https://your-dokploy-instance.com/api/user.createApiKey" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "prefix": "string",
    "expiresIn": 0,
    "metadata": {
      "organizationId": "string"
    },
    "rateLimitEnabled": true,
    "rateLimitTimeWindow": 0,
    "rateLimitMax": 0,
    "remaining": 0,
    "refillAmount": 0,
    "refillInterval": 0
  }'

Successful response

{}

GET

/user.checkUserOrganizations

User check User Organizations

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`userId`
Required
string

curl -X GET "https://your-dokploy-instance.com/api/user.checkUserOrganizations?userId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST

/user.sendInvitation

User send Invitation

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`invitationId`
Required
string

Minimum length: 1

`notificationId`
Required
string

Minimum length: 1

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

Successful response

{}

Authorization<token>

Response

TypeScript

Query

Authorization<token>

userIdRequiredstring

Response

TypeScript

Authorization<token>

Response

TypeScript

Authorization<token>

Response

TypeScript

Authorization<token>

Response

TypeScript

Authorization<token>

Response

TypeScript

Body

Authorization<token>

idstring

namestring

isRegisteredboolean

expirationDatestring

createdAt2string

createdAtstring | null

twoFactorEnabledboolean | null

emailstring

emailVerifiedboolean

imagestring | null

bannedboolean | null

banReasonstring | null

banExpiresstring | null

updatedAtstring

serverIpstring | null

certificateTypestring

httpsboolean

hoststring | null

letsEncryptEmailstring | null

sshPrivateKeystring | null

enableDockerCleanupboolean

logCleanupCronstring | null

enablePaidFeaturesboolean

allowImpersonationboolean

metricsConfigobject

Attributes

cleanupCacheApplicationsboolean

cleanupCacheOnPreviewsboolean

cleanupCacheOnComposeboolean

stripeCustomerIdstring | null

stripeSubscriptionIdstring | null

serversQuantitynumber

passwordstring

currentPasswordstring

Response

TypeScript

Query

Authorization<token>

tokenRequiredstring

Response

TypeScript

Authorization<token>

Response

TypeScript

Body

Authorization<token>

userIdRequiredstring

Response

TypeScript

Body

Authorization<token>

idRequiredstring

accessedProjectsRequiredarray<string>

accessedEnvironmentsRequiredarray<string>

accessedServicesRequiredarray<string>

canCreateProjectsRequiredboolean

canCreateServicesRequiredboolean

`Authorization`<token>

`Authorization`<token>

`userId`
Required
string

`Authorization`<token>

`Authorization`<token>

`Authorization`<token>

`Authorization`<token>

`Authorization`<token>

`id`string

`name`string

`isRegistered`boolean

`expirationDate`string

`createdAt2`string

`createdAt`string | null

`twoFactorEnabled`boolean | null

`email`string

`emailVerified`boolean

`image`string | null

`banned`boolean | null

`banReason`string | null

`banExpires`string | null

`updatedAt`string

`serverIp`string | null

`certificateType`string

`https`boolean

`host`string | null

`letsEncryptEmail`string | null

`sshPrivateKey`string | null

`enableDockerCleanup`boolean

`logCleanupCron`string | null

`enablePaidFeatures`boolean

`allowImpersonation`boolean

`metricsConfig`object

`cleanupCacheApplications`boolean

`cleanupCacheOnPreviews`boolean

`cleanupCacheOnCompose`boolean

`stripeCustomerId`string | null

`stripeSubscriptionId`string | null

`serversQuantity`number

`password`string

`currentPassword`string

`Authorization`<token>

`token`
Required
string

`Authorization`<token>

`Authorization`<token>

`userId`
Required
string

`Authorization`<token>

`id`
Required
string

`accessedProjects`
Required
array<string>

`accessedEnvironments`
Required
array<string>

`accessedServices`
Required
array<string>

`canCreateProjects`
Required
boolean

`canCreateServices`
Required
boolean

`canDeleteProjects`
Required
boolean

`canDeleteServices`
Required
boolean

`canAccessToDocker`
Required
boolean

`canAccessToTraefikFiles`
Required
boolean

`canAccessToAPI`
Required
boolean

`canAccessToSSHKeys`
Required
boolean

`canAccessToGitProviders`
Required
boolean

`canDeleteEnvironments`
Required
boolean

`canCreateEnvironments`
Required
boolean

`Authorization`<token>

`Authorization`<token>

`url`
Required
string

`token`
Required
string

`appName`
Required
string

`dataPoints`
Required
string

`Authorization`<token>

`Authorization`<token>

`apiKeyId`
Required
string