Dokploy

mounts

POST/mounts.create

mounts-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

type
Required
string

Value in: "bind" | "volume" | "file"

hostPathstring | null

volumeNamestring | null

contentstring | null

mountPath
Required
string

Minimum length: 1

serviceTypestring

Default: "application"Value in: "application" | "postgres" | "mysql" | "mariadb" | "mongo" | "redis" | "compose"

filePathstring | null

serviceId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/mounts.create" \
  -d '{
  "type": "bind",
  "hostPath": "string",
  "volumeName": "string",
  "content": "string",
  "mountPath": "string",
  "serviceType": "application",
  "filePath": "string",
  "serviceId": "string"
}'

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

POST/mounts.remove

mounts-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mountId
Required
string

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

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

GET/mounts.one

mounts-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

mountId
Required
string

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

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

POST/mounts.update

mounts-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mountId
Required
string

Minimum length: 1

typestring

Value in: "bind" | "volume" | "file"

hostPathstring | null

volumeNamestring | null

filePathstring | null

contentstring | null

serviceTypestring

Default: "application"Value in: "application" | "postgres" | "mysql" | "mariadb" | "mongo" | "redis" | "compose"

mountPathstring

Minimum length: 1

applicationIdstring | null

postgresIdstring | null

mariadbIdstring | null

mongoIdstring | null

mysqlIdstring | null

redisIdstring | null

composeIdstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/mounts.update" \
  -d '{
  "mountId": "string",
  "type": "bind",
  "hostPath": "string",
  "volumeName": "string",
  "filePath": "string",
  "content": "string",
  "serviceType": "application",
  "mountPath": "string",
  "applicationId": "string",
  "postgresId": "string",
  "mariadbId": "string",
  "mongoId": "string",
  "mysqlId": "string",
  "redisId": "string",
  "composeId": "string"
}'

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

On this page