List Instance eligible for snapshot creation

GET

/snapshots/instances/list/

Returns a paginated list of active VM instances that are eligible for snapshot operations. Only includes VMs in ACTIVE state with optional search filtering by name.

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

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

Query Params

Responses

🟢200

application/json

Instances retrieved successfully

Body

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Success - VMs Retrieved

{
    "success": true,
    "instances": [
        {
            "instance_id": "BRK-789012D",
            "name": "production-server",
            "status": "RUNNING",
            "region": "CANADA-1"
        },
        {
            "instance_id": "BRK-890123D",
            "name": "ml-training",
            "status": "RUNNING",
            "region": "CANADA-1"
        }
    ],
    "total_count": 2,
    "page": 1,
    "page_size": 10,
    "total_pages": 1,
    "has_next": false,
    "currency_context": "USD",
    "request_id": "e7f8g9h0"
}

Get instance billing

List SSH keys