CubePathDOCS

VPS Snapshots

Update snapshot

patch/snapshots/{snapshot_uuid}

Rename a snapshot, change its description or move it to another project of your organization.

Autorización

Authorization
Authorization*string

Bearer YOUR_API_TOKEN con un token de API. También vale la cabecera X-API-Key: YOUR_API_TOKEN.

Parámetros de ruta

snapshot_uuid*string

Cuerpo de la petición

application/jsonObligatorio
name?string | null

Up to 100 characters

description?string | null

Up to 500 characters. Send null to clear it

project_id?integer | null

Move the snapshot to another project of the organization

Rango1 ≤ value

Respuestas

Successful Response

application/json

detail*string
snapshot*SnapshotOut
Propiedades (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

Por defectotrue
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
Propiedades (2)
name*string
description?string | null
store_location?SnapshotLocationOut | null
Propiedades (2)
name*string
description?string | null
project_id?integer | null
source_vps*SnapshotSourceVPSOut
Propiedades (3)
id?integer | null
name?string | null
deleted*boolean
template*SnapshotTemplateOut
Propiedades (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