Update a firewall rule

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
)
client.waap.domains.firewall_rules.update(
    rule_id=0,
    domain_id=1,
)

{
  "type": "http-bad-request",
  "title": "Bad Request",
  "status": 400,
  "detail": "Invalid domain name: ''''"
}

PATCH

waap

domains

{domain_id}

firewall-rules

{rule_id}

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
)
client.waap.domains.firewall_rules.update(
    rule_id=0,
    domain_id=1,
)

{
  "type": "http-bad-request",
  "title": "Bad Request",
  "status": 400,
  "detail": "Invalid domain name: ''''"
}

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

rule_id

integer

required

The firewall rule ID

Body

application/json

name

string | null

The name assigned to the rule

Required string length: 1 - 100

Example:

"Block foobar bot"

description

string | null

The description assigned to the rule

Maximum string length: 100

enabled

boolean | null

Whether or not the rule is enabled

action

FirewallRuleAction · object

The action that the rule takes when triggered

Show child attributes

action.allow

RuleAllowAction · object

The WAAP allowed the request

action.block

RuleBlockAction · object

WAAP block action behavior could be configured with response status code and action duration.

Show child attributes

action.block.status_code

enum<integer>

A custom HTTP status code that the WAAP returns if a rule blocks a request

Available options:

403,

405,

418,

429

action.block.action_duration

string

How long a rule's block action will apply to subsequent requests. Can be specified in seconds or by using a numeral followed by 's', 'm', 'h', or 'd' to represent time format (seconds, minutes, hours, or days). Empty time intervals are not allowed.

Required string length: 1 - 10

conditions

FirewallRuleCondition · object[] | null

The condition required for the WAAP engine to trigger the rule.

Required array length: 1 element

Show child attributes

conditions.ip

IpCondition · object

Match the incoming request against a single IP address

Show child attributes

conditions.ip.ip_address

string<ipvanyaddress>

required

A single IPv4 or IPv6 address

conditions.ip.negation

boolean

default:false

Whether or not to apply a boolean NOT operation to the rule's condition

conditions.ip_range

IpRangeCondition · object

Match the incoming request against an IP range

Show child attributes

conditions.ip_range.lower_bound

string<ipvanyaddress>

required

The lower bound IPv4 or IPv6 address to match against

conditions.ip_range.upper_bound

string<ipvanyaddress>

required

The upper bound IPv4 or IPv6 address to match against

conditions.ip_range.negation

boolean

default:false

Whether or not to apply a boolean NOT operation to the rule's condition

Response

Successful Response

Delete a firewall rule Delete multiple WAAP rules

⌘I

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

Update a firewall rule

Authorizations

Path Parameters

Body

Response