VPS Snapshots

Create snapshot

post/snapshots

Take a snapshot of a server now, or convert one of its completed backups into a snapshot (backup_id). A snapshot is a permanent copy that does not expire, survives the server and can be deployed as new servers. Billed per GB actually stored per month (compressed, never more than the full disk) until you delete it. Taken from the server, the copy is made with the server running.

Authorization

Authorization*string

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

Request body

application/jsonRequired

vps_id*integer

Server to take the snapshot from

Range1 ≤ value

backup_id?integer | null

Completed backup of that server to convert. Omit it to take the snapshot from the server now

Range1 ≤ value

name*string

Up to 100 characters

description?string | null

Up to 500 characters

Responses

Successful Response

application/json

detail*string

snapshot*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