Create snapshot

POST

/instances/{vm_id}/snapshots/create/

Creates a new snapshot from an active VM instance. The VM must be in ACTIVE state. Snapshot creation is asynchronous and billing begins immediately upon successful creation.

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Snapshot created successfully

Body

🟠400

🟠402

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://barrack.ai/api/instances//snapshots/create/' \
--header 'X-API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "description": "string",
    "labels": [
        "string"
    ]
}'

Response Example

200 - Success - Snapshot Created

{
    "success": true,
    "message": "Snapshot created successfully",
    "snapshot": {
        "snapshot_id": "BRK-345678S",
        "name": "new-backup-snapshot",
        "description": "Backup before major update",
        "size": 100,
        "status": "creating",
        "instance_id": "BRK-789012D",
        "region": "CANADA-1",
        "created_at": "2025-12-11T14:45:00Z"
    },
    "tier": "legacy"
}

Delete multiple startup scripts

List snapshots