Dokploy

Mysql

POST
/mysql.create

Mysql create

/mysql.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: "mysql:8"

projectId
Required
string

descriptionstring | null

databaseName
Required
string

Minimum length: 1

databaseUser
Required
string

Minimum length: 1

databasePassword
Required
string

databaseRootPassword
Required
string

serverIdstring | null

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

Successful response

GET
/mysql.one

Mysql one

/mysql.one

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

mysqlId
Required
string

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

Successful response

POST
/mysql.start

Mysql start

/mysql.start

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mysqlId
Required
string

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

Successful response

POST
/mysql.stop

Mysql stop

/mysql.stop

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mysqlId
Required
string

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

Successful response

POST
/mysql.saveExternalPort

Mysql save External Port

/mysql.saveExternalPort

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mysqlId
Required
string

externalPort
Required
number | null

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

Successful response

POST
/mysql.deploy

Mysql deploy

/mysql.deploy

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mysqlId
Required
string

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

Successful response

POST
/mysql.changeStatus

Mysql change Status

/mysql.changeStatus

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mysqlId
Required
string

applicationStatus
Required
string

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

Successful response

POST
/mysql.reload

Mysql reload

/mysql.reload

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mysqlId
Required
string

appName
Required
string

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

Successful response

POST
/mysql.remove

Mysql remove

/mysql.remove

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mysqlId
Required
string

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

Successful response

POST
/mysql.saveEnvironment

Mysql save Environment

/mysql.saveEnvironment

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mysqlId
Required
string

envstring | null

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

Successful response

POST
/mysql.update

Mysql update

/mysql.update

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

mysqlId
Required
string

Minimum length: 1

namestring

Minimum length: 1

appNamestring

Minimum length: 1

descriptionstring | null

databaseNamestring

Minimum length: 1

databaseUserstring

Minimum length: 1

databasePasswordstring

databaseRootPasswordstring

dockerImagestring

Default: "mysql:8"

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/mysql.update" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "mysqlId": "string",
    "name": "string",
    "appName": "string",
    "description": "string",
    "databaseName": "string",
    "databaseUser": "string",
    "databasePassword": "string",
    "databaseRootPassword": "string",
    "dockerImage": "mysql:8",
    "command": "string",
    "env": "string",
    "memoryReservation": 0,
    "memoryLimit": 0,
    "cpuReservation": 0,
    "cpuLimit": 0,
    "externalPort": 0,
    "applicationStatus": "idle",
    "createdAt": "string",
    "projectId": "string"
  }'

Successful response

Previous

Mounts

Next

Notification