Skip to content

export

Manage NFS exports

Create

Path
POST /v7.0/exports
Description
Create a new export
Authentication required
yes
Scope
export#create
Aliases
new
Blocking
yes

Input parameters

Layout
object
Namespace
export
ParameterTypeRequiredDetails
dataset
Dataset
 Resource no

Dataset the VPS resides in
snapshot
Snapshot
 Resource no
all_vps
All VPS
 Boolean no

Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export.

Default: true
rw
Read-write
 Boolean no

Allow the export to be mounted as read-write.

Default: true
sync
Sync
 Boolean no

Determines whether the server replies to requests only after the changes have been committed to stable storage.

Default: true
subtree_check
Subtree check
 Boolean no

See man exports(5).

Default: false
root_squash
Root squash
 Boolean no

Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.

Default: false
threads
Threads
 Integer no

Number of NFS server threads.

Default: 8

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

Validation error message: must be between 1 and 64
enabled
Enabled
 Boolean no

Default: true

Output parameters

Layout
object
Namespace
export
ParameterTypeDescription
id
Export ID
 Integer
dataset
Dataset
 Resource Dataset the VPS resides in
snapshot
Snapshot
 Resource
user
User
 Resource
ip_address
IpAddress
 Resource
host_ip_address
HostIpAddress
 Resource Host address to assign to the interface, defaults to the first address
path
Path
 String
all_vps
All VPS
 Boolean Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export.
rw
Read-write
 Boolean Allow the export to be mounted as read-write.
sync
Sync
 Boolean Determines whether the server replies to requests only after the changes have been committed to stable storage.
subtree_check
Subtree check
 Boolean See man exports(5).
root_squash
Root squash
 Boolean Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.
threads
Threads
 Integer Number of NFS server threads.
enabled
Enabled
 Boolean
expiration_date
Expiration date
 Datetime
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

Path
DELETE /v7.0/exports/{export_id}
Description
Delete export
Authentication required
yes
Scope
export#delete
Aliases
destroy
Blocking
yes

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/exports
Description
List exports
Authentication required
yes
Scope
export#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
export
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
user
User
 Resource no

Output parameters

Layout
object_list
Namespace
exports
ParameterTypeDescription
id
Export ID
 Integer
dataset
Dataset
 Resource Dataset the VPS resides in
snapshot
Snapshot
 Resource
user
User
 Resource
ip_address
IpAddress
 Resource
host_ip_address
HostIpAddress
 Resource Host address to assign to the interface, defaults to the first address
path
Path
 String
all_vps
All VPS
 Boolean Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export.
rw
Read-write
 Boolean Allow the export to be mounted as read-write.
sync
Sync
 Boolean Determines whether the server replies to requests only after the changes have been committed to stable storage.
subtree_check
Subtree check
 Boolean See man exports(5).
root_squash
Root squash
 Boolean Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.
threads
Threads
 Integer Number of NFS server threads.
enabled
Enabled
 Boolean
expiration_date
Expiration date
 Datetime
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/exports/{export_id}
Description
Authentication required
yes
Scope
export#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
export
ParameterTypeDescription
id
Export ID
 Integer
dataset
Dataset
 Resource Dataset the VPS resides in
snapshot
Snapshot
 Resource
user
User
 Resource
ip_address
IpAddress
 Resource
host_ip_address
HostIpAddress
 Resource Host address to assign to the interface, defaults to the first address
path
Path
 String
all_vps
All VPS
 Boolean Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export.
rw
Read-write
 Boolean Allow the export to be mounted as read-write.
sync
Sync
 Boolean Determines whether the server replies to requests only after the changes have been committed to stable storage.
subtree_check
Subtree check
 Boolean See man exports(5).
root_squash
Root squash
 Boolean Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.
threads
Threads
 Integer Number of NFS server threads.
enabled
Enabled
 Boolean
expiration_date
Expiration date
 Datetime
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Update

Path
PUT /v7.0/exports/{export_id}
Description
Edit export
Authentication required
yes
Scope
export#update
Aliases
Blocking
yes

Input parameters

Layout
object
Namespace
export
ParameterTypeRequiredDetails
all_vps
All VPS
 Boolean no

Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export.

Default: null
rw
Read-write
 Boolean no

Allow the export to be mounted as read-write.

Default: null
sync
Sync
 Boolean no

Determines whether the server replies to requests only after the changes have been committed to stable storage.

Default: null
subtree_check
Subtree check
 Boolean no

See man exports(5).

Default: null
root_squash
Root squash
 Boolean no

Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.

Default: null
threads
Threads
 Integer no

Number of NFS server threads.

Default: null

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

Validation error message: must be between 1 and 64
enabled
Enabled
 Boolean no

Default: null

Output parameters

Layout
object
Namespace
export
ParameterTypeDescription
id
Export ID
 Integer
dataset
Dataset
 Resource Dataset the VPS resides in
snapshot
Snapshot
 Resource
user
User
 Resource
ip_address
IpAddress
 Resource
host_ip_address
HostIpAddress
 Resource Host address to assign to the interface, defaults to the first address
path
Path
 String
all_vps
All VPS
 Boolean Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export.
rw
Read-write
 Boolean Allow the export to be mounted as read-write.
sync
Sync
 Boolean Determines whether the server replies to requests only after the changes have been committed to stable storage.
subtree_check
Subtree check
 Boolean See man exports(5).
root_squash
Root squash
 Boolean Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.
threads
Threads
 Integer Number of NFS server threads.
enabled
Enabled
 Boolean
expiration_date
Expiration date
 Datetime
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Subresources