Update a custom rule

Only properties present in the request will be updated

PATCH /waap/v1/domains/{domain_id}/custom-rules/{rule_id}

Python

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.custom_rules.update(
    rule_id=0,
    domain_id=1,
)

400

{
  "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 custom rule ID

Body

application/json

A request to update a WAAP rule

name · string | null

The name assigned to the rule

Required string length: 1 - 100

Pattern: ^[A-Za-z0-9\s.:'";<>?&|\\]+$

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 · CustomerRuleAction · object

The action that the rule takes when triggered

Show child attributes

conditions · CustomRuleCondition · object[] | null

The conditions required for the WAAP engine to trigger the rule. Rules may have between 1 and 5 conditions. All conditions must pass for the rule to trigger

Required array length: 1 - 5 elements

Show child attributes

Response

204

Successful Response