Dokploy
Generated

Auth

POST
/auth.createAdmin

Auth create Admin

/auth.createAdmin

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

email
Required
string

Format: "email"

password
Required
string

Minimum length: 8
curl -X POST "http://your-dokploy-instance.com/api/auth.createAdmin" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "stringst"
  }'

Successful response

POST
/auth.createUser

Auth create User

/auth.createUser

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

password
Required
string

Minimum length: 8

id
Required
string

token
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/auth.createUser" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "password": "stringst",
    "id": "string",
    "token": "string"
  }'

Successful response

POST
/auth.login

Auth login

/auth.login

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

email
Required
string

Format: "email"

password
Required
string

Minimum length: 8
curl -X POST "http://your-dokploy-instance.com/api/auth.login" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "stringst"
  }'

Successful response

GET
/auth.get

Auth get

/auth.get

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

POST
/auth.logout

Auth logout

/auth.logout

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

curl -X POST "http://your-dokploy-instance.com/api/auth.logout" \
  -H "Authorization: Bearer <token>"

Successful response

POST
/auth.update

Auth update

/auth.update

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

idstring

email
Required
string | null

password
Required
string | null

rolstring

Value in: "admin" | "user"

imagestring

secretstring | null

tokenstring | null

is2FAEnabledboolean

createdAtstring

resetPasswordTokenstring | null

resetPasswordExpiresAtstring | null

confirmationTokenstring | null

confirmationExpiresAtstring | null

curl -X POST "http://your-dokploy-instance.com/api/auth.update" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "email": "string",
    "password": "string",
    "rol": "admin",
    "image": "string",
    "secret": "string",
    "token": "string",
    "is2FAEnabled": true,
    "createdAt": "string",
    "resetPasswordToken": "string",
    "resetPasswordExpiresAt": "string",
    "confirmationToken": "string",
    "confirmationExpiresAt": "string"
  }'

Successful response

POST
/auth.generateToken

Auth generate Token

/auth.generateToken

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

GET
/auth.one

Auth one

/auth.one

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

id
Required
string

curl -X GET "http://your-dokploy-instance.com/api/auth.one?id=string" \
  -H "Authorization: Bearer <token>"

Successful response

GET
/auth.generate2FASecret

Auth generate2 F A Secret

/auth.generate2FASecret

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

POST
/auth.verify2FASetup

Auth verify2 F A Setup

/auth.verify2FASetup

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

pin
Required
string

Minimum length: 6

secret
Required
string

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

Successful response

POST
/auth.verifyLogin2FA

Auth verify Login2 F A

/auth.verifyLogin2FA

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

pin
Required
string

Minimum length: 6

id
Required
string

curl -X POST "http://your-dokploy-instance.com/api/auth.verifyLogin2FA" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "pin": "string",
    "id": "string"
  }'

Successful response

POST
/auth.disable2FA

Auth disable2 F A

/auth.disable2FA

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

curl -X POST "http://your-dokploy-instance.com/api/auth.disable2FA" \
  -H "Authorization: Bearer <token>"

Successful response

POST
/auth.sendResetPasswordEmail

Auth send Reset Password Email

/auth.sendResetPasswordEmail

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

email
Required
string

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

Successful response

POST
/auth.resetPassword

Auth reset Password

/auth.resetPassword

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

resetPasswordToken
Required
string

Minimum length: 1

password
Required
string

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

Successful response

POST
/auth.confirmEmail

Auth confirm Email

/auth.confirmEmail

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

confirmationToken
Required
string

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

Successful response

Previous

Application

Next

Backup