Dokploy
Generated

Project

POST
/project.create

Project create

/project.create

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

name
Required
string

Minimum length: 1

descriptionstring | null

envstring

curl -X POST "https://your-dokploy-instance.com/api/project.create" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "env": "string"
  }'

Successful response

{}

GET
/project.one

Project one

/project.one

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

projectId
Required
string

Minimum length: 1
curl -X GET "https://your-dokploy-instance.com/api/project.one?projectId=string" \
  -H "Authorization: <token>"

Successful response

{}

GET
/project.all

Project all

/project.all

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

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

Successful response

{}

POST
/project.remove

Project remove

/project.remove

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

projectId
Required
string

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

Successful response

{}

POST
/project.update

Project update

/project.update

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

projectId
Required
string

Minimum length: 1

namestring

Minimum length: 1

descriptionstring | null

createdAtstring

organizationIdstring

envstring

curl -X POST "https://your-dokploy-instance.com/api/project.update" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "string",
    "name": "string",
    "description": "string",
    "createdAt": "string",
    "organizationId": "string",
    "env": "string"
  }'

Successful response

{}

POST
/project.duplicate

Project duplicate

/project.duplicate

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

sourceEnvironmentId
Required
string

name
Required
string

descriptionstring

includeServicesboolean

Default: true

selectedServicesarray<object>

duplicateInSameProjectboolean

Default: false
curl -X POST "https://your-dokploy-instance.com/api/project.duplicate" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "sourceEnvironmentId": "string",
    "name": "string",
    "description": "string",
    "includeServices": true,
    "selectedServices": [
      {
        "id": "string",
        "type": "application"
      }
    ],
    "duplicateInSameProject": false
  }'

Successful response

{}

Previous

Preview Deployment

Next

Redirects