Skip to content

dataset_expansion

Browse dataset expansions

Create

Path
POST /v7.0/dataset_expansions
Description
Create dataset expansion
Authentication required
yes
Scope
dataset_expansion#create
Aliases
new
Blocking
yes

Input parameters

Layout
object
Namespace
dataset_expansion
ParameterTypeRequiredDetails
dataset
Dataset
 Resource yes

Dataset the VPS resides in
added_space
Added space
 Integer yes

Default: null

Validation rules
RuleDetails
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

Number
  • Must be a number after parameter type conversion.
  • Minimum: 1 (inclusive).

Validation error message: must be at least 1
enable_notifications
Enable notifications
 Boolean no

Send emails about the expansion

Default: null
enable_shrink
Enable shrink
 Boolean no

Automatically shrink the dataset when possible

Default: null
stop_vps
Shutdown VPS
 Boolean no

Shut down the VPS after extra space is used too long or there are too many expansions

Default: null
max_over_refquota_seconds
Max_over_refquota_seconds
 Integer yes

Default: null

Validation rules
RuleDetails
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

Layout
object
Namespace
dataset_expansion
ParameterTypeDescription
id
ID
 Integer
vps
VPS
 Resource
dataset
Dataset
 Resource Dataset the VPS resides in
state
State
 String
original_refquota
Original reference quota
 Integer
added_space
Added space
 Integer
enable_notifications
Enable notifications
 Boolean Send emails about the expansion
enable_shrink
Enable shrink
 Boolean Automatically shrink the dataset when possible
stop_vps
Shutdown VPS
 Boolean Shut down the VPS after extra space is used too long or there are too many expansions
over_refquota_seconds
Over_refquota_seconds
 Integer
max_over_refquota_seconds
Max_over_refquota_seconds
 Integer
created_at
Created_at
 Datetime

Index

Path
GET /v7.0/dataset_expansions
Description
List dataset expansions
Authentication required
yes
Scope
dataset_expansion#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
dataset_expansion
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
dataset_expansions
ParameterTypeDescription
id
ID
 Integer
vps
VPS
 Resource
dataset
Dataset
 Resource Dataset the VPS resides in
state
State
 String
original_refquota
Original reference quota
 Integer
added_space
Added space
 Integer
enable_notifications
Enable notifications
 Boolean Send emails about the expansion
enable_shrink
Enable shrink
 Boolean Automatically shrink the dataset when possible
stop_vps
Shutdown VPS
 Boolean Shut down the VPS after extra space is used too long or there are too many expansions
over_refquota_seconds
Over_refquota_seconds
 Integer
max_over_refquota_seconds
Max_over_refquota_seconds
 Integer
created_at
Created_at
 Datetime

Register_expanded

Path
POST /v7.0/dataset_expansions/register_expanded
Description
Create dataset expansion for an already expanded dataset
Authentication required
yes
Scope
dataset_expansion#register_expanded
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
dataset_expansion
ParameterTypeRequiredDetails
dataset
Dataset
 Resource no

Dataset the VPS resides in
original_refquota
Original reference quota
 Integer no

Default: null

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

Validation error message: must be at least 1
enable_notifications
Enable notifications
 Boolean no

Send emails about the expansion

Default: null
enable_shrink
Enable shrink
 Boolean no

Automatically shrink the dataset when possible

Default: null
stop_vps
Shutdown VPS
 Boolean no

Shut down the VPS after extra space is used too long or there are too many expansions

Default: null
max_over_refquota_seconds
Max_over_refquota_seconds
 Integer no

Default: null

Output parameters

Layout
object
Namespace
dataset_expansion
ParameterTypeDescription
id
ID
 Integer
vps
VPS
 Resource
dataset
Dataset
 Resource Dataset the VPS resides in
state
State
 String
original_refquota
Original reference quota
 Integer
added_space
Added space
 Integer
enable_notifications
Enable notifications
 Boolean Send emails about the expansion
enable_shrink
Enable shrink
 Boolean Automatically shrink the dataset when possible
stop_vps
Shutdown VPS
 Boolean Shut down the VPS after extra space is used too long or there are too many expansions
over_refquota_seconds
Over_refquota_seconds
 Integer
max_over_refquota_seconds
Max_over_refquota_seconds
 Integer
created_at
Created_at
 Datetime

Show

Path
GET /v7.0/dataset_expansions/{dataset_expansion_id}
Description
Show dataset expansion
Authentication required
yes
Scope
dataset_expansion#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
dataset_expansion
ParameterTypeDescription
id
ID
 Integer
vps
VPS
 Resource
dataset
Dataset
 Resource Dataset the VPS resides in
state
State
 String
original_refquota
Original reference quota
 Integer
added_space
Added space
 Integer
enable_notifications
Enable notifications
 Boolean Send emails about the expansion
enable_shrink
Enable shrink
 Boolean Automatically shrink the dataset when possible
stop_vps
Shutdown VPS
 Boolean Shut down the VPS after extra space is used too long or there are too many expansions
over_refquota_seconds
Over_refquota_seconds
 Integer
max_over_refquota_seconds
Max_over_refquota_seconds
 Integer
created_at
Created_at
 Datetime

Update

Path
PUT /v7.0/dataset_expansions/{dataset_expansion_id}
Description
Update dataset expansion
Authentication required
yes
Scope
dataset_expansion#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
dataset_expansion
ParameterTypeRequiredDetails
enable_notifications
Enable notifications
 Boolean no

Send emails about the expansion

Default: null
enable_shrink
Enable shrink
 Boolean no

Automatically shrink the dataset when possible

Default: null
stop_vps
Shutdown VPS
 Boolean no

Shut down the VPS after extra space is used too long or there are too many expansions

Default: null
max_over_refquota_seconds
Max_over_refquota_seconds
 Integer no

Default: null

Output parameters

Layout
object
Namespace
dataset_expansion
ParameterTypeDescription
id
ID
 Integer
vps
VPS
 Resource
dataset
Dataset
 Resource Dataset the VPS resides in
state
State
 String
original_refquota
Original reference quota
 Integer
added_space
Added space
 Integer
enable_notifications
Enable notifications
 Boolean Send emails about the expansion
enable_shrink
Enable shrink
 Boolean Automatically shrink the dataset when possible
stop_vps
Shutdown VPS
 Boolean Shut down the VPS after extra space is used too long or there are too many expansions
over_refquota_seconds
Over_refquota_seconds
 Integer
max_over_refquota_seconds
Max_over_refquota_seconds
 Integer
created_at
Created_at
 Datetime

Subresources