Core Virtual Machine Operations
A set of operations for creating virtual machines and retrieving information about your existing virtual machines.
| Endpoint Name | URL | Description |
|---|---|---|
| Create virtual machines | POST /core/virtual-machines | Creates one or more virtual machines with the specified custom configuration and features. |
| List virtual machines | GET /core/virtual-machines | Returns a list of your existing virtual machines. |
| Retrieve virtual machine details | GET /core/virtual-machines/{id} | Retrieves the details of an existing virtual machine. |
The instances object
The response to virtual machine endpoint API requests includes the instances object, which provides comprehensive details about your virtual machines. This information includes hardware specifications, security configuration, current power state, storage details, date and time of initiation, and more.
Attributes
id integer
The unique identifier for the virtual machine.
name string
The name of the virtual machine.
status string
The current status of the virtual machine (e.g., "ACTIVE").
environment object
An object containing information about the environment in which the virtual machine is deployed.
Show child attributes
name string
The name of the environment.
image object
An object containing information about the operating system image installed on the virtual machine.
flavor object
An object containing details about the flavor (hardware configuration) of the virtual machine.
Show child attributes
id integer
The unique identifier for the flavor.
name string
The name of the flavor.
cpu integer
The number of CPUs in the flavor.
ram number
The amount of RAM in the flavor (in gigabytes).
disk integer
The size of the disk associated with the flavor (in gigabytes).
gpu string
The type of GPU associated with the flavor.
gpu_count integer
The number of GPUs associated with the flavor.
os string
The operating system installed on the virtual machine.
keypair object
An object containing information about the SSH key pair associated with the virtual machine.
Show child attributes
name string
The name of the key pair.
volume_attachments array
An array containing information about attached volumes.
Show child attributes
security_rules array
An array containing objects providing details on firewall rules applied to the virtual machine.
Show child attributes
id integer
The unique identifier for the firewall rule.
direction string
The direction of the firewall rule (e.g., "egress", "ingress").
protocol string
The protocol associated with the firewall rule.
port_range_min integer
The minimum port range for the firewall rule.
port_range_max integer
The maximum port range for the firewall rule.
ethertype string
The Ethernet type for the firewall rule (e.g., "IPv4", "IPv6").
remote_ip_prefix string
The remote IP prefix associated with the firewall rule.
status string
The status of the firewall rule (e.g., "SUCCESS").
created_at date-time
The timestamp when the firewall rule was created.
power_state string
The power state of the virtual machine (e.g., "RUNNING").
vm_state string
The state of the virtual machine (e.g., "active").
fixed_ip string
The fixed IP address assigned to the virtual machine.
floating_ip string
The floating IP address assigned to the virtual machine.
floating_ip_status string
The status of the floating IP address (e.g., "NO FLOATING IP").
contract_id integer
The ID of the contract that affects the billing agreement for this virtual machine.
labels array of strings
An array of labels applied to the virtual machine for organizational and identification purposes. These labels can be updated after VM deployment using the update virtual machine labels endpoint.
created_at date-time
The timestamp when the virtual machine was created.
{
"id": 0,
"name": "string",
"status": "string",
"environment": {
"name": "string",
},
"image": {
"name": "string"
},
"flavor": {
"id": 0,
"name": "string",
"cpu": 0,
"ram": 0,
"disk": 0,
"gpu": "string",
"gpu_count": 0
},
"keypair": {
"name": "string"
},
"volume_attachments": [
{
"volume": {
"id": 0,
"name": "string",
"description": "string",
"volume_type": "string",
"size": 0
},
"status": "string",
"device": "string",
"created_at": "1970-01-01T00:00:00.000Z"
}
],
"security_rules": [
{
"id": 0,
"direction": "string",
"protocol": "string",
"port_range_min": 0,
"port_range_max": 0,
"ethertype": "string",
"remote_ip_prefix": "string",
"status": "string",
"created_at": "1970-01-01T00:00:00.000Z"
}
],
"power_state": "string",
"vm_state": "string",
"fixed_ip": "string",
"floating_ip": "string",
"floating_ip_status": "string",
"contract_id": null,
"labels": [],
"created_at": "1970-01-01T00:00:00.000Z",
}