Dokploy

Mongo

POST
/mongo.create

Mongo create

/mongo.create

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

name
Required
string

Minimum length: 1

appName
Required
string

Minimum length: 1

dockerImagestring

Default: "mongo:15"

projectId
Required
string

descriptionstring | null

databaseUser
Required
string

Minimum length: 1

databasePassword
Required
string

serverIdstring | null

curl -X POST "http://your-dokploy-instance.com/api/mongo.create" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "appName": "string",
    "dockerImage": "mongo:15",
    "projectId": "string",
    "description": "string",
    "databaseUser": "string",
    "databasePassword": "string",
    "serverId": "string"
  }'

Successful response

GET
/mongo.one

Mongo one

/mongo.one

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

mongoId
Required
string

curl -X GET "http://your-dokploy-instance.com/api/mongo.one?mongoId=string" \
  -H "Authorization: Bearer <token>"

Successful response

POST
/mongo.start

Mongo start

/mongo.start

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mongoId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/mongo.start" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "mongoId": "string"
  }'

Successful response

POST
/mongo.stop

Mongo stop

/mongo.stop

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mongoId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/mongo.stop" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "mongoId": "string"
  }'

Successful response

POST
/mongo.saveExternalPort

Mongo save External Port

/mongo.saveExternalPort

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mongoId
Required
string

externalPort
Required
number | null

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

Successful response

POST
/mongo.deploy

Mongo deploy

/mongo.deploy

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mongoId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/mongo.deploy" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "mongoId": "string"
  }'

Successful response

POST
/mongo.changeStatus

Mongo change Status

/mongo.changeStatus

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mongoId
Required
string

applicationStatus
Required
string

Value in: "idle" | "running" | "done" | "error"
curl -X POST "http://your-dokploy-instance.com/api/mongo.changeStatus" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "mongoId": "string",
    "applicationStatus": "idle"
  }'

Successful response

POST
/mongo.reload

Mongo reload

/mongo.reload

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mongoId
Required
string

appName
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/mongo.reload" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "mongoId": "string",
    "appName": "string"
  }'

Successful response

POST
/mongo.remove

Mongo remove

/mongo.remove

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mongoId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/mongo.remove" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "mongoId": "string"
  }'

Successful response

POST
/mongo.saveEnvironment

Mongo save Environment

/mongo.saveEnvironment

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mongoId
Required
string

envstring | null

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

Successful response

POST
/mongo.update

Mongo update

/mongo.update

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mongoId
Required
string

Minimum length: 1

namestring

Minimum length: 1

appNamestring

Minimum length: 1

descriptionstring | null

databaseUserstring

Minimum length: 1

databasePasswordstring

dockerImagestring

Default: "mongo:15"

commandstring | null

envstring | null

memoryReservationnumber | null

memoryLimitnumber | null

cpuReservationnumber | null

cpuLimitnumber | null

externalPortnumber | null

applicationStatusstring

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

createdAtstring

projectIdstring

curl -X POST "http://your-dokploy-instance.com/api/mongo.update" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "mongoId": "string",
    "name": "string",
    "appName": "string",
    "description": "string",
    "databaseUser": "string",
    "databasePassword": "string",
    "dockerImage": "mongo:15",
    "command": "string",
    "env": "string",
    "memoryReservation": 0,
    "memoryLimit": 0,
    "cpuReservation": 0,
    "cpuLimit": 0,
    "externalPort": 0,
    "applicationStatus": "idle",
    "createdAt": "string",
    "projectId": "string"
  }'

Successful response

Previous

Mariadb

Next

Mounts