Skip to content

Retrieve firewall rules

GET
/rules

Returns a list of firewall rules with pagination and filtering options.

Parameters

Query Parameters

page
integer

Page number for pagination

filter
string

Filter string to search for specific rules

limit
integer

Number of rules to return per page

Responses

200

Successful response with firewall rules

object
data
object
limit
integer
15
rules
Array<object>
object
id
integer
123
destination
string
1.1.1.1/32
action
string
Allowed values: permit deny
note
string
Example Rule
protocol
integer
17
source
string
1.1.1.1/32
order
integer
11
disabled
boolean
last_rule_update

Last time rule has been updated by user

string format: date-time
2024-08-25T21:39:57.5+02:00
src_port_type
string,
Allowed values: eq gt lt neq range
dst_port_type
string
Allowed values: eq gt lt neq range
matched_packets
integer
238428
group_id

If this is not a group the group ID will be 0

integer
0
updated_at
string format: date-time
2024-08-25T21:39:37.439+02:00
total
integer
5
page

Current page number

integer
success
boolean
true