Skip to main content
POST
/
api
/
public
/
v1
/
vms
/
{vmId}
/
backups
Create a manual backup
curl --request POST \
  --url https://api.vmarea.com/api/v1/api/public/v1/vms/{vmId}/backups \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "note": "<string>",
  "mode": "snapshot",
  "compress": "zstd"
}
'
{
  "success": true,
  "data": {
    "backup": {
      "id": "<string>",
      "vmId": "<string>",
      "type": "<string>",
      "status": "<string>",
      "size": "<string>",
      "note": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    },
    "actionId": "<string>"
  }
}

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