dataset

Manage datasets

Create

Path: POST /v7.0/datasets
Description: Create a subdataset
Authentication required: yes
Scope: dataset#create
Aliases: new
Blocking: yes

Input parameters

Layout: object
Namespace: dataset

Parameter Type Required Details

name

Name

String

yes

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty
Format	Must match this regular expression: `\A[a-zA-Z0-9][a-zA-Z0-9_\-:./]{0,254}\z` `null` Validation error message: '%{value}' is not a valid dataset name

dataset

Parent dataset

Resource

Dataset the VPS resides in

automount

Automount

Boolean

Automatically mount newly created datasets under all its parents

Default: false

atime

Access time

Boolean

Controls whether the access time for files is updated when they are read

Default: false

compression

Compression

Boolean

Toggle data compression in this dataset

Default: true

recordsize

Record size

Integer

Specifies a suggested block size for files in the file system

Default: 131072

quota

Quota

Integer

Limits the amount of space a dataset and all its descendants can consume

Default: 0

refquota

Reference quota

Integer

Limits the amount of space a dataset can consume

Default: 0

relatime

Relative access time

Boolean

Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours

Default: false

sync

Sync

String

Controls the behavior of synchronous requests

Default: standard

Validation rules
Rule	Details
Include	Allowed values: `standard` `disabled` Validation error message: %{value} cannot be used

sharenfs

NFS share

String

Controls NFS sharing

Default: ""

Output parameters

Layout: object
Namespace: dataset

Parameter	Type	Description
`id` Id	Integer
`name` Name	String
`parent` Parent	Resource
`user` User	Resource	Dataset owner
`environment` Environment	Resource	The environment in which the dataset is
`current_history_id` Current_history_id	Integer
`atime` Access time	Boolean	Controls whether the access time for files is updated when they are read
`compression` Compression	Boolean	Toggle data compression in this dataset
`recordsize` Record size	Integer	Specifies a suggested block size for files in the file system
`quota` Quota	Integer	Limits the amount of space a dataset and all its descendants can consume
`refquota` Reference quota	Integer	Limits the amount of space a dataset can consume
`relatime` Relative access time	Boolean	Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours
`sync` Sync	String	Controls the behavior of synchronous requests
`sharenfs` NFS share	String	Controls NFS sharing
`used` Used space	Integer	Amount of space used by dataset
`referenced` Referenced space	Integer	Amount of space that is accessible to this dataset
`avail` Available space	Integer	Amount of space left in dataset
`compressratio` Used compression ratio	Float	Compression ratio for used space of this dataset
`refcompressratio` Referenced compression ratio	Float	Compression ratio for referenced space of this dataset
`vps` VPS	Resource
`export` Export	Resource	Filter outages affecting a specific export
`dataset_expansion` DatasetExpansion	Resource

Delete

Path: DELETE /v7.0/datasets/{dataset_id}
Description: Destroy a dataset with all its subdatasets and snapshots
Authentication required: yes
Scope: dataset#delete
Aliases: destroy
Blocking: yes

Input parameters

No parameters.

Output parameters

No parameters.

Find_by_name

Path: GET /v7.0/datasets/find_by_name
Description: Look up dataset by its name, possibly with a label
Authentication required: yes
Scope: dataset#find_by_name
Aliases
Blocking: no

Input parameters

Layout: object
Namespace: dataset

Parameter	Type	Required	Details
`name` Name	String	no	Default: `null`
`user` User	Resource	no	Dataset owner

Output parameters

Layout: object
Namespace: dataset

Parameter	Type	Description
`id` Id	Integer
`name` Name	String
`parent` Parent	Resource
`user` User	Resource	Dataset owner
`environment` Environment	Resource	The environment in which the dataset is
`current_history_id` Current_history_id	Integer
`atime` Access time	Boolean	Controls whether the access time for files is updated when they are read
`compression` Compression	Boolean	Toggle data compression in this dataset
`recordsize` Record size	Integer	Specifies a suggested block size for files in the file system
`quota` Quota	Integer	Limits the amount of space a dataset and all its descendants can consume
`refquota` Reference quota	Integer	Limits the amount of space a dataset can consume
`relatime` Relative access time	Boolean	Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours
`sync` Sync	String	Controls the behavior of synchronous requests
`sharenfs` NFS share	String	Controls NFS sharing
`used` Used space	Integer	Amount of space used by dataset
`referenced` Referenced space	Integer	Amount of space that is accessible to this dataset
`avail` Available space	Integer	Amount of space left in dataset
`compressratio` Used compression ratio	Float	Compression ratio for used space of this dataset
`refcompressratio` Referenced compression ratio	Float	Compression ratio for referenced space of this dataset
`vps` VPS	Resource
`export` Export	Resource	Filter outages affecting a specific export
`dataset_expansion` DatasetExpansion	Resource

