Apache CloudStack 4.18.0.0 Root Admin API Reference

listPublicIpAddresses

Lists all public ip addresses

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
allocatedonlylimits search results to allocated public IP addressesfalse
associatednetworkidlists all public IP addresses associated to the network specifiedfalse
domainidlist only resources belonging to the domain specifiedfalse
fordisplaylist resources by display flag; only ROOT admin is eligible to pass this parameterfalse
forloadbalancinglist only IPs used for load balancingfalse
forvirtualnetworkthe virtual network for the IP addressfalse
idlists IP address by IDfalse
ipaddresslists the specified IP addressfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
issourcenatlist only source NAT IP addressesfalse
isstaticnatlist only static NAT IP addressesfalse
keywordList by keywordfalse
listallIf 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
networkidlists all public IP addresses by source network IDfalse
pagefalse
pagesizefalse
physicalnetworkidlists all public IP addresses by physical network IDfalse
projectidlist objects by project; if projectid=-1 lists All VMsfalse
statelists all public IP addresses by statefalse
tagsList resources by tags (key/value pairs)false
vlanidlists all public IP addresses by VLAN IDfalse
vpcidList IPs belonging to the VPCfalse
zoneidlists all public IP addresses by zone IDfalse

Response Tags

Response NameDescription
idpublic IP address id
accountthe account the public IP address is associated with
allocateddate the public IP address was acquired
associatednetworkidthe ID of the Network associated with the IP address
associatednetworknamethe name of the Network associated with the IP address
domainthe domain the public IP address is associated with
domainidthe domain ID the public IP address is associated with
fordisplayis public ip for display to the regular user
forvirtualnetworkthe virtual network for the IP address
ipaddresspublic IP address
isportableis public IP portable across the zones
issourcenattrue if the IP address is a source nat address, false otherwise
isstaticnattrue if this ip is for static nat, false otherwise
issystemtrue if this ip is system ip (was allocated as a part of deployVm or createLbRule)
networkidthe ID of the Network where ip belongs to
networknamethe name of the Network where ip belongs to
physicalnetworkidthe physical network this belongs to
projectthe project name of the address
projectidthe project id of the ipaddress
purposepurpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value
stateState of the ip address. Can be: Allocatin, Allocated and Releasing
virtualmachinedisplaynamevirtual machine display name the ip address is assigned to (not null only for static nat Ip)
virtualmachineidvirtual machine id the ip address is assigned to (not null only for static nat Ip)
virtualmachinenamevirtual machine name the ip address is assigned to (not null only for static nat Ip)
vlanidthe ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only
vlannamethe VLAN associated with the IP address
vmipaddressvirtual machine (dnat) ip address (not null only for static nat Ip)
vpcidVPC id the ip belongs to
vpcnameVPC name the ip belongs to
zoneidthe ID of the zone the public IP address belongs to
zonenamethe name of the zone the public IP address belongs to
tags(*)the list of resource tags associated with ip address
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object