Dokploy

Mysql

POST
/mysql.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
Length1 <= length
dockerImage?string
Default"mysql:8"
environmentId*string
description?string|null
databaseName*string
Length1 <= length
databaseUser*string
Length1 <= length
databasePassword*string
Match^[a-zA-Z0-9@#%^&*()_+\-=[\]{}|;:,.<>?~`]*$
databaseRootPassword*string
Match^[a-zA-Z0-9@#%^&*()_+\-=[\]{}|;:,.<>?~`]*$
serverId?string|null
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/mysql.create" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "appName": "string",    "environmentId": "string",    "databaseName": "string",    "databaseUser": "string",    "databasePassword": "string",    "databaseRootPassword": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/mysql.one

Authorization

x-api-key

x-api-key<token>

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

In: header

Query Parameters

mysqlId*string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/mysql.one?mysqlId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/mysql.start

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mysqlId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/mysql.start" \  -H "Content-Type: application/json" \  -d '{    "mysqlId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/mysql.stop

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mysqlId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/mysql.stop" \  -H "Content-Type: application/json" \  -d '{    "mysqlId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/mysql.saveExternalPort

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mysqlId*string
externalPort*number|null
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/mysql.saveExternalPort" \  -H "Content-Type: application/json" \  -d '{    "mysqlId": "string",    "externalPort": 0  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/mysql.deploy

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mysqlId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/mysql.deploy" \  -H "Content-Type: application/json" \  -d '{    "mysqlId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/mysql.changeStatus

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mysqlId*string
applicationStatus*string
Value in"idle" | "running" | "done" | "error"
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/mysql.changeStatus" \  -H "Content-Type: application/json" \  -d '{    "mysqlId": "string",    "applicationStatus": "idle"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/mysql.reload

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mysqlId*string
appName*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/mysql.reload" \  -H "Content-Type: application/json" \  -d '{    "mysqlId": "string",    "appName": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/mysql.remove

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mysqlId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/mysql.remove" \  -H "Content-Type: application/json" \  -d '{    "mysqlId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/mysql.saveEnvironment

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mysqlId*string
env?string|null
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/mysql.saveEnvironment" \  -H "Content-Type: application/json" \  -d '{    "mysqlId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/mysql.update

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mysqlId*string
Length1 <= length
name?string
Length1 <= length
appName?string
Length1 <= length
description?string|null
databaseName?string
Length1 <= length
databaseUser?string
Length1 <= length
databasePassword?string
Match^[a-zA-Z0-9@#%^&*()_+\-=[\]{}|;:,.<>?~`]*$
databaseRootPassword?string
Match^[a-zA-Z0-9@#%^&*()_+\-=[\]{}|;:,.<>?~`]*$
dockerImage?string
Default"mysql:8"
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?integer|null
endpointSpecSwarm?|null
replicas?number
createdAt?string
environmentId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/mysql.update" \  -H "Content-Type: application/json" \  -d '{    "mysqlId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/mysql.move

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mysqlId*string
targetEnvironmentId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/mysql.move" \  -H "Content-Type: application/json" \  -d '{    "mysqlId": "string",    "targetEnvironmentId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/mysql.rebuild

Authorization

x-api-key

x-api-key<token>

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

In: header

Request Body

application/json

mysqlId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/mysql.rebuild" \  -H "Content-Type: application/json" \  -d '{    "mysqlId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Mounts

Previous Page

Notification

Next Page