Skip to main content

NetworkResponse

idstring<uuid>

Value of id.

projectIdstring<uuid>

Unique identifier of the project in UUID format.

namestringnullable

Human-readable name of the resource.

typeNetworkType (string)

Type discriminator of the resource.

Possible values: [Wan, Lan]

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]

createdAtstring<date-time>

Timestamp when the resource was created.

subnet object

Allowed value for subnet.

cidr IPNetwork (string)

CIDR block describing the subnet or network range.

baseAddress IPAddress (string)

Allowed value for base address.

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.

prefixLengthinteger<int32>

Value of prefix length.

poolStartIp IPAddress (string)

First IP address in the allocation pool.

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.

poolEndIpInclusive IPAddress (string)

Last IP address included in the allocation pool.

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.

gatewayIp IPAddress (string)

Gateway IP address for the subnet.

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.

vmsInterfaces object[]nullable

List of network vm interface responses.

  • Array [
  • vmIdstring<uuid>

    Unique identifier of the virtual machine in UUID format.

    vmNamestringnullable

    Human-readable name of the virtual machine.

    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.

  • ]
  • publicIp object

    Allowed value for public ip.

    idstring<uuid>

    Value of id.

    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.

    geolocationstringnullable

    Value of geolocation.

    portForwardRules object[]nullable

    List of network port forward rule responses.

  • Array [
  • vmIdstring<uuid>

    Unique identifier of the virtual machine in UUID format.

    vmNamestringnullable

    Human-readable name of the virtual machine.

    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.

  • ]
  • NetworkResponse
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "type": "Wan",
    "operation": "Provision",
    "operationStatus": "InProgress",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "subnet": {
    "cidr": "10.0.0.0/24",
    "poolStartIp": "192.168.0.1",
    "poolEndIpInclusive": "192.168.0.1",
    "gatewayIp": "192.168.0.1"
    },
    "vmsInterfaces": [
    {
    "vmId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "vmName": "string",
    "ip": "192.168.0.1"
    }
    ],
    "publicIp": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ip": "192.168.0.1",
    "geolocation": "string",
    "portForwardRules": [
    {
    "vmId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "vmName": "string",
    "status": "Created",
    "rule": {
    "mode": "SpecificPorts",
    "protocol": "Tcp",
    "externalPort": 0,
    "internalPort": 0
    }
    }
    ]
    }
    }