VmResponsePagedResponse
A generic page of results, used by list endpoints across this API.
items object[]nullable
The items on this page.
Id of the VM.
Host name of the VM.
Id of the project the VM belongs to.
Id of the tariff (sale) the VM was provisioned with.
Id of the OS image the VM was installed from.
Last (or currently in-flight) operation recorded for the resource.
Possible values: [Provision, Deprovision, AttachVm, ConfigureVm, DetachVm, Start, Stop, Reboot, CreateBackup, DeleteBackup, RestoreVmFromBackup, CreatePortForward, DeletePortForward, UpdatePortForward, Resize, RebuildVm]
Current status of the asynchronous operation.
Possible values: [Queued, InProgress, Compensation, Succeeded, Failed]
Current status of the resource.
Possible values: [creating, active, updating, deleting, failed]
Current boot lifecycle status.
Possible values: [Stopped, Running]
Number of CPU cores allocated to the VM.
Amount of RAM allocated to the VM, in gigabytes.
Amount of disk space allocated to the VM, in gigabytes.
When the VM was created.
When the VM was last updated.
networks object[]nullable
Networks the VM is attached to.
Id of the network.
Name of the network.
Type of the resource.
Possible values: [Wan, Lan]
When the network was created.
publicIp object
The public IP address bound to the network, when one is attached.
Geolocation of the public IP.
ip IPAddress (string)
The IP address itself, in dotted-decimal form.
Address family of the address (IPv4 or IPv6).
Possible values: [Unknown, Unspecified, Unix, InterNetwork, ImpLink, Pup, Chaos, NS, Ipx, Iso, Osi, Ecma, DataKit, Ccitt, Sna, DecNet, DataLink, Lat, HyperChannel, AppleTalk, NetBios, VoiceView, FireFox, Banyan, Atm, InterNetworkV6, Cluster, Ieee12844, Irda, NetworkDesigners, Max, Packet, ControllerAreaNetwork]
IPv6 scope identifier of the address.
Whether the address is an IPv6 multicast address.
Whether the address is an IPv6 link-local address.
Whether the address is an IPv6 site-local address.
Whether the address is an IPv6 Teredo address.
Whether the address is an IPv6 unique-local address.
Whether the address is an IPv4 address mapped into the IPv6 space.
IP address value.
networksInterfaces object[]nullable
The VM's network interfaces and their assigned addresses.
Id of the network this interface is attached to.
ip IPAddress (string)
The IP address itself, in dotted-decimal form.
Address family of the address (IPv4 or IPv6).
Possible values: [Unknown, Unspecified, Unix, InterNetwork, ImpLink, Pup, Chaos, NS, Ipx, Iso, Osi, Ecma, DataKit, Ccitt, Sna, DecNet, DataLink, Lat, HyperChannel, AppleTalk, NetBios, VoiceView, FireFox, Banyan, Atm, InterNetworkV6, Cluster, Ieee12844, Irda, NetworkDesigners, Max, Packet, ControllerAreaNetwork]
IPv6 scope identifier of the address.
Whether the address is an IPv6 multicast address.
Whether the address is an IPv6 link-local address.
Whether the address is an IPv6 site-local address.
Whether the address is an IPv6 Teredo address.
Whether the address is an IPv6 unique-local address.
Whether the address is an IPv4 address mapped into the IPv6 space.
IP address value.
portForwardRules object[]nullable
Port forwarding rules configured for the VM.
Id of the network the rule applies to.
Current status of the resource.
Possible values: [Created, Creating, Updating, Deleting]
rule object
Parameters of the rule: protocol, mode and ports.
Mode that defines how the resource should behave.
Possible values: [SpecificPorts, AllPorts]
Protocol used by the resource or forwarding rule.
Possible values: [Tcp, Udp, TcpUdp]
The externally exposed port, when applicable for the selected mode.
The internal (VM-side) port the traffic is forwarded to, when applicable for the selected mode.
Total number of items across all pages.
The current page number, starting at 1.
Number of items per page.
Total number of pages available.
Whether a next page is available.
{
"items": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"saleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"imageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"operation": "Provision",
"operationStatus": "Queued",
"status": "creating",
"bootStatus": "Stopped",
"cpu": 0,
"ramGb": 0,
"diskGb": 0,
"createdAt": "2024-07-29T15:51:28.071Z",
"updatedAt": "2024-07-29T15:51:28.071Z",
"networks": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"type": "Wan",
"createdAt": "2024-07-29T15:51:28.071Z",
"publicIp": {
"geolocation": "string",
"ip": "192.168.0.1"
}
}
],
"networksInterfaces": [
{
"networkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ip": "192.168.0.1"
}
],
"portForwardRules": [
{
"networkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "Created",
"rule": {
"mode": "SpecificPorts",
"protocol": "Tcp",
"externalPort": 0,
"internalPort": 0
}
}
]
}
],
"total": 0,
"page": 0,
"pageSize": 0,
"totalPages": 0,
"hasNextPage": true
}