List snapshots

GET

/snapshots/

Returns a paginated list of all snapshots with optional search filtering. Supports filtering by name and provides snapshot metadata including size, status, and associated instance information.

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

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

Query Params

Responses

🟢200

application/json

Snapshots retrieved successfully

Body

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://barrack.ai/api/snapshots/?page&pageSize&search' \
--header 'X-API-Key: <api-key>'

Response Example

200 - Success - Snapshots Retrieved

{
    "success": true,
    "snapshots": [
        {
            "snapshot_id": "BRK-123456S",
            "name": "prod-backup-dec11",
            "status": "SUCCESS",
            "size": 250,
            "region": "CANADA-1",
            "created_at": "2025-12-11T10:30:00Z",
            "description": "Production backup",
            "instance_id": "BRK-789012D",
            "vm_name": "production-server"
        }
    ],
    "currency_context": "USD",
    "total_count": 1,
    "page": 1,
    "page_size": 10,
    "total_pages": 1,
    "has_next": false,
    "tier": "legacy",
    "supported_regions": [
        "CANADA-1"
    ]
}

Create snapshot

Get snapshot details