VM images
VM images
VM images endpoints of the Ellipsis REST API.
| Method | Path | Required permissions |
|---|---|---|
| GET | /v1/vm-images | read:environments |
Token access
- API key
- Supported.
- CLI user token
- Supported.
- Sandbox token
- Unavailable. Not supported by sandbox tokens, even with permissions.ellipsis enabled.
Higher permission levels include lower levels: read < write < delete.
Use limit and offset to page through results.
Query parameters
limitdefault
50integeroffsetdefault
0integercurl "https://api.ellipsis.dev/v1/vm-images" \
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN"import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
result = client.vm_images.list()
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const result = await client.vmImages.list();
console.log(result);Request
Response
Example response, 200
{
"next_offset": 0
}
| Method | Path | Required permissions |
|---|---|---|
| GET | /v1/vm-images/{image_id} | read:environments |
Token access
- API key
- Supported.
- CLI user token
- Supported.
- Sandbox token
- Unavailable. Not supported by sandbox tokens, even with permissions.ellipsis enabled.
Higher permission levels include lower levels: read < write < delete.
Path parameters
image_idstringrequired
curl "https://api.ellipsis.dev/v1/vm-images/{image_id}" \
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN"import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
result = client.vm_images.get("...")
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const result = await client.vmImages.get('...');
console.log(result);Request
Response
Example response, 200
{
"cache_key": "string",
"created_at": "2026-01-01T00:00:00Z",
"expires_at": "2026-01-01T00:00:00Z",
"id": "string",
"snapshot_id": "string",
"source": "provisioning",
"status": "ready"
}