Index

Path: GET /v7.0/datasets
Description: List datasets
Authentication required: yes
Scope: dataset#index
Aliases: list
Blocking: no

Input parameters

Layout: object
Namespace: dataset

Parameter Type Required Details

from_id

From ID

Integer

List objects with IDs greater or lower than this value

Default: null

Validation rules
Rule	Details
Number	Must be a number after parameter type conversion. Minimum: `0` (inclusive). Validation error message: must be at least 0

limit

Limit

Integer

Number of objects to retrieve

Default: null

Validation rules
Rule	Details
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

Dataset owner

vps

VPS

Resource

dataset

Subtree

Resource

Dataset the VPS resides in

primary_pool

Primary pool

Resource

Show only datasets on this pool

role

Role

String

Show only datasets of certain role

Default: null

Validation rules
Rule	Details
Include	Allowed values: `hypervisor` `primary` `backup` Validation error message: %{value} cannot be used

to_depth

To depth

Integer

Show only datasets to certain depth

Default: null

Output parameters

Layout: object_list
Namespace: datasets

Parameter	Type	Description
`id` Id	Integer
`name` Name	String
`parent` Parent	Resource
`user` User	Resource	Dataset owner
`environment` Environment	Resource	The environment in which the dataset is
`current_history_id` Current_history_id	Integer
`atime` Access time	Boolean	Controls whether the access time for files is updated when they are read
`compression` Compression	Boolean	Toggle data compression in this dataset
`recordsize` Record size	Integer	Specifies a suggested block size for files in the file system
`quota` Quota	Integer	Limits the amount of space a dataset and all its descendants can consume
`refquota` Reference quota	Integer	Limits the amount of space a dataset can consume
`relatime` Relative access time	Boolean	Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours
`sync` Sync	String	Controls the behavior of synchronous requests
`sharenfs` NFS share	String	Controls NFS sharing
`used` Used space	Integer	Amount of space used by dataset
`referenced` Referenced space	Integer	Amount of space that is accessible to this dataset
`avail` Available space	Integer	Amount of space left in dataset
`compressratio` Used compression ratio	Float	Compression ratio for used space of this dataset
`refcompressratio` Referenced compression ratio	Float	Compression ratio for referenced space of this dataset
`vps` VPS	Resource
`export` Export	Resource	Filter outages affecting a specific export
`dataset_expansion` DatasetExpansion	Resource

Inherit

Path: POST /v7.0/datasets/{dataset_id}/inherit
Description: Inherit dataset property
Authentication required: yes
Scope: dataset#inherit
Aliases
Blocking: yes

Input parameters

Layout: object
Namespace: dataset

Parameter Type Required Details

property

Property

String

yes

Name of property to inherit from parent, multiple properties may be separated by a comma

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty

Output parameters

No parameters.

Migrate

Path: POST /v7.0/datasets/{dataset_id}/migrate
Description: Migrate dataset to another pool
Authentication required: yes
Scope: dataset#migrate
Aliases
Blocking: yes

Input parameters

Layout: object
Namespace: dataset

Parameter Type Required Details

pool

Pool

Resource

yes

Storage pool the VPS resides in

maintenance_window_vps

VPS maintenance window

Resource

Migrate the dataset within the nearest maintenance window of VPS

rsync

Rsync

Boolean

Use rsync instead of zfs send/recv

Default: false

restart_vps

Restart VPS

Boolean

Restart VPSes where migrated exports are mounted

Default: false

finish_weekday

Finish weekday

Integer

Prepare the migration and finish it on this day

Default: null

Validation rules
Rule	Details
Number	Must be a number after parameter type conversion. Minimum: `0` (inclusive). Maximum: `6` (inclusive). Validation error message: must be between 0 and 6

finish_minutes

Finish minutes

Integer

