Project

Project create

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

name*string

Length1 <= length

description?string|null

env?string

Response Body

`application/json`

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

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

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Project one

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

projectId*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/project.one?projectId=string"

curl -X GET "https://your-dokploy-instance.com/api/project.one?projectId=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Project all

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/project.all"

curl -X GET "https://your-dokploy-instance.com/api/project.all"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Project all For Permissions

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/project.allForPermissions"

curl -X GET "https://your-dokploy-instance.com/api/project.allForPermissions"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Project search

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

q?string

name?string

description?string

limit?number

Default20

Range1 <= value <= 100

offset?number

Default0

Range0 <= value

Response Body

`application/json`

curl -X GET "https://your-dokploy-instance.com/api/project.search"

curl -X GET "https://your-dokploy-instance.com/api/project.search"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Project remove

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

projectId*string

Length1 <= length

Response Body

`application/json`

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

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

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Project update

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

projectId*string

Length1 <= length

name?string

Length1 <= length

description?string|null

createdAt?string

organizationId?string

env?string

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/project.update" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "string"
  }'

curl -X POST "https://your-dokploy-instance.com/api/project.update" \  -H "Content-Type: application/json" \  -d '{    "projectId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Project duplicate

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

sourceEnvironmentId*string

name*string

description?string

includeServices?boolean

Defaulttrue

selectedServices?

duplicateInSameProject?boolean

Defaultfalse

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/project.duplicate" \
  -H "Content-Type: application/json" \
  -d '{
    "sourceEnvironmentId": "string",
    "name": "string"
  }'

curl -X POST "https://your-dokploy-instance.com/api/project.duplicate" \  -H "Content-Type: application/json" \  -d '{    "sourceEnvironmentId": "string",    "name": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`