Cosmic User API Reference

listFirewallRules

Lists all firewall rules for an IP address.

Request parameters

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	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
id	Lists rule with the specified ID.	false
ipaddressid	the ID of IP address of the firewall services	false
isrecursive	defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.	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	false
networkid	list firewall rules for certain network	false
page		false
pagesize		false
projectid	list objects by project	false
tags	List resources by tags (key/value pairs)	false

Response Name	Description
id	the ID of the firewall rule
cidrlist	the cidr list to forward traffic from
endport	the ending port of firewall rule's port range
fordisplay	is rule for display to the regular user
icmpcode	error code for this icmp message
icmptype	type of the icmp message being sent
ipaddress	the public ip address for the firewall rule
ipaddressid	the public ip address id for the firewall rule
networkid	the network id of the firewall rule
protocol	the protocol of the firewall rule
startport	the starting port of firewall rule's port range
state	the state of the rule
*tags()**	the list of resource tags associated with the rule
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
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