VPS Snapshots

List snapshots

get/snapshots

View the snapshots of your organization: permanent copies of server backups that you can deploy as new servers in any location.

Authorization

Authorization*string

Bearer YOUR_API_TOKEN with an API token. The X-API-Key: YOUR_API_TOKEN header works too.

Query parameters

project_id?integer | null

Range1 ≤ value

status?string | null

pending, converting, available, failed or deleting

source_vps_id?integer | null

Range1 ≤ value

location_name?string | null

Rangelength ≤ 100

limit?integer

Range1 ≤ value ≤ 100Default50

offset?integer

Range0 ≤ valueDefault0

Responses

Successful Response

application/json

snapshots*array<SnapshotOut>

Properties (22)

uuid*string

origin*string

vps (taken from the server) or backup (converted from a backup)

name*string

description?string | null

status*string

pending, converting, available, failed or deleting

healthy?boolean

False when the stored copy failed a health check: the snapshot can not be deployed

Defaulttrue

os_type?string | null

linux or windows, known once the conversion has run

disk_gb?integer | null

estimated_gb*integer

billable_gb?number | null

GB stored and billed: compressed size rounded up to 0.01 GB, at least 1 GB and never above the disk. Null until the snapshot is available

location?SnapshotLocationOut | null

Properties (2)

name*string

description?string | null

store_location?SnapshotLocationOut | null

Properties (2)

name*string

description?string | null

project_id?integer | null

source_vps*SnapshotSourceVPSOut

Properties (3)

id?integer | null

name?string | null

deleted*boolean

template*SnapshotTemplateOut

Properties (4)

template_name?string | null

name?string | null

operating_system?string | null

min_ram?integer | null

Minimum plan RAM in MB of the source image, null without one

price_gb_month*number

USD per GB stored per month

monthly_cost*number

hourly_cost*number

max_monthly_cost*number

Monthly cost if the copy took the whole disk; the real cost is usually lower

deploying_count*integer

created_at?string | null

available_at?string | null

total*integer