mounts

POST`/mounts.create`

mounts-create

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`type`
Required
string

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

`hostPath`string | null

`volumeName`string | null

`content`string | null

`mountPath`
Required
string

Minimum length: 1

`serviceType`string

`filePath`string | null

`serviceId`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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

`type`string

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

`hostPath`string | null

`volumeName`string | null

`filePath`string | null

`content`string | null

`serviceType`string

`mountPath`string

Minimum length: 1

`applicationId`string | null

`postgresId`string | null

`mariadbId`string | null

`mongoId`string | null

`mysqlId`string | null

`redisId`string | null

`composeId`string | null

Status code	Description
`200`	Successful response
`default`	Error 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"
    }
  ]
}

mounts

POST/mounts.create

AuthorizationRequiredBearer <token>

typeRequiredstring

hostPathstring | null

volumeNamestring | null

contentstring | null

mountPathRequiredstring

serviceTypestring

filePathstring | null

serviceIdRequiredstring

Response

Typescript

POST/mounts.remove

AuthorizationRequiredBearer <token>

mountIdRequiredstring

Response

Typescript

GET/mounts.one

AuthorizationRequiredBearer <token>

mountIdRequiredstring

Response

Typescript

POST/mounts.update

AuthorizationRequiredBearer <token>

mountIdRequiredstring

typestring

hostPathstring | null

volumeNamestring | null

filePathstring | null

contentstring | null

serviceTypestring

mountPathstring

applicationIdstring | null

postgresIdstring | null

mariadbIdstring | null

mongoIdstring | null

mysqlIdstring | null

redisIdstring | null

composeIdstring | null

Response

Typescript

On this page

POST`/mounts.create`

`Authorization`
Required
Bearer <token>

`type`
Required
string

`hostPath`string | null

`volumeName`string | null

`content`string | null

`mountPath`
Required
string

`serviceType`string

`filePath`string | null

`serviceId`
Required
string

POST`/mounts.remove`

`Authorization`
Required
Bearer <token>

`mountId`
Required
string

GET`/mounts.one`

`Authorization`
Required
Bearer <token>

`mountId`
Required
string

POST`/mounts.update`

`Authorization`
Required
Bearer <token>

`mountId`
Required
string

`type`string

`hostPath`string | null

`volumeName`string | null

`filePath`string | null

`content`string | null

`serviceType`string

`mountPath`string

`applicationId`string | null

`postgresId`string | null

`mariadbId`string | null

`mongoId`string | null

`mysqlId`string | null

`redisId`string | null

`composeId`string | null