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 discriminator of the resource.
Possible values: [Wan, Lan]
Allowed value for operation.
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]
The date and time (UTC) at which the network 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.
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]
Unique identifier of the scope.
Boolean flag that controls is ipv6 multicast.
Boolean flag that controls is ipv6 link local.
Boolean flag that controls is ipv6 site local.
Boolean flag that controls is ipv6 teredo.
Boolean flag that controls is ipv6 unique local.
Boolean flag that controls is ipv4 mapped to ipv6.
IP address value.
Value of prefix length.
poolStartIp IPAddress (string)
First IP address in the allocation pool.
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]
Unique identifier of the scope.
Boolean flag that controls is ipv6 multicast.
Boolean flag that controls is ipv6 link local.
Boolean flag that controls is ipv6 site local.
Boolean flag that controls is ipv6 teredo.
Boolean flag that controls is ipv6 unique local.
Boolean flag that controls is ipv4 mapped to ipv6.
IP address value.
poolEndIpInclusive IPAddress (string)
Last IP address included in the allocation pool.
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]
Unique identifier of the scope.
Boolean flag that controls is ipv6 multicast.
Boolean flag that controls is ipv6 link local.
Boolean flag that controls is ipv6 site local.
Boolean flag that controls is ipv6 teredo.
Boolean flag that controls is ipv6 unique local.
Boolean flag that controls is ipv4 mapped to ipv6.
IP address value.
gatewayIp IPAddress (string)
Gateway IP address for the subnet.
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]
Unique identifier of the scope.
Boolean flag that controls is ipv6 multicast.
Boolean flag that controls is ipv6 link local.
Boolean flag that controls is ipv6 site local.
Boolean flag that controls is ipv6 teredo.
Boolean flag that controls is ipv6 unique local.
Boolean flag that controls is ipv4 mapped to ipv6.
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)
Allowed value for ip.
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]
Unique identifier of the scope.
Boolean flag that controls is ipv6 multicast.
Boolean flag that controls is ipv6 link local.
Boolean flag that controls is ipv6 site local.
Boolean flag that controls is ipv6 teredo.
Boolean flag that controls is ipv6 unique local.
Boolean flag that controls is ipv4 mapped to ipv6.
IP address value.
publicIp object
Allowed value for public ip.
Id of the public IP.
ip IPAddress (string)
Allowed value for ip.
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]
Unique identifier of the scope.
Boolean flag that controls is ipv6 multicast.
Boolean flag that controls is ipv6 link local.
Boolean flag that controls is ipv6 site local.
Boolean flag that controls is ipv6 teredo.
Boolean flag that controls is ipv6 unique local.
Boolean flag that controls is ipv4 mapped to ipv6.
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
Allowed value for rule.
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",
"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
}