MySQL

Create MySQL Database

curl -X POST "https://your-dokploy-instance.com/api/mysql.create" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production MySQL",
    "appName": "prod-mysql",
    "databaseName": "myapp",
    "databaseUser": "appuser",
    "databasePassword": "SecurePass123!",
    "databaseRootPassword": "RootPass456!",
    "dockerImage": "mysql:8",
    "environmentId": "env_123456",
    "description": "Main production MySQL database"
  }'

string

required

Display name for the MySQL database

string

required

Unique application name used for Docker container identification

string

required

Name of the database to create

string

required

Username for database access

string

required

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

string

required

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

string

required

ID of the environment where this database will be deployed

string

default:"mysql:8"

Docker image to use for MySQL

string

Optional description of the database instance

string

Optional server ID for deployment on specific server

string

Unique identifier for the created MySQL instance

string

Application name of the database

string

Display name of the database

Get MySQL Database

curl -X GET "https://your-dokploy-instance.com/api/mysql.one?mysqlId=mysql_123456" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

string

required

ID of the MySQL database to retrieve

string

Database identifier

string

Display name

string

Application name

string

Database name

string

Database username

string

MySQL Docker image

string

Current status: idle, running, done, or error

number

External port for database access (if configured)

Deploy MySQL

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

string

required

ID of the MySQL database to deploy

Start MySQL

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

string

required

ID of the MySQL database to start

Stop MySQL

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

string

required

ID of the MySQL database to stop

Update MySQL

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

string

required

ID of the MySQL database to update

string

New display name

string

New application name

string

New description

string

Database name

string

Database username

string

User password

string

Root 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/mysql.saveExternalPort" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "mysqlId": "mysql_123456",
    "externalPort": 3306
  }'

string

required

ID of the MySQL 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/mysql.saveEnvironment" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "mysqlId": "mysql_123456",
    "env": "MYSQL_MAX_CONNECTIONS=200\nMYSQL_INNODB_BUFFER_POOL_SIZE=256M"
  }'

string

required

ID of the MySQL database

string

Environment variables in KEY=VALUE format, separated by newlines

Reload MySQL

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

string

required

ID of the MySQL database

string

required

Application name of the database

Rebuild MySQL

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

string

required

ID of the MySQL database to rebuild

Remove MySQL

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

string

required

ID of the MySQL database to remove

Connection String Format

mysql://[databaseUser]:[databasePassword]@[appName]:3306/[databaseName]

Example:

mysql://appuser:SecurePass123!@prod-mysql:3306/myapp

For external connections:

mysql://appuser:SecurePass123!@your-server.com:3306/myapp

Mount Path

MySQL data is stored at /var/lib/mysql inside the container.

Getting Started

Applications

Databases

Docker

Projects & Deployments

Monitoring

Administration

Create MySQL Database

Get MySQL Database

Deploy MySQL

Start MySQL

Stop MySQL

Update MySQL

Save External Port

Save Environment Variables

Reload MySQL

Rebuild MySQL

Remove MySQL

Connection String Format

Mount Path

​Create MySQL Database

​Get MySQL Database

​Deploy MySQL

​Start MySQL

​Stop MySQL

​Update MySQL

​Save External Port

​Save Environment Variables

​Reload MySQL

​Rebuild MySQL

​Remove MySQL

​Connection String Format

​Mount Path

Create MySQL Database

Get MySQL Database

Deploy MySQL

Start MySQL

Stop MySQL

Update MySQL

Save External Port

Save Environment Variables

Reload MySQL

Rebuild MySQL

Remove MySQL

Connection String Format

Mount Path