PublicIpResponsePagedResult

items object[]nullable

List of public ip responses.

Array [

idstring<uuid>

Value of id.

projectIdstring<uuid>

Unique identifier of the project in UUID format.

networkIdstring<uuid>

Unique identifier of the network in UUID format.

ip IPAddress (string)

Allowed value for ip.

addressFamilyAddressFamily (string)

Allowed value for address family.

Open schema reference: AddressFamily

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 public ip 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.

Open schema reference: PortForwardStatus

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

rule object

Allowed value for rule.

modePortForwardMode (string)

Mode that defines how the resource should behave.

Open schema reference: PortForwardMode

Possible values: [SpecificPorts, AllPorts]

protocolPortForwardProtocol (string)

Protocol used by the resource or forwarding rule.

Open schema reference: PortForwardProtocol

Possible values: [Tcp, Udp, TcpUdp]

externalPortinteger<int32>nullable

Publicly exposed port.

internalPortinteger<int32>nullable

Internal destination port inside the private network.

]

vms object[]nullable

List of public ip vm responses.

Array [

vmIdstring<uuid>

Unique identifier of the virtual machine in UUID format.

vmNamestringnullable

Human-readable name of the virtual machine.

]

]

totalinteger<int32>

Total number of items available.

pageinteger<int32>

Current page number of the paginated result.

pageSizeinteger<int32>

Maximum number of items returned per page.

totalPagesinteger<int32>

Total number of pages available.

hasNextPageboolean

Indicates whether another result page is available.

PublicIpResponsePagedResult

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "networkId": "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
          }
        }
      ],
      "vms": [
        {
          "vmId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "vmName": "string"
        }
      ]
    }
  ],
  "total": 0,
  "page": 0,
  "pageSize": 0,
  "totalPages": 0,
  "hasNextPage": true
}