Apache CloudStack 4.23.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 |
| forprovider | true if range is dedicated for external network provider | 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 Instances | false |
| retrieveonlyresourcecount | Makes the API's response contains only the resource count | false |
| state | Lists all public IP addresses by state. A comma-separated list of states can be passed. | 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 |
| forprovider | true if range is dedicated for external network providers |
| 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 IP address |
| 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 | Instance display name the IP address is assigned to (not null only for static NAT IP) |
| virtualmachineid | Instance id the IP address is assigned to |
| virtualmachinename | Instance name the IP address is assigned to |
| virtualmachinetype | Instance 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 | Instance (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 |