Skip to content

vps.mount

Manage mounts

Create

Path
POST /v7.0/vpses/{vps_id}/mounts
Description
Mount local dataset to directory in VPS
Authentication required
yes
Scope
vps.mount#create
Aliases
new
Blocking
yes

Input parameters

Layout
object
Namespace
mount
ParameterTypeRequiredDetails
dataset
Dataset
 Resource yes

Dataset the VPS resides in
user_namespace_map
UID/GID map
 Resource no
mountpoint
Mountpoint
 String no

Default: null
mode
Mode
 String no

Default: rw

Validation rules
RuleDetails
Include

Allowed values:

  • ro
  • rw

Validation error message: %{value} cannot be used
on_start_fail
On mount failure
 String no

What happens when the mount fails during VPS start

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • skip
  • mount_later
  • fail_start
  • wait_for_mount

Validation error message: %{value} cannot be used
enabled
Enabled
 Boolean no

Default: true

Output parameters

Layout
object
Namespace
mount
ParameterTypeDescription
id
Id
 Integer
vps
VPS
 Resource
dataset
Dataset
 Resource Dataset the VPS resides in
user_namespace_map
UID/GID map
 Resource
mountpoint
Mountpoint
 String
mode
Mode
 String
on_start_fail
On mount failure
 String What happens when the mount fails during VPS start
expiration_date
Expiration date
 Datetime The mount is deleted when expiration date passes
enabled
Enabled
 Boolean
master_enabled
Master enabled
 Boolean
current_state
Current state
 String

Delete

Path
DELETE /v7.0/vpses/{vps_id}/mounts/{mount_id}
Description
Delete mount from VPS
Authentication required
yes
Scope
vps.mount#delete
Aliases
destroy
Blocking
yes

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/vpses/{vps_id}/mounts
Description
List mounts
Authentication required
yes
Scope
vps.mount#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
mount
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000

Output parameters

Layout
object_list
Namespace
mounts
ParameterTypeDescription
id
Id
 Integer
vps
VPS
 Resource
dataset
Dataset
 Resource Dataset the VPS resides in
user_namespace_map
UID/GID map
 Resource
mountpoint
Mountpoint
 String
mode
Mode
 String
on_start_fail
On mount failure
 String What happens when the mount fails during VPS start
expiration_date
Expiration date
 Datetime The mount is deleted when expiration date passes
enabled
Enabled
 Boolean
master_enabled
Master enabled
 Boolean
current_state
Current state
 String

Show

Path
GET /v7.0/vpses/{vps_id}/mounts/{mount_id}
Description
Show mount
Authentication required
yes
Scope
vps.mount#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
mount
ParameterTypeDescription
id
Id
 Integer
vps
VPS
 Resource
dataset
Dataset
 Resource Dataset the VPS resides in
user_namespace_map
UID/GID map
 Resource
mountpoint
Mountpoint
 String
mode
Mode
 String
on_start_fail
On mount failure
 String What happens when the mount fails during VPS start
expiration_date
Expiration date
 Datetime The mount is deleted when expiration date passes
enabled
Enabled
 Boolean
master_enabled
Master enabled
 Boolean
current_state
Current state
 String

Update

Path
PUT /v7.0/vpses/{vps_id}/mounts/{mount_id}
Description
Update a mount
Authentication required
yes
Scope
vps.mount#update
Aliases
Blocking
yes

Input parameters

Layout
object
Namespace
mount
ParameterTypeRequiredDetails
on_start_fail
On mount failure
 String no

What happens when the mount fails during VPS start

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • skip
  • mount_later
  • fail_start
  • wait_for_mount

Validation error message: %{value} cannot be used
enabled
Enabled
 Boolean no

Default: null
master_enabled
Master enabled
 Boolean no

Default: null

Output parameters

Layout
object
Namespace
mount
ParameterTypeDescription
id
Id
 Integer
vps
VPS
 Resource
dataset
Dataset
 Resource Dataset the VPS resides in
user_namespace_map
UID/GID map
 Resource
mountpoint
Mountpoint
 String
mode
Mode
 String
on_start_fail
On mount failure
 String What happens when the mount fails during VPS start
expiration_date
Expiration date
 Datetime The mount is deleted when expiration date passes
enabled
Enabled
 Boolean
master_enabled
Master enabled
 Boolean
current_state
Current state
 String