Skip to main content

VmResponse

idstring<uuid>

Value of id.

namestringnullable

Human-readable name of the resource.

projectIdstring<uuid>

Unique identifier of the project in UUID format.

saleIdstring<uuid>

Unique identifier of the sale in UUID format.

imageIdstring<uuid>

Unique identifier of the image used for provisioning.

operationResourceOperation (string)

Allowed value for operation.

Possible values: [Provision, Deprovision, AttachVm, ConfigureVm, DetachVm, Start, Stop, Reboot, CreateBackup, DeleteBackup, RestoreVmFromBackup, CreatePortForward, DeletePortForward, UpdatePortForward]

operationStatusOperationStatus (string)

Current status of the asynchronous operation.

Possible values: [InProgress, Succeeded, Failed]

bootStatusVmBootStatus (string)

Current boot lifecycle status.

Possible values: [Stopped, Running]

cpuinteger<int32>

Number of virtual CPU units.

ramGbnumber<double>

Amount of RAM in gigabytes.

diskGbnumber<double>

Disk size in gigabytes.

createdAtstring<date-time>

Timestamp when the resource was created.

updatedAtstring<date-time>

Timestamp when the resource was last updated.

networks object[]nullable

List of vm network responses.

  • Array [
  • idstring<uuid>

    Value of id.

    namestringnullable

    Human-readable name of the resource.

    typeNetworkType (string)

    Type discriminator of the resource.

    Possible values: [Wan, Lan]

    createdAtstring<date-time>

    Timestamp when the resource was created.

    publicIp object

    Allowed value for public ip.

    geolocationstringnullable

    Value of geolocation.

    ip IPAddress (string)

    Allowed value for ip.

    addressFamilyAddressFamily (string)

    Allowed value for address family.

    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]

    scopeIdinteger<int64>

    Unique identifier of the scope.

    isIPv6Multicastboolean

    Boolean flag that controls is ipv6 multicast.

    isIPv6LinkLocalboolean

    Boolean flag that controls is ipv6 link local.

    isIPv6SiteLocalboolean

    Boolean flag that controls is ipv6 site local.

    isIPv6Teredoboolean

    Boolean flag that controls is ipv6 teredo.

    isIPv6UniqueLocalboolean

    Boolean flag that controls is ipv6 unique local.

    isIPv4MappedToIPv6boolean

    Boolean flag that controls is ipv4 mapped to ipv6.

    addressinteger<int64>deprecated

    IP address value.

  • ]
  • networksInterfaces object[]nullable

    List of vm network interface responses.

  • Array [
  • networkIdstring<uuid>

    Unique identifier of the network in UUID format.

    ip IPAddress (string)

    Allowed value for ip.

    addressFamilyAddressFamily (string)

    Allowed value for address family.

    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]

    scopeIdinteger<int64>

    Unique identifier of the scope.

    isIPv6Multicastboolean

    Boolean flag that controls is ipv6 multicast.

    isIPv6LinkLocalboolean

    Boolean flag that controls is ipv6 link local.

    isIPv6SiteLocalboolean

    Boolean flag that controls is ipv6 site local.

    isIPv6Teredoboolean

    Boolean flag that controls is ipv6 teredo.

    isIPv6UniqueLocalboolean

    Boolean flag that controls is ipv6 unique local.

    isIPv4MappedToIPv6boolean

    Boolean flag that controls is ipv4 mapped to ipv6.

    addressinteger<int64>deprecated

    IP address value.

  • ]
  • portForwardRules object[]nullable

    List of vm port forward rules responses.

  • Array [
  • networkIdstring<uuid>

    Unique identifier of the network in UUID format.

    statusPortForwardStatus (string)

    Current status of the resource.

    Possible values: [Created, Creating, Updating, Deleting]

    rule object

    Allowed value for rule.

    modePortForwardMode (string)

    Mode that defines how the resource should behave.

    Possible values: [SpecificPorts, AllPorts]

    protocolPortForwardProtocol (string)

    Protocol used by the resource or forwarding rule.

    Possible values: [Tcp, Udp, TcpUdp]

    externalPortinteger<int32>nullable

    Publicly exposed port.

    internalPortinteger<int32>nullable

    Internal destination port inside the private network.

  • ]
  • VmResponse
    {
    "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": "InProgress",
    "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
    }
    }
    ]
    }