1.0

get /v1/firewalls/rules

Description

Get firewall rule list.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	firewall_id required	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None
query	src_ip optional	Source IP Example : `192.168.1.1`	string	None
query	dst_ip optional	Destination IP Example : `192.168.1.1`	string	None
query	description optional	Firewall Rule Description Example : `Firewall rule description example`	string	None
query	state optional	Firewall Rule State	array[enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)]	[]
query	status optional	Firewall Rule Status Example :	enum (ENABLE, DISABLE)	None
query	fetch_all optional	Firewall Rule Fetch ALL Example : `False`	boolean	False

Responses

HTTP Code	Description	Schema
200	OK	FirewallRuleListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/firewalls/rules?firewall_id={firewall_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "firewall_rules": [
        {
            "action": "ALLOW",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Firewall rule description example",
            "destination_address": [
                "10.0.0.1",
                "10.0.0.2"
            ],
            "destination_interface": "IFW1-v1001dn",
            "direction": "INBOUND",
            "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
            "id": "b156740b6335468d8354eb9ef8eddf5a",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "b156740b6335468d8354eb9ef8eddf5a",
            "sequence": 100,
            "service": [
                {
                    "service_type": "TCP",
                    "service_value": "443"
                }
            ],
            "source_address": [
                "192.168.1.1",
                "192.168.1.2"
            ],
            "source_interface": "IFW1-v2501up",
            "state": "CREATING",
            "status": "ENABLE",
            "vendor_rule_id": "72"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}