Dokploy
Generated

Mounts

POST
/mounts.create

Mounts create

/mounts.create

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

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
curl -X POST "https://your-dokploy-instance.com/api/mounts.create" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "bind",
    "hostPath": "string",
    "volumeName": "string",
    "content": "string",
    "mountPath": "string",
    "serviceType": "application",
    "filePath": "string",
    "serviceId": "string"
  }'

Successful response

{}

POST
/mounts.remove

Mounts remove

/mounts.remove

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

mountId
Required
string

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

Successful response

{}

GET
/mounts.one

Mounts one

/mounts.one

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

mountId
Required
string

curl -X GET "https://your-dokploy-instance.com/api/mounts.one?mountId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST
/mounts.update

Mounts update

/mounts.update

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

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

curl -X POST "https://your-dokploy-instance.com/api/mounts.update" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -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"
  }'

Successful response

{}

GET
/mounts.allNamedByApplicationId

Mounts all Named By Application Id

/mounts.allNamedByApplicationId

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

applicationId
Required
string

Minimum length: 1
curl -X GET "https://your-dokploy-instance.com/api/mounts.allNamedByApplicationId?applicationId=string" \
  -H "Authorization: <token>"

Successful response

{}

Previous

Mongo

Next

Mysql