Create Firewall Traffic Rule

POST

/network/firewall/traffic

curl --request POST \
  --url https://sylve.lan:8181/api/network/firewall/traffic \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "action": "pass", "description": "example", "destObjId": 1, "destRaw": "example", "direction": "in", "dstPortObjId": 1, "dstPortsRaw": "example", "egressInterfaces": [ "example" ], "enabled": true, "family": "any", "ingressInterfaces": [ "example" ], "log": true, "name": "example", "priority": 1, "protocol": "any", "quick": true, "sourceObjId": 1, "sourceRaw": "example", "srcPortObjId": 1, "srcPortsRaw": "example" }'

Create and apply a firewall traffic rule

Authorizations

• BearerAuth

Request Body

Create Firewall Traffic Rule Request

Media typeapplication/json

object

action

required

string

Allowed values: pass block

description

string

<= 2048 characters

destObjId

integer

destRaw

string

<= 2048 characters

direction

required

string

Allowed values: in out

dstPortObjId

integer

dstPortsRaw

string

<= 2048 characters

egressInterfaces

required

Array<string>

<= 64 items unique items

enabled

boolean

family

required

string

Allowed values: any inet inet6

ingressInterfaces

required

Array<string>

<= 64 items unique items

log

boolean

name

required

string

<= 128 characters

priority

integer

<= 1000000

protocol

required

string

Allowed values: any tcp udp tcp_udp icmp

quick

boolean

sourceObjId

integer

sourceRaw

string

<= 2048 characters

srcPortObjId

integer

srcPortsRaw

string

<= 2048 characters

Responses

201

Created

Media typeapplication/json

object

data

integer

error

string

message

string

status

string

Example^generated

{
  "data": 1,
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Payload Too Large

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}