Number of minutes from midnight of start_weekday after which the migration is done

Default: null

Validation rules
Rule	Details
Number	Must be a number after parameter type conversion. Minimum: `0` (inclusive). Maximum: `1410` (inclusive). Validation error message: must be between 0 and 1410

optional_maintenance_window

Optional maintenance window

Boolean

Use maintenance window only if the dataset has any exports

Default: true

cleanup_data

Cleanup data

Boolean

Remove dataset from the source pool

Default: true

send_mail

Send e-mails

Boolean

Inform the dataset owner about migration progress

Default: true

reason

Reason

String

Default: null

Output parameters

No parameters.

Show

Path: GET /v7.0/datasets/{dataset_id}
Description: Show a dataset
Authentication required: yes
Scope: dataset#show
Aliases: find
Blocking: no

Input parameters

No parameters.

Output parameters

Layout: object
Namespace: dataset

Parameter	Type	Description
`id` Id	Integer
`name` Name	String
`parent` Parent	Resource
`user` User	Resource	Dataset owner
`environment` Environment	Resource	The environment in which the dataset is
`current_history_id` Current_history_id	Integer
`atime` Access time	Boolean	Controls whether the access time for files is updated when they are read
`compression` Compression	Boolean	Toggle data compression in this dataset
`recordsize` Record size	Integer	Specifies a suggested block size for files in the file system
`quota` Quota	Integer	Limits the amount of space a dataset and all its descendants can consume
`refquota` Reference quota	Integer	Limits the amount of space a dataset can consume
`relatime` Relative access time	Boolean	Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours
`sync` Sync	String	Controls the behavior of synchronous requests
`sharenfs` NFS share	String	Controls NFS sharing
`used` Used space	Integer	Amount of space used by dataset
`referenced` Referenced space	Integer	Amount of space that is accessible to this dataset
`avail` Available space	Integer	Amount of space left in dataset
`compressratio` Used compression ratio	Float	Compression ratio for used space of this dataset
`refcompressratio` Referenced compression ratio	Float	Compression ratio for referenced space of this dataset
`vps` VPS	Resource
`export` Export	Resource	Filter outages affecting a specific export
`dataset_expansion` DatasetExpansion	Resource

Update

Path: PUT /v7.0/datasets/{dataset_id}
Description: Update a dataset
Authentication required: yes
Scope: dataset#update
Aliases
Blocking: yes

Input parameters

Layout: object
Namespace: dataset

Parameter Type Required Details

atime

Access time

Boolean

Controls whether the access time for files is updated when they are read

Default: false

compression

Compression

Boolean

Toggle data compression in this dataset

Default: true

recordsize

Record size

Integer

Specifies a suggested block size for files in the file system

Default: 131072

quota

Quota

Integer

Limits the amount of space a dataset and all its descendants can consume

Default: 0

refquota

Reference quota

Integer

Limits the amount of space a dataset can consume

Default: 0

relatime

Relative access time

Boolean

Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours

Default: false

sync

Sync

String

Controls the behavior of synchronous requests

Default: standard

Validation rules
Rule	Details
Include	Allowed values: `standard` `disabled` Validation error message: %{value} cannot be used

sharenfs

NFS share

String

Controls NFS sharing

Default: ""

admin_override

Admin override

Boolean

Make it possible to assign more resource than the user actually has

Default: null

admin_lock_type

Admin lock type

String

How is the admin lock enforced

Default: null

Validation rules
Rule	Details
Include	Allowed values: `no_lock` `absolute` `not_less` `not_more` Validation error message: %{value} cannot be used

Output parameters

No parameters.

dataset#

Create#

Input parameters#

Output parameters#

Delete#

Input parameters#

Output parameters#

Find_by_name#

Input parameters#

Output parameters#

Index#

Input parameters#

Output parameters#

Inherit#

Input parameters#

Output parameters#

Migrate#

Input parameters#

Output parameters#

Show#

Input parameters#

Output parameters#

Update#

Input parameters#

Output parameters#

Subresources#

dataset

Create

Input parameters

Output parameters

Delete

Input parameters

Output parameters

Find_by_name

Input parameters

Output parameters

Index

Input parameters

Output parameters

Inherit

Input parameters

Output parameters

Migrate

Input parameters

Output parameters

Show

Input parameters

Output parameters

Update

Input parameters

Output parameters

Subresources