Dokploy

Server

POST
/server.create

Server create

/server.create

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

name
Required
string

Minimum length: 1

descriptionstring | null

ipAddress
Required
string

port
Required
number

username
Required
string

sshKeyId
Required
string | null

curl -X POST "http://your-dokploy-instance.com/api/server.create" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "ipAddress": "string",
    "port": 0,
    "username": "string",
    "sshKeyId": "string"
  }'

Successful response

GET
/server.one

Server one

/server.one

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

serverId
Required
string

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

Successful response

GET
/server.all

Server all

/server.all

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

GET
/server.withSSHKey

Server with S S H Key

/server.withSSHKey

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

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

Successful response

POST
/server.setup

Server setup

/server.setup

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

serverId
Required
string

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

Successful response

POST
/server.remove

Server remove

/server.remove

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

serverId
Required
string

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

Successful response

POST
/server.update

Server update

/server.update

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

name
Required
string

Minimum length: 1

descriptionstring | null

serverId
Required
string

Minimum length: 1

ipAddress
Required
string

port
Required
number

username
Required
string

sshKeyId
Required
string | null

curl -X POST "http://your-dokploy-instance.com/api/server.update" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "serverId": "string",
    "ipAddress": "string",
    "port": 0,
    "username": "string",
    "sshKeyId": "string"
  }'

Successful response

Previous

Security

Next

Settings