Skip to main content
POST
Create a manual backup

Authorizations

x-api-key
string
header
required

Long-lived API token created at https://vmarea.com/dashboard/settings/api-keys. Tokens are scope-restricted; this spec lists the scope each endpoint requires.

Path Parameters

vmId
string
required

Body

application/json
note
string
Maximum string length: 500
mode
enum<string>
default:snapshot
Available options:
snapshot,
suspend,
stop
compress
enum<string>
default:zstd
Available options:
zstd,
lzo,
gzip,
none

Response

Default Response

success
enum<boolean>
required
Available options:
true
data
object
required