Apache CloudStack 4.20.0.0 Root Admin API Reference
listPublicIpAddresses
Lists all public ip addresses
Request parameters
| Parameter Name | Description | Required |
| account | list resources by account. Must be used with the domainId parameter. | false |
| allocatedonly | limits search results to allocated public IP addresses | false |
| associatednetworkid | lists all public IP addresses associated to the network specified | false |
| domainid | list only resources belonging to the domain specified | false |
| fordisplay | list resources by display flag; only ROOT admin is eligible to pass this parameter | false |
| forloadbalancing | list only IPs used for load balancing | false |
| forsystemvms | true if range is dedicated for system VMs | false |
| forvirtualnetwork | the virtual network for the IP address | false |
| id | lists IP address by ID | false |
| ipaddress | lists the specified IP address | false |
| isrecursive | defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. | false |
| issourcenat | list only source NAT IP addresses | false |
| isstaticnat | list only static NAT IP addresses | false |
| keyword | List by keyword | false |
| listall | If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. | false |
| networkid | lists all public IP addresses by source network ID | false |
| page | false | |
| pagesize | false | |
| physicalnetworkid | lists all public IP addresses by physical network ID | false |
| projectid | list objects by project; if projectid=-1 lists All VMs | false |
| retrieveonlyresourcecount | makes the API's response contains only the resource count | false |
| state | lists all public IP addresses by state | false |
| tags | List resources by tags (key/value pairs) | false |
| vlanid | lists all public IP addresses by VLAN ID | false |
| vpcid | List IPs belonging to the VPC | false |
| zoneid | lists all public IP addresses by zone ID | false |
Response Tags
| Response Name | Description |
| id | public IP address id |
| account | the account the public IP address is associated with |
| allocated | date the public IP address was acquired |
| associatednetworkid | the ID of the Network associated with the IP address |
| associatednetworkname | the name of the Network associated with the IP address |
| domain | the domain the public IP address is associated with |
| domainid | the domain ID the public IP address is associated with |
| domainpath | path of the domain to which the public IP address belongs |
| fordisplay | is public ip for display to the regular user |
| forsystemvms | true if range is dedicated for System VMs |
| forvirtualnetwork | the virtual network for the IP address |
| hasrules | whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined |
| ipaddress | public IP address |
| isportable | is public IP portable across the zones |
| issourcenat | true if the IP address is a source nat address, false otherwise |
| isstaticnat | true if this ip is for static nat, false otherwise |
| issystem | true if this ip is system ip (was allocated as a part of deployVm or createLbRule) |
| networkid | the ID of the Network where ip belongs to |
| networkname | the name of the Network where ip belongs to |
| physicalnetworkid | the physical network this belongs to |
| project | the project name of the address |
| projectid | the project id of the ipaddress |
| purpose | purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value |
| state | State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free |
| virtualmachinedisplayname | virtual machine display name the ip address is assigned to (not null only for static nat Ip) |
| virtualmachineid | virtual machine id the ip address is assigned to |
| virtualmachinename | virtual machine name the ip address is assigned to |
| virtualmachinetype | virtual machine type the ip address is assigned to |
| vlanid | the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only |
| vlanname | the VLAN associated with the IP address |
| vmipaddress | virtual machine (dnat) ip address (not null only for static nat Ip) |
| vpcid | VPC id the ip belongs to |
| vpcname | VPC name the ip belongs to |
| zoneid | the ID of the zone the public IP address belongs to |
| zonename | the name of the zone the public IP address belongs to |
| tags(*) | the list of resource tags associated with ip address |
| account | the account associated with the tag |
| customer | customer associated with the tag |
| domain | the domain associated with the tag |
| domainid | the ID of the domain associated with the tag |
| domainpath | path of the Domain associated with the tag |
| key | tag key name |
| project | the project name where tag belongs to |
| projectid | the project id the tag belongs to |
| resourceid | id of the resource |
| resourcetype | resource type |
| value | tag value |
| jobid | the ID of the latest async job acting on this object |
| jobstatus | the current status of the latest async job acting on this object |