Cosmic Admin API Reference

listVlanIpRanges

Lists all VLAN IP ranges.

Request parameters

Parameter NameDescriptionRequired
accountthe account with which the VLAN IP range is associated. Must be used with the domainId parameter.false
domainidthe domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.false
forvirtualnetworktrue if VLAN is of Virtual type, false if Directfalse
idthe ID of the VLAN IP rangefalse
keywordList by keywordfalse
networkidnetwork id of the VLAN IP rangefalse
pagefalse
pagesizefalse
physicalnetworkidphysical network id of the VLAN IP rangefalse
podidthe Pod ID of the VLAN IP rangefalse
projectidproject who will own the VLANfalse
vlanthe ID or VID of the VLAN. Default is an "untagged" VLAN.false
zoneidthe Zone ID of the VLAN IP rangefalse

Response Tags

Response NameDescription
idthe ID of the VLAN IP range
accountthe account of the VLAN IP range
descriptionthe description of the VLAN IP range
domainthe domain name of the VLAN IP range
domainidthe domain ID of the VLAN IP range
endipthe end ip of the VLAN IP range
endipv6the end ipv6 of the VLAN IP range
forvirtualnetworkthe virtual network for the VLAN IP range
gatewaythe gateway of the VLAN IP range
ip6cidrthe cidr of IPv6 network
ip6gatewaythe gateway of IPv6 network
netmaskthe netmask of the VLAN IP range
networkidthe network id of vlan range
physicalnetworkidthe physical network this belongs to
podidthe Pod ID for the VLAN IP range
podnamethe Pod name for the VLAN IP range
projectthe project name of the vlan range
projectidthe project id of the vlan range
startipthe start ip of the VLAN IP range
startipv6the start ipv6 of the VLAN IP range
vlanthe ID or VID of the VLAN.
zoneidthe Zone ID of the VLAN IP range