Dokploy

Admin

GET
/admin.one

Admin one

/admin.one

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

curl -X GET "http://your-dokploy-instance.com/api/admin.one" \
  -H "Authorization: Bearer <token>"

Successful response

POST
/admin.createUserInvitation

Admin create User Invitation

/admin.createUserInvitation

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

email
Required
string

Format: "email"
curl -X POST "http://your-dokploy-instance.com/api/admin.createUserInvitation" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]"
  }'

Successful response

POST
/admin.removeUser

Admin remove User

/admin.removeUser

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

authId
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/admin.removeUser" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "authId": "string"
  }'

Successful response

GET
/admin.getUserByToken

Admin get User By Token

/admin.getUserByToken

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

token
Required
string

Minimum length: 1
curl -X GET "http://your-dokploy-instance.com/api/admin.getUserByToken?token=string" \
  -H "Authorization: Bearer <token>"

Successful response

POST
/admin.assignPermissions

Admin assign Permissions

/admin.assignPermissions

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

userId
Required
string

Minimum length: 1

canCreateProjects
Required
boolean

canCreateServices
Required
boolean

canDeleteProjects
Required
boolean

canDeleteServices
Required
boolean

accesedProjects
Required
array<string>

accesedServices
Required
array<string>

canAccessToTraefikFiles
Required
boolean

canAccessToDocker
Required
boolean

canAccessToAPI
Required
boolean

canAccessToSSHKeys
Required
boolean

canAccessToGitProviders
Required
boolean

curl -X POST "http://your-dokploy-instance.com/api/admin.assignPermissions" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "string",
    "canCreateProjects": true,
    "canCreateServices": true,
    "canDeleteProjects": true,
    "canDeleteServices": true,
    "accesedProjects": [
      "string"
    ],
    "accesedServices": [
      "string"
    ],
    "canAccessToTraefikFiles": true,
    "canAccessToDocker": true,
    "canAccessToAPI": true,
    "canAccessToSSHKeys": true,
    "canAccessToGitProviders": true
  }'

Successful response