Skip to content

snapshot_download

Manage download links of dataset snapshots

Create

Path
POST /v7.0/snapshot_downloads
Description
Download a snapshot
Authentication required
yes
Scope
snapshot_download#create
Aliases
new
Blocking
yes

Input parameters

Layout
object
Namespace
snapshot_download
ParameterTypeRequiredDetails
snapshot
Snapshot
 Resource yes
from_snapshot
From snapshot
 Resource no
format
Format
 String no

Default: archive

Validation rules
RuleDetails
Include

Allowed values:

  • archive
  • stream
  • incremental_stream

Validation error message: %{value} cannot be used
send_mail
Send_mail
 Boolean no

Default: true

Output parameters

Layout
object
Namespace
snapshot_download
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
snapshot
Snapshot
 Resource
from_snapshot
From snapshot
 Resource
format
Format
 String
file_name
File name
 String
url
Url
 String URL at which the archive can be downloaded
size
Size
 Integer Size of the archive in MiB
sha256sum
Sha256sum
 String Control checksum
ready
Ready
 Boolean True if the archive is complete and ready for download
expiration_date
Expiration date
 Datetime The archive is deleted when expiration date passes

Delete

Path
DELETE /v7.0/snapshot_downloads/{snapshot_download_id}
Description
Delete download link
Authentication required
yes
Scope
snapshot_download#delete
Aliases
destroy
Blocking
yes

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/snapshot_downloads
Description
Authentication required
yes
Scope
snapshot_download#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
snapshot_download
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
dataset
Dataset
 Resource no

Dataset the VPS resides in
snapshot
Snapshot
 Resource no

Output parameters

Layout
object_list
Namespace
snapshot_downloads
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
snapshot
Snapshot
 Resource
from_snapshot
From snapshot
 Resource
format
Format
 String
file_name
File name
 String
url
Url
 String URL at which the archive can be downloaded
size
Size
 Integer Size of the archive in MiB
sha256sum
Sha256sum
 String Control checksum
ready
Ready
 Boolean True if the archive is complete and ready for download
expiration_date
Expiration date
 Datetime The archive is deleted when expiration date passes

Show

Path
GET /v7.0/snapshot_downloads/{snapshot_download_id}
Description
Authentication required
yes
Scope
snapshot_download#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
snapshot_download
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
snapshot
Snapshot
 Resource
from_snapshot
From snapshot
 Resource
format
Format
 String
file_name
File name
 String
url
Url
 String URL at which the archive can be downloaded
size
Size
 Integer Size of the archive in MiB
sha256sum
Sha256sum
 String Control checksum
ready
Ready
 Boolean True if the archive is complete and ready for download
expiration_date
Expiration date
 Datetime The archive is deleted when expiration date passes