Skip to main content
GET
/
waap
/
v1
/
domains
/
{domain_id}
/
advanced-rules
Python
import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
page = client.waap.domains.advanced_rules.list(
    domain_id=1,
)
page = page.results[0]
print(page.id)
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "results": [
    {
      "name": "<string>",
      "enabled": true,
      "action": {
        "allow": {},
        "block": {
          "status_code": 403,
          "action_duration": "<string>"
        },
        "captcha": {},
        "handshake": {},
        "monitor": {},
        "tag": {
          "tags": [
            "<string>"
          ]
        }
      },
      "source": "<string>",
      "id": 123,
      "description": "<string>",
      "phase": "access"
    }
  ]
}

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

Path Parameters

​
domain_id
integer
required

The domain ID

Query Parameters

​
ordering
enum<string> | null

Determine the field to order results by

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

"-id"

​
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 based on their name. Supports '*' as a wildcard character.

Example:

"Block by specific IP rule"

​
description
string

Filter rules based on their description. Supports '*' as a wildcard character.

Example:

"This rule blocks all the requests coming form a specific IP address"

​
action
enum<string>

Filter to refine results by specific actions

Available options:
allow,
block,
captcha,
handshake,
monitor,
tag
Example:

"block"

​
enabled
boolean

Filter rules based on their active status

Example:

false

​
phase
enum<string>

Filter rules based on the WAAP request/response phase for applying the rule.

The "access" phase is responsible for modifying the request before it is sent to the origin server.

The "header_filter" phase is responsible for modifying the HTTP headers of a response before they are sent back to the client.

The "body_filter" phase is responsible for modifying the body of a response before it is sent back to the client.

Available options:
access,
header_filter,
body_filter
Example:

"access"

Response

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
AdvancedRuleResponse · object[]
required

List of items returned in the response following given criteria