This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Models

1: Firewall
2: FirewallListResponse
3: FirewallPort
4: FirewallRule
5: FirewallRuleCreateRequest
6: FirewallRuleCreateSingleRequest
7: FirewallRuleListResponse
8: FirewallRuleSetRequest
9: FirewallRuleShowResponse
10: FirewallSetRequest
11: FirewallShowResponse

1 - Firewall

Name	Description	Schema	Default
account_id required	Account ID Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
flavor_name optional	Firewall Size Name Example : `SMALL`	string
flavor_rule_quota optional	Firewall Rule Quota Example : `100`	integer
fw_resource_id required	Fw Resource ID Example : `005fd1d30dea11f08a2c56773bef875b`	string
id required	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
loggable required	Logging Use Example : `False`	boolean
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Firewall Name Example : `FW_IGW_secuVPC`	string
pre_product_id optional	Pre Product ID Example : `76479b7ffee1431198d9beb4502cda08`	string
product_type required	Firewall Product Type Example : `IGW`	enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM)
state required	Firewall State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR, DEPLOYING)
status required	Firewall Status Example : `ENABLE`	enum (ENABLE, DISABLE)
total_rule_count optional	Total Rule Count Example : `8`	integer
vpc_id required	VPC Id Example : `ceb44ea5ecb34a49b16495f9a63b0718`	any of [string, null]
vpc_name required	VPC Name Example : `secuVPC`	any of [string, null]

2 - FirewallListResponse

Name	Description	Schema	Default
count required	count Example : `20`	integer
firewalls required		array[Firewall]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

3 - FirewallPort

Name	Description	Schema	Default
service_type required	Service Protocol Type Example : `TCP`	enum (TCP, UDP, ICMP, IP, TCP_ALL, UDP_ALL, ICMP_ALL, ALL)
service_value optional	Service Port Value Example : `443`	string

4 - FirewallRule

Name	Description	Schema	Default
action required	Firewall Rule Action Example : `ALLOW`	enum (ALLOW, DENY)
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Firewall Rule Description Example : `Firewall rule description example`	any of [string, null]
destination_address required	Destination Address Example : `['10.0.0.1', '10.0.0.2']`	array[string]
destination_interface required	Destination Interface Name Example : `IFW1-v1001dn`	string
direction required	Firewall Rule Direction Example : `INBOUND`	enum (INBOUND, OUTBOUND)
firewall_id required	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
id required	Firewall Rule ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name optional	Firewall Rule Name Example : `b156740b6335468d8354eb9ef8eddf5a`	any of [string, null]
sequence required	Firewall Rule Sequence Example : `100`	integer
service required	Service Port	array[FirewallPort]
source_address required	Source Address Example : `['192.168.1.1', '192.168.1.2']`	array[string]
source_interface required	Source Interface Name Example : `IFW1-v2501up`	string
state required	Firewall Rule State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
status required	Firewall Rule Status Example : `ENABLE`	enum (ENABLE, DISABLE)
vendor_rule_id required	Vendor Rule ID Example : `72`	string

5 - FirewallRuleCreateRequest

Name	Description	Schema	Default
action required	Firewall Rule Action Example : `ALLOW`	enum (ALLOW, DENY)
description optional	Firewall Rule Description Example : `Firewall rule description example`	any of [string, null]
destination_address required	Destination Address Example : `['10.0.0.1', '10.0.0.2']`	array[string]
direction required	Firewall Rule Direction Example : `INBOUND`	enum (INBOUND, OUTBOUND)
order_direction optional	Order Direction Example : `BEFORE`	enum (BEFORE, AFTER, BOTTOM)
order_rule_id optional	Order Rule ID Example : `043aa63459da466faad71fe4fe587031`	string
service required	Service Port	array[FirewallPort]
source_address required	Source Address Example : `['192.168.1.1', '192.168.1.2']`	array[string]
status required	Firewall Rule Status Example : `ENABLE`	enum (ENABLE, DISABLE)

6 - FirewallRuleCreateSingleRequest

Name	Description	Schema	Default
firewall_id required	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
firewall_rule required	Firewall Rule List	FirewallRuleCreateRequest

7 - FirewallRuleListResponse

Name	Description	Schema	Default
count required	count Example : `20`	integer
firewall_rules required		array[FirewallRule]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

8 - FirewallRuleSetRequest

Name	Description	Schema	Default
action required	Firewall Rule Action Example : `ALLOW`	enum (ALLOW, DENY)
description optional	Firewall Rule Description Example : `Firewall rule description example`	any of [string, null]
destination_address required	Destination Address Example : `['10.0.0.1', '10.0.0.2']`	array[string]
direction required	Firewall Rule Direction Example : `INBOUND`	enum (INBOUND, OUTBOUND)
service required	Service Port	array[FirewallPort]
source_address required	Source Address Example : `['192.168.1.1', '192.168.1.2']`	array[string]

9 - FirewallRuleShowResponse

Name	Description	Schema	Default
firewall_rule required		FirewallRule

10 - FirewallSetRequest

Name	Description	Schema	Default
flavor_name optional	Firewall Size Name Example : `EXSMALL`	enum (EXSMALL, SMALL, MEDIUM, LARGE, EXLARGE)
loggable optional	Logging Use Example : `False`	boolean

11 - FirewallShowResponse

Name	Description	Schema	Default
firewall required		Firewall