Dokploy

project

POST/project.create

project-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

descriptionstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/project.create" \
  -d '{
  "name": "string",
  "description": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/project.one

project-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

projectId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/project.one?projectId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/project.all

project-all

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/project.all"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/project.remove

project-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

projectId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/project.remove" \
  -d '{
  "projectId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/project.update

project-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

descriptionstring | null

projectId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/project.update" \
  -d '{
  "name": "string",
  "description": "string",
  "projectId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Previous

postgres

Next

redirects

On this page

project-createAuthorizationRequest Bodyproject-oneAuthorizationQuery Parametersproject-allAuthorizationproject-removeAuthorizationRequest Bodyproject-updateAuthorizationRequest Body