Retrieve account's firewall rules across all domains

Returns all firewall rules across all domains belonging to the authenticated account. Supports filtering, ordering, and pagination.

GET /waap/v2/firewall-rules

Retrieve account's firewall rules across all domains

cURL

curl --request GET \
  --url https://api.gcore.com/waap/v2/firewall-rules \
  --header 'Authorization: <api-key>'

200

{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "results": [
    {
      "name": "Block foobar bot",
      "enabled": true,
      "action": {
        "allow": {},
        "block": {
          "action_duration": "12h"
        }
      },
      "conditions": [
        {
          "ip": {
            "ip_address": "<string>",
            "negation": false
          },
          "ip_range": {
            "lower_bound": "<string>",
            "upper_bound": "<string>",
            "negation": false
          }
        }
      ],
      "id": 123,
      "domain": {
        "id": 123,
        "name": "<string>"
      },
      "description": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

ordering · enum<string> | null

Order results by field (prefix with - for descending)

Available options: id, name, description, enabled, action, -id, -name, -description, -enabled, -action

limit · integer · default: 100

Number of items to return

Required range: 0 <= x <= 100

offset · integer · default: 0

Number of items to skip

Required range: 0 <= x <= 100000

name · string

Filter rules by name (supports wildcards)

Example:

"Block by specific IP rule."

description · string

Filter rules by description (supports wildcards)

Example:

"Blocks all requests from a specific IP address."

action · enum<string>

Filter by action type

Available options: allow, block

Example:

"allow"

enabled · boolean

Filter by enabled status

Example:

true

domain_ids · integer[]

Filter by domain IDs (can specify multiple)

Example:

[123, 456]

Response

200

application/json

Successful Response

limit · integer · required

Number of items requested in the response

offset · integer · required

Items response offset used

count · integer · required

Number of items contain in the response

results · AccountFirewallRuleResponse · object[] · required

List of items returned in the response following given criteria

Show child attributes