Dokploy
Generated

Environment

POST
/environment.create

Environment create

/environment.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

projectId
Required
string

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

Successful response

{}

GET
/environment.one

Environment one

/environment.one

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

environmentId
Required
string

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

Successful response

{}

GET
/environment.byProjectId

Environment by Project Id

/environment.byProjectId

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

projectId
Required
string

curl -X GET "https://your-dokploy-instance.com/api/environment.byProjectId?projectId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST
/environment.remove

Environment remove

/environment.remove

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

environmentId
Required
string

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

Successful response

{}

POST
/environment.update

Environment update

/environment.update

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

environmentId
Required
string

Minimum length: 1

namestring

Minimum length: 1

descriptionstring | null

createdAtstring

envstring

projectIdstring

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

Successful response

{}

POST
/environment.duplicate

Environment duplicate

/environment.duplicate

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

environmentId
Required
string

Minimum length: 1

name
Required
string

Minimum length: 1

descriptionstring | null

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

Successful response

{}

Previous

Domain

Next

Gitea