Skip to main content
GET
/
api
/
public
/
v1
/
vms
/
{vmId}
/
snapshots
List snapshots for a VM
curl --request GET \
  --url https://api.vmarea.com/api/v1/api/public/v1/vms/{vmId}/snapshots \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "vmId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "status": "<string>",
      "size": "<string>",
      "sizeRefreshedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://vmarea.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
limit
integer
default:20
Required range: 1 <= x <= 100
​
status
enum<string>
Available options:
CREATING,
COMPLETED,
FAILED

Response

Default Response

​
success
enum<boolean>
required
Available options:
true
​
data
object[]
required
​
pagination
object
required