Mongo

Mongo 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

appName?string

Match^[a-zA-Z0-9._-]+$

Length1 <= length <= 63

dockerImage?string

Default"mongo:15"

environmentId*string

description?string|null

databaseUser*string

Length1 <= length

databasePassword*string

Match^[a-zA-Z0-9@#%^&*()_+\-=[\]{}|;:,.<>?~`]*$

serverId?string|null

replicaSets?boolean|null

Response Body

`application/json`

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

curl -X POST "https://your-dokploy-instance.com/api/mongo.create" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "environmentId": "string",    "databaseUser": "string",    "databasePassword": "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": []
}

Mongo one

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

mongoId*string

Length1 <= length

Response Body

`application/json`

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

curl -X GET "https://your-dokploy-instance.com/api/mongo.one?mongoId=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": []
}

Mongo start

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mongoId*string

Length1 <= length

Response Body

`application/json`

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

curl -X POST "https://your-dokploy-instance.com/api/mongo.start" \  -H "Content-Type: application/json" \  -d '{    "mongoId": "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": []
}

Mongo stop

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mongoId*string

Length1 <= length

Response Body

`application/json`

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

curl -X POST "https://your-dokploy-instance.com/api/mongo.stop" \  -H "Content-Type: application/json" \  -d '{    "mongoId": "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": []
}

Mongo save External Port

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mongoId*string

externalPort*number|null

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/mongo.saveExternalPort" \
  -H "Content-Type: application/json" \
  -d '{
    "mongoId": "string",
    "externalPort": 0
  }'

curl -X POST "https://your-dokploy-instance.com/api/mongo.saveExternalPort" \  -H "Content-Type: application/json" \  -d '{    "mongoId": "string",    "externalPort": 0  }'

{}

{
  "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": []
}

Mongo deploy

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mongoId*string

Response Body

`application/json`

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

curl -X POST "https://your-dokploy-instance.com/api/mongo.deploy" \  -H "Content-Type: application/json" \  -d '{    "mongoId": "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": []
}

Mongo change Status

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mongoId*string

applicationStatus*string

Value in"idle" | "running" | "done" | "error"

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/mongo.changeStatus" \
  -H "Content-Type: application/json" \
  -d '{
    "mongoId": "string",
    "applicationStatus": "idle"
  }'

curl -X POST "https://your-dokploy-instance.com/api/mongo.changeStatus" \  -H "Content-Type: application/json" \  -d '{    "mongoId": "string",    "applicationStatus": "idle"  }'

{}

{
  "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": []
}

Mongo reload

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mongoId*string

appName*string

Match^[a-zA-Z0-9._-]+$

Length1 <= length <= 63

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/mongo.reload" \
  -H "Content-Type: application/json" \
  -d '{
    "mongoId": "string",
    "appName": "string"
  }'

curl -X POST "https://your-dokploy-instance.com/api/mongo.reload" \  -H "Content-Type: application/json" \  -d '{    "mongoId": "string",    "appName": "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": []
}

Mongo remove

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mongoId*string

Length1 <= length

Response Body

`application/json`

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

curl -X POST "https://your-dokploy-instance.com/api/mongo.remove" \  -H "Content-Type: application/json" \  -d '{    "mongoId": "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": []
}

Mongo save Environment

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mongoId*string

env*string|null

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/mongo.saveEnvironment" \
  -H "Content-Type: application/json" \
  -d '{
    "mongoId": "string",
    "env": "string"
  }'

curl -X POST "https://your-dokploy-instance.com/api/mongo.saveEnvironment" \  -H "Content-Type: application/json" \  -d '{    "mongoId": "string",    "env": "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": []
}

Mongo update

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mongoId*string

Length1 <= length

name?string

Length1 <= length

appName?string

Match^[a-zA-Z0-9._-]+$

Length1 <= length <= 63

description?string|null

databaseUser?string

Length1 <= length

databasePassword?string

Match^[a-zA-Z0-9@#%^&*()_+\-=[\]{}|;:,.<>?~`]*$

dockerImage?string

Default"mongo:15"

command?string|null

args?|null

env?string|null

memoryReservation?string|null

memoryLimit?string|null

cpuReservation?string|null

cpuLimit?string|null

externalPort?number|null

applicationStatus?string

Value in"idle" | "running" | "done" | "error"

healthCheckSwarm?|null

restartPolicySwarm?|null

placementSwarm?|null

updateConfigSwarm?|null

rollbackConfigSwarm?|null

modeSwarm?|null

labelsSwarm?|null

networkSwarm?|null

stopGracePeriodSwarm?|null

endpointSpecSwarm?|null

ulimitsSwarm?|null

replicas?number

createdAt?string

environmentId?string

replicaSets?boolean|null

Response Body

`application/json`

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

curl -X POST "https://your-dokploy-instance.com/api/mongo.update" \  -H "Content-Type: application/json" \  -d '{    "mongoId": "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": []
}

Mongo move

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mongoId*string

targetEnvironmentId*string

Response Body

`application/json`

curl -X POST "https://your-dokploy-instance.com/api/mongo.move" \
  -H "Content-Type: application/json" \
  -d '{
    "mongoId": "string",
    "targetEnvironmentId": "string"
  }'

curl -X POST "https://your-dokploy-instance.com/api/mongo.move" \  -H "Content-Type: application/json" \  -d '{    "mongoId": "string",    "targetEnvironmentId": "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": []
}

Mongo rebuild

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mongoId*string

Response Body

`application/json`

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

curl -X POST "https://your-dokploy-instance.com/api/mongo.rebuild" \  -H "Content-Type: application/json" \  -d '{    "mongoId": "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": []
}

Mongo 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

appName?string

description?string

projectId?string

environmentId?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/mongo.search"

curl -X GET "https://your-dokploy-instance.com/api/mongo.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": []
}

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

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

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

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

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/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`

`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`