Skip to content

dataset.snapshot

Manage dataset snapshots

Create

Path
POST /v7.0/datasets/{dataset_id}/snapshots
Description
Create snapshot
Authentication required
yes
Scope
dataset.snapshot#create
Aliases
new
Blocking
yes

Input parameters

Layout
object
Namespace
snapshot
ParameterTypeRequiredDetails
label
Label
 String no

Default: null

Output parameters

Layout
object
Namespace
snapshot
ParameterTypeDescription
id
Id
 Integer
dataset
Dataset
 Resource Dataset the VPS resides in
name
Name
 String
label
Label
 String
created_at
Created_at
 Datetime
history_id
History_id
 Integer
mount
Mount
 Resource
export
Export
 Resource Filter outages affecting a specific export

Delete

Path
DELETE /v7.0/datasets/{dataset_id}/snapshots/{snapshot_id}
Description
Destroy a snapshot
Authentication required
yes
Scope
dataset.snapshot#delete
Aliases
destroy
Blocking
yes

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/datasets/{dataset_id}/snapshots
Description
List snapshots
Authentication required
yes
Scope
dataset.snapshot#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
snapshot
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
snapshots
ParameterTypeDescription
id
Id
 Integer
dataset
Dataset
 Resource Dataset the VPS resides in
name
Name
 String
label
Label
 String
created_at
Created_at
 Datetime
history_id
History_id
 Integer
mount
Mount
 Resource
export
Export
 Resource Filter outages affecting a specific export

Rollback

Path
POST /v7.0/datasets/{dataset_id}/snapshots/{snapshot_id}/rollback
Description
Rollback to a snapshot
Authentication required
yes
Scope
dataset.snapshot#rollback
Aliases
Blocking
yes

Input parameters

No parameters.

Output parameters

No parameters.

Show

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

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
snapshot
ParameterTypeDescription
id
Id
 Integer
dataset
Dataset
 Resource Dataset the VPS resides in
name
Name
 String
label
Label
 String
created_at
Created_at
 Datetime
history_id
History_id
 Integer
mount
Mount
 Resource
export
Export
 Resource Filter outages affecting a specific export