Cosmic Domain Admin API Reference

createFirewallRule

Creates a firewall rule for a given IP address

Request parameters

Parameter NameDescriptionRequired
ipaddressidthe IP address id of the port forwarding ruletrue
protocolthe protocol for the firewall rule. Valid values are TCP/UDP/ICMP.true
cidrlistthe CIDR list to forward traffic fromfalse
endportthe ending port of firewall rulefalse
fordisplayan optional field, whether to the display the rule to the end user or notfalse
icmpcodeerror code for this icmp messagefalse
icmptypetype of the ICMP message being sentfalse
startportthe starting port of firewall rulefalse
typetype of firewallrule: system/userfalse

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