API Documentation
Learn how to integrate with our API to manage your virtual machines and resources.
Instance Management
Endpoints for managing virtual machine instances
List Instances
Get a list of all virtual machine instances
GET/api/v2/instancesResponse
{
"data": {
"instances": [
{
"type": "VM",
"id": "550e8400-e29b-41d4-a716-446655440000",
"attributes": {
"name": "My Instance",
"status": "running"
}
}
]
}
}Get Instance
Get details about a specific instance
GET/api/v2/instances/{id}Parameters
id- The ID of the instance to retrieve
Response
{
"type": "instance",
"id": "string",
"name": "string",
"status": "string",
"ipAddress": "string",
"portForwards": [
{
"internal_port": "number",
"external_port": "number"
}
]
}Start Instance
Start a stopped instance
POST/api/v2/instances/{id}/startParameters
id- The ID of the instance to start
Response
{
"data": {
"type": "instance",
"id": "string",
"attributes": {
"status": "starting"
}
}
}Stop Instance
Stop a running instance
POST/api/v2/instances/{id}/stopParameters
id- The ID of the instance to stop
Response
{
"data": {
"type": "instance",
"id": "string",
"attributes": {
"status": "stopping"
}
}
}Delete Instance
Delete an instance and its associated resources
DELETE/api/v2/instances/{id}Parameters
id- The ID of the instance to delete
Response
{
"data": {
"type": "success",
"attributes": {
"message": "Instance deleted successfully"
}
}
}Modify Instance
Modify the resources of a stopped or stopped-disassociated instance
PUT/api/v2/instances/{id}/modifyRequirements
- Instance Status - Instance must be in 'Stopped' or 'StoppedDisassociated' state
- Resource Steps - CPU cores must be in steps of 2, RAM in steps of 8GB, Storage in steps of 50GB (min 100GB)
- Storage Limitation - Storage can only be increased, never decreased
Parameters
id- The ID of the instance to modify
Request Body
{
"cpuCores": 8,
"ramGb": 32,
"diskGb": 200,
"gpus": {
"gpuV0Name": "geforcertx4090-pcie-24gb",
"count": 1
}
}Response
{
"message": "Instance modified successfully"
}