NetworkResponsePagedResponse
A generic page of results, used by list endpoints across this API.
items object[]nullable
The items on this page.
Id of the network.
Id of the project the network belongs to.
The network's display name, when set.
Type of the resource.
Possible values: [Wan, Lan]
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]
The date and time (UTC) at which the network was created.
subnet object
The network's addressing: CIDR block, gateway and address pool.
cidr IPNetwork (string)
CIDR block describing the subnet or network range.
baseAddress IPAddress (string)
First address of the network range.
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.
Prefix length of the network, in bits (the /24 in 10.0.0.0/24).
poolStartIp IPAddress (string)
First IP address in the allocation pool.
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.
poolEndIpInclusive IPAddress (string)
Last IP address included in the allocation pool.
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.
gatewayIp IPAddress (string)
Gateway IP address for the subnet.
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.
vmsInterfaces object[]nullable
The VMs attached to the network and their addresses.
Id of the attached VM.
Name of the VM, when known.
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.
publicIp object
The public IP address bound to the network, when one is attached.
Id 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.
The geographic location associated with the public IP.
portForwardRules object[]nullable
Port forwarding rules configured on the public IP.
Id of the VM the rule targets.
Name of the target VM, when known.
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",
"projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"type": "Wan",
"operation": "Provision",
"operationStatus": "Queued",
"status": "creating",
"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
}
}
]
}
}
],
"total": 0,
"page": 0,
"pageSize": 0,
"totalPages": 0,
"hasNextPage": true
}