Get a snapshot | Edgenivo REST API

APIs & SDKs

Get a snapshot

GET/__remote/api.vercel.com/v2/sandboxes/snapshots/{snapshotId}

Retrieves detailed information about a specific snapshot, including its creation time, size, expiration date, and the source session it was created from.

/__remote/api.vercel.com/v2/sandboxes/snapshots/{snapshotId}

const response = await fetch('/__remote/api.vercel.com/v2/sandboxes/snapshots/snapshotId?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "snapshot": {
    "architecture": "amd64",
    "createdAt": "1750344501629",
    "creationMethod": "manual",
    "expiresAt": "1750344501629",
    "id": "snap_123a6c5209bc3778245d011443644c8d27dc2c50",
    "lastUsedAt": "1750344501629",
    "parentId": "snap_parent123",
    "region": "iad1",
    "regions": [],
    "sizeBytes": "104857600",
    "sourceSessionId": "sbx_123a6c5209bc3778245d011443644c8d27dc2c50",
    "status": "created",
    "updatedAt": "1750344501629",
    "workloadType": "sandbox"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

snapshotIdstringRequired

The unique identifier of the snapshot to retrieve.

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Success

snapshotobjectRequired

This object contains information related to a Snapshot of a Edgenivo Sandbox session (v2 API).

Errors

400One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

422Error

429Error

/__remote/api.vercel.com/v2/sandboxes/snapshots/{snapshotId}

const response = await fetch('/__remote/api.vercel.com/v2/sandboxes/snapshots/snapshotId?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "snapshot": {
    "architecture": "amd64",
    "createdAt": "1750344501629",
    "creationMethod": "manual",
    "expiresAt": "1750344501629",
    "id": "snap_123a6c5209bc3778245d011443644c8d27dc2c50",
    "lastUsedAt": "1750344501629",
    "parentId": "snap_parent123",
    "region": "iad1",
    "regions": [],
    "sizeBytes": "104857600",
    "sourceSessionId": "sbx_123a6c5209bc3778245d011443644c8d27dc2c50",
    "status": "created",
    "updatedAt": "1750344501629",
    "workloadType": "sandbox"
  }
}

OpenAPI Specification