Cosmic User API Reference


Lists all egress firewall rules for network ID.

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
fordisplaylist resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idLists rule with the specified ID.false
ipaddressidthe ID of IP address of the firewall servicesfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
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 falsefalse
networkidthe network ID for the egress firewall servicesfalse
projectidlist objects by projectfalse
tagsList resources by tags (key/value pairs)false

Response Tags

Response NameDescription
idthe ID of the firewall rule
cidrlistthe cidr list to forward traffic from
endportthe ending port of firewall rule's port range
fordisplayis rule for display to the regular user
icmpcodeerror code for this icmp message
icmptypetype of the icmp message being sent
ipaddressthe public ip address for the firewall rule
ipaddressidthe public ip address id for the firewall rule
networkidthe network id of the firewall rule
protocolthe protocol of the firewall rule
startportthe starting port of firewall rule's port range
statethe state of the rule
tags(*)the list of resource tags associated with the rule
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