Dokploy

mariadb

POST/mariadb.create

mariadb-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

appName
Required
string

Minimum length: 1

dockerImagestring

Default: "mariadb:6"

databaseRootPassword
Required
string

projectId
Required
string

descriptionstring | null

databaseName
Required
string

Minimum length: 1

databaseUser
Required
string

Minimum length: 1

databasePassword
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/mariadb.create" \
  -d '{
  "name": "string",
  "appName": "string",
  "dockerImage": "mariadb:6",
  "databaseRootPassword": "string",
  "projectId": "string",
  "description": "string",
  "databaseName": "string",
  "databaseUser": "string",
  "databasePassword": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/mariadb.one

mariadb-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

mariadbId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/mariadb.one?mariadbId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.start

mariadb-start

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/mariadb.start" \
  -d '{
  "mariadbId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.stop

mariadb-stop

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/mariadb.stop" \
  -d '{
  "mariadbId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.saveExternalPort

mariadb-saveExternalPort

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

externalPort
Required
number | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/mariadb.saveExternalPort" \
  -d '{
  "mariadbId": "string",
  "externalPort": 0
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.deploy

mariadb-deploy

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/mariadb.deploy" \
  -d '{
  "mariadbId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.changeStatus

mariadb-changeStatus

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

applicationStatus
Required
string

Value in: "idle" | "running" | "done" | "error"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/mariadb.changeStatus" \
  -d '{
  "mariadbId": "string",
  "applicationStatus": "idle"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.remove

mariadb-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/mariadb.remove" \
  -d '{
  "mariadbId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.saveEnvironment

mariadb-saveEnvironment

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

envstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/mariadb.saveEnvironment" \
  -d '{
  "mariadbId": "string",
  "env": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.reload

mariadb-reload

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

appName
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/mariadb.reload" \
  -d '{
  "mariadbId": "string",
  "appName": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.update

mariadb-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
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: "mariadb:6"

commandstring | null

envstring | null

memoryReservationnumber | null

memoryLimitnumber | null

cpuReservationnumber | null

cpuLimitnumber | null

externalPortnumber | null

applicationStatusstring

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

createdAtstring

projectIdstring

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/mariadb.update" \
  -d '{
  "mariadbId": "string",
  "name": "string",
  "appName": "string",
  "description": "string",
  "databaseName": "string",
  "databaseUser": "string",
  "databasePassword": "string",
  "databaseRootPassword": "string",
  "dockerImage": "mariadb:6",
  "command": "string",
  "env": "string",
  "memoryReservation": 0,
  "memoryLimit": 0,
  "cpuReservation": 0,
  "cpuLimit": 0,
  "externalPort": 0,
  "applicationStatus": "idle",
  "createdAt": "string",
  "projectId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

On this page