MongoDB

Create MongoDB Database

curl -X POST "https://your-dokploy-instance.com/api/mongo.create" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production MongoDB",
    "appName": "prod-mongo",
    "databaseUser": "appuser",
    "databasePassword": "SecurePass123!",
    "dockerImage": "mongo:15",
    "environmentId": "env_123456",
    "description": "Main production MongoDB database",
    "replicaSets": false
  }'

string

required

Display name for the MongoDB database

string

required

Unique application name used for Docker container identification

string

required

Username for database access

string

required

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

string

required

ID of the environment where this database will be deployed

string

default:"mongo:15"

Docker image to use for MongoDB

string

Optional description of the database instance

boolean

default:false

Enable MongoDB replica sets for high availability

string

Optional server ID for deployment on specific server

string

Unique identifier for the created MongoDB instance

string

Application name of the database

string

Display name of the database

Get MongoDB Database

curl -X GET "https://your-dokploy-instance.com/api/mongo.one?mongoId=mongo_123456" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

string

required

ID of the MongoDB database to retrieve

string

Database identifier

string

Display name

string

Application name

string

Database username

string

MongoDB Docker image

string

Current status: idle, running, done, or error

number

External port for database access (if configured)

boolean

Whether replica sets are enabled

Deploy MongoDB

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

string

required

ID of the MongoDB database to deploy

Start MongoDB

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

string

required

ID of the MongoDB database to start

Stop MongoDB

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

string

required

ID of the MongoDB database to stop

Update MongoDB

curl -X POST "https://your-dokploy-instance.com/api/mongo.update" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "mongoId": "mongo_123456",
    "name": "Updated MongoDB Database",
    "description": "Updated description",
    "memoryLimit": "2g",
    "memoryReservation": "1g",
    "cpuLimit": "1",
    "cpuReservation": "0.5"
  }'

string

required

ID of the MongoDB database to update

string

New display name

string

New application name

string

New description

string

Database username

string

User password

string

Maximum memory (e.g., “2g”, “512m”)

string

Guaranteed memory allocation

string

Maximum CPU cores

string

Guaranteed CPU allocation

string

Custom command override

array

Command arguments

Save External Port

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

string

required

ID of the MongoDB database

number

Port number for external access. Set to null to remove external port.

Save Environment Variables

curl -X POST "https://your-dokploy-instance.com/api/mongo.saveEnvironment" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "mongoId": "mongo_123456",
    "env": "MONGO_INITDB_DATABASE=myapp\nMONGO_CUSTOM_CONFIG=value"
  }'

string

required

ID of the MongoDB database

string

Environment variables in KEY=VALUE format, separated by newlines

Reload MongoDB

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

string

required

ID of the MongoDB database

string

required

Application name of the database

Rebuild MongoDB

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

string

required

ID of the MongoDB database to rebuild

Remove MongoDB

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

string

required

ID of the MongoDB database to remove

Connection String Format

Standard Connection

mongodb://[databaseUser]:[databasePassword]@[appName]:27017

Example:

mongodb://appuser:SecurePass123!@prod-mongo:27017

With Database Name

mongodb://[databaseUser]:[databasePassword]@[appName]:27017/[databaseName]

External Connection

mongodb://appuser:SecurePass123!@your-server.com:27017

Replica Set Connection

mongodb://[databaseUser]:[databasePassword]@host1:27017,host2:27017,host3:27017/?replicaSet=myReplicaSet

Mount Path

MongoDB data is stored at /data/db inside the container.

Getting Started

Applications

Databases

Docker

Projects & Deployments

Monitoring

Administration

Create MongoDB Database

Get MongoDB Database

Deploy MongoDB

Start MongoDB

Stop MongoDB

Update MongoDB

Save External Port

Save Environment Variables

Reload MongoDB

Rebuild MongoDB

Remove MongoDB

Connection String Format

Standard Connection

With Database Name

External Connection

Replica Set Connection

Mount Path

​Create MongoDB Database

​Get MongoDB Database

​Deploy MongoDB

​Start MongoDB

​Stop MongoDB

​Update MongoDB

​Save External Port

​Save Environment Variables

​Reload MongoDB

​Rebuild MongoDB

​Remove MongoDB

​Connection String Format

​Standard Connection

​With Database Name

​External Connection

​Replica Set Connection

​Mount Path

Create MongoDB Database

Get MongoDB Database

Deploy MongoDB

Start MongoDB

Stop MongoDB

Update MongoDB

Save External Port

Save Environment Variables

Reload MongoDB

Rebuild MongoDB

Remove MongoDB

Connection String Format

Standard Connection

With Database Name

External Connection

Replica Set Connection

Mount Path