GET
/
waap
/
v1
/
domains
/
{domain_id}
/
custom-rules
Python
from gcore import Gcore

client = Gcore(
    api_key="My API Key",
)
page = client.waap.domains.custom_rules.list(
    domain_id=1,
)
page = page.results[0]
print(page.id)
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "results": [
    {
      "name": "Block foobar bot",
      "description": "<string>",
      "enabled": true,
      "action": {
        "allow": {},
        "block": {
          "status_code": 403,
          "action_duration": "12h"
        },
        "captcha": {},
        "handshake": {},
        "monitor": {},
        "tag": {
          "tags": [
            "<string>"
          ]
        }
      },
      "conditions": [
        {
          "ip": {
            "negation": false,
            "ip_address": "127.0.0.1"
          },
          "ip_range": {
            "negation": false,
            "lower_bound": "127.0.0.1",
            "upper_bound": "127.0.0.1"
          },
          "url": {
            "negation": false,
            "match_type": "Contains",
            "url": "/wp-admin/"
          },
          "user_agent": {
            "negation": false,
            "user_agent": "curl/",
            "match_type": "Contains"
          },
          "header": {
            "negation": false,
            "header": "Origin",
            "value": "<string>",
            "match_type": "Contains"
          },
          "header_exists": {
            "negation": false,
            "header": "Origin"
          },
          "response_header": {
            "negation": false,
            "header": "<string>",
            "value": "<string>",
            "match_type": "Contains"
          },
          "response_header_exists": {
            "negation": false,
            "header": "<string>"
          },
          "http_method": {
            "negation": false,
            "http_method": "CONNECT"
          },
          "file_extension": {
            "negation": false,
            "file_extension": [
              "pdf"
            ]
          },
          "content_type": {
            "negation": false,
            "content_type": [
              "application/xml"
            ]
          },
          "country": {
            "negation": false,
            "country_code": [
              "<string>"
            ]
          },
          "organization": {
            "negation": false,
            "organization": "UptimeRobot s.r.o"
          },
          "request_rate": {
            "ips": [
              "127.0.0.1"
            ],
            "http_methods": [
              "CONNECT"
            ],
            "path_pattern": "/",
            "requests": 21,
            "time": 1800,
            "user_defined_tag": "<string>"
          },
          "owner_types": {
            "negation": false,
            "owner_types": [
              "COMMERCIAL"
            ]
          },
          "tags": {
            "negation": false,
            "tags": [
              "<string>"
            ]
          },
          "session_request_count": {
            "negation": false,
            "request_count": 123
          },
          "user_defined_tags": {
            "negation": false,
            "tags": [
              "<string>"
            ]
          }
        }
      ],
      "id": 123
    }
  ]
}

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

Required range: x > 0

Query Parameters

​
ordering
enum<string> | null

Determine the field to order results by

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

"-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.

Examples:

"Block by specific IP rule."

​
description
string

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

Examples:

"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
​
enabled
boolean

Filter rules based on their active status

Examples:

false

Response

200
application/json

Successful Response

The response is of type object.