Firewalls

Create firewall rules

POST/v1/networking/firewall/groups/{id}/rules

curl --request POST \
  --url https://api.serverside.com/v1/networking/firewall/groups/{id}/rules \
  --header 'X-API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "type": "ALLOW",
    "direction": "INBOUND",
    "protocol": "ANY",
    "sourcePortStart": 123,
    "sourcePortEnd": 123,
    "sourceAddress": "<string>",
    "destPortStart": 123,
    "destPortEnd": 123,
    "rateLimitPps": 123,
    "packetCriteria": {
      "maxPacketLength": 123,
      "minPacketLength": 123
    },
    "description": "<string>"
  }
]
'

{
  "success": true,
  "message": "<string>",
  "exception": "<string>",
  "code": "<string>",
  "errors": {},
  "traceId": "<string>",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "firewallGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "priority": 123,
      "isEnabled": true,
      "type": "ALLOW",
      "direction": "INBOUND",
      "protocol": "ANY",
      "sourcePortStart": 123,
      "sourcePortEnd": 123,
      "sourceAddress": "<string>",
      "destPortStart": 123,
      "destPortEnd": 123,
      "rateLimitPps": 123,
      "packetCriteria": {
        "maxPacketLength": 123,
        "minPacketLength": 123
      },
      "description": "<string>"
    }
  ],
  "pagination": {
    "totalRecords": 123,
    "currentPage": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

Authorizations

X-API-KEYstringheaderrequired
Organization API key. Create one in the cloud console at https://cloud.serverside.com; the key is shown once, when it is created.

Path parameters

idstring<uuid>required

Body

application/json

The body is a JSON array. Each item has these fields.

typeenum<string>
Allowed values:ALLOWBLOCKRATE_LIMIT
directionenum<string>
Allowed values:INBOUNDOUTBOUND
protocolenum<string>
Allowed values:ANYTCPUDPICMPICMP_V6GRE
sourcePortStartinteger<int32> | null
Limits:1 <= x <= 65535
sourcePortEndinteger<int32> | null
Limits:1 <= x <= 65535
sourceAddressstring | null
destPortStartinteger<int32> | null
Limits:1 <= x <= 65535
destPortEndinteger<int32> | null
Limits:1 <= x <= 65535
rateLimitPpsinteger<int32> | null
Limits:x >= 1
packetCriteriaobject
descriptionstring | null
Limits:length <= 100

Response

200 · application/json

successboolean
messagestring | null
exceptionstring | null
codestring | null
errorsobject | null
traceIdstring | null
dataobject[] | null
paginationobject

Authorizations

Path parameters

Body

Response

Footer