import os
from gcore import Gcore
client = Gcore(
api_key=os.environ.get("GCORE_API_KEY"), # This is the default and can be omitted
)
waap_custom_rule = client.waap.domains.custom_rules.update(
rule_id=0,
domain_id=1,
)
print(waap_custom_rule.id)package main
import (
"context"
"fmt"
"github.com/G-Core/gcore-go"
"github.com/G-Core/gcore-go/option"
"github.com/G-Core/gcore-go/waap"
)
func main() {
client := gcore.NewClient(
option.WithAPIKey("My API Key"),
)
waapCustomRule, err := client.Waap.Domains.CustomRules.Update(
context.TODO(),
0,
waap.DomainCustomRuleUpdateParams{
DomainID: 1,
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", waapCustomRule.ID)
}
curl --request PATCH \
--url https://api.gcore.com/waap/v2/domains/{domain_id}/custom-rules/{rule_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Block foobar bot",
"description": "<string>",
"enabled": true,
"action": {
"allow": {},
"block": {
"action_duration": "12h"
},
"captcha": {},
"handshake": {},
"monitor": {}
},
"conditions": [
{
"owner_types": {
"negation": false,
"owner_types": [
"COMMERCIAL"
]
}
}
]
}
'const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Block foobar bot',
description: '<string>',
enabled: true,
action: {
allow: {},
block: {action_duration: '12h'},
captcha: {},
handshake: {},
monitor: {}
},
conditions: [{owner_types: {negation: false, owner_types: ['COMMERCIAL']}}]
})
};
fetch('https://api.gcore.com/waap/v2/domains/{domain_id}/custom-rules/{rule_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gcore.com/waap/v2/domains/{domain_id}/custom-rules/{rule_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Block foobar bot',
'description' => '<string>',
'enabled' => true,
'action' => [
'allow' => [
],
'block' => [
'action_duration' => '12h'
],
'captcha' => [
],
'handshake' => [
],
'monitor' => [
]
],
'conditions' => [
[
'owner_types' => [
'negation' => false,
'owner_types' => [
'COMMERCIAL'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.patch("https://api.gcore.com/waap/v2/domains/{domain_id}/custom-rules/{rule_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Block foobar bot\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"action\": {\n \"allow\": {},\n \"block\": {\n \"action_duration\": \"12h\"\n },\n \"captcha\": {},\n \"handshake\": {},\n \"monitor\": {}\n },\n \"conditions\": [\n {\n \"owner_types\": {\n \"negation\": false,\n \"owner_types\": [\n \"COMMERCIAL\"\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/waap/v2/domains/{domain_id}/custom-rules/{rule_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Block foobar bot\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"action\": {\n \"allow\": {},\n \"block\": {\n \"action_duration\": \"12h\"\n },\n \"captcha\": {},\n \"handshake\": {},\n \"monitor\": {}\n },\n \"conditions\": [\n {\n \"owner_types\": {\n \"negation\": false,\n \"owner_types\": [\n \"COMMERCIAL\"\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "Block foobar bot",
"enabled": true,
"action": {
"allow": {},
"block": {
"status_code": 403,
"action_duration": "12h"
},
"captcha": {},
"handshake": {},
"monitor": {},
"tag": {
"tags": [
"<string>"
]
}
},
"id": 123,
"conditions": [
{
"ip": {
"ip_address": "<string>",
"negation": false
},
"ip_range": {
"lower_bound": "<string>",
"upper_bound": "<string>",
"negation": false
},
"url": {
"url": "/wp-admin/",
"negation": false,
"match_type": "Contains"
},
"user_agent": {
"user_agent": "curl/",
"negation": false,
"match_type": "Contains"
},
"header": {
"header": "Origin",
"value": "<string>",
"negation": false,
"match_type": "Contains"
},
"header_exists": {
"header": "Origin",
"negation": false
},
"http_method": {
"http_method": "CONNECT",
"negation": false
},
"file_extension": {
"file_extension": [
"pdf"
],
"negation": false
},
"content_type": {
"content_type": [
"application/xml"
],
"negation": false
},
"country": {
"country_code": "CN",
"negation": false
},
"organization": {
"organization": "UptimeRobot s.r.o",
"negation": false
},
"request_rate": {
"path_pattern": "/",
"requests": 21,
"time": 1800,
"ips": [
"<string>"
],
"http_methods": [
"CONNECT"
],
"user_defined_tag": "<string>"
},
"owner_types": {
"negation": false,
"owner_types": [
"COMMERCIAL"
]
},
"tags": {
"tags": "botnetclient",
"negation": false
},
"session_request_count": {
"request_count": 123,
"negation": false
},
"user_defined_tags": {
"tags": [
"<string>"
],
"negation": false
},
"ja3": {
"ja3_fingerprints": [
"e7d705a3286e19ea42f587b344ee6865"
],
"negation": false
},
"ja4": {
"ja4_fingerprints": [
"t13d3113h2_e8f1e7e78f70_ce5650b735ce"
],
"negation": false
},
"response_header": {
"header": "<string>",
"value": "<string>",
"negation": false,
"match_type": "Contains"
},
"response_header_exists": {
"header": "<string>",
"negation": false
}
}
],
"description": "<string>"
}{
"type": "http-bad-request",
"title": "Bad Request",
"status": 400,
"detail": "Invalid domain name: ''''"
}{
"detail": "Auth token is missing or invalid"
}{
"detail": "Permission denied"
}{
"type": "http-not-found",
"title": "Not Found",
"status": 404,
"detail": "The resource is not found"
}{
"type": "request-validation-failed",
"title": "Request validation error.",
"status": 422,
"detail": "One or more fields have validation errors.",
"errors": [
{
"loc": [
"body",
"name"
],
"detail": "Input should be a valid string"
},
{
"loc": [
"body",
"date"
],
"detail": "Field required"
},
{
"loc": [
"query",
"limit"
],
"detail": "Field required"
}
]
}{
"type": "internal-server-error",
"title": "Internal server error.",
"status": 500,
"detail": "An unexpected condition was encountered which prevented the server from fulfilling the request."
}Update a custom rule
Only properties present in the request will be updated
import os
from gcore import Gcore
client = Gcore(
api_key=os.environ.get("GCORE_API_KEY"), # This is the default and can be omitted
)
waap_custom_rule = client.waap.domains.custom_rules.update(
rule_id=0,
domain_id=1,
)
print(waap_custom_rule.id)package main
import (
"context"
"fmt"
"github.com/G-Core/gcore-go"
"github.com/G-Core/gcore-go/option"
"github.com/G-Core/gcore-go/waap"
)
func main() {
client := gcore.NewClient(
option.WithAPIKey("My API Key"),
)
waapCustomRule, err := client.Waap.Domains.CustomRules.Update(
context.TODO(),
0,
waap.DomainCustomRuleUpdateParams{
DomainID: 1,
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", waapCustomRule.ID)
}
curl --request PATCH \
--url https://api.gcore.com/waap/v2/domains/{domain_id}/custom-rules/{rule_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Block foobar bot",
"description": "<string>",
"enabled": true,
"action": {
"allow": {},
"block": {
"action_duration": "12h"
},
"captcha": {},
"handshake": {},
"monitor": {}
},
"conditions": [
{
"owner_types": {
"negation": false,
"owner_types": [
"COMMERCIAL"
]
}
}
]
}
'const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Block foobar bot',
description: '<string>',
enabled: true,
action: {
allow: {},
block: {action_duration: '12h'},
captcha: {},
handshake: {},
monitor: {}
},
conditions: [{owner_types: {negation: false, owner_types: ['COMMERCIAL']}}]
})
};
fetch('https://api.gcore.com/waap/v2/domains/{domain_id}/custom-rules/{rule_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gcore.com/waap/v2/domains/{domain_id}/custom-rules/{rule_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Block foobar bot',
'description' => '<string>',
'enabled' => true,
'action' => [
'allow' => [
],
'block' => [
'action_duration' => '12h'
],
'captcha' => [
],
'handshake' => [
],
'monitor' => [
]
],
'conditions' => [
[
'owner_types' => [
'negation' => false,
'owner_types' => [
'COMMERCIAL'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.patch("https://api.gcore.com/waap/v2/domains/{domain_id}/custom-rules/{rule_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Block foobar bot\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"action\": {\n \"allow\": {},\n \"block\": {\n \"action_duration\": \"12h\"\n },\n \"captcha\": {},\n \"handshake\": {},\n \"monitor\": {}\n },\n \"conditions\": [\n {\n \"owner_types\": {\n \"negation\": false,\n \"owner_types\": [\n \"COMMERCIAL\"\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/waap/v2/domains/{domain_id}/custom-rules/{rule_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Block foobar bot\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"action\": {\n \"allow\": {},\n \"block\": {\n \"action_duration\": \"12h\"\n },\n \"captcha\": {},\n \"handshake\": {},\n \"monitor\": {}\n },\n \"conditions\": [\n {\n \"owner_types\": {\n \"negation\": false,\n \"owner_types\": [\n \"COMMERCIAL\"\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "Block foobar bot",
"enabled": true,
"action": {
"allow": {},
"block": {
"status_code": 403,
"action_duration": "12h"
},
"captcha": {},
"handshake": {},
"monitor": {},
"tag": {
"tags": [
"<string>"
]
}
},
"id": 123,
"conditions": [
{
"ip": {
"ip_address": "<string>",
"negation": false
},
"ip_range": {
"lower_bound": "<string>",
"upper_bound": "<string>",
"negation": false
},
"url": {
"url": "/wp-admin/",
"negation": false,
"match_type": "Contains"
},
"user_agent": {
"user_agent": "curl/",
"negation": false,
"match_type": "Contains"
},
"header": {
"header": "Origin",
"value": "<string>",
"negation": false,
"match_type": "Contains"
},
"header_exists": {
"header": "Origin",
"negation": false
},
"http_method": {
"http_method": "CONNECT",
"negation": false
},
"file_extension": {
"file_extension": [
"pdf"
],
"negation": false
},
"content_type": {
"content_type": [
"application/xml"
],
"negation": false
},
"country": {
"country_code": "CN",
"negation": false
},
"organization": {
"organization": "UptimeRobot s.r.o",
"negation": false
},
"request_rate": {
"path_pattern": "/",
"requests": 21,
"time": 1800,
"ips": [
"<string>"
],
"http_methods": [
"CONNECT"
],
"user_defined_tag": "<string>"
},
"owner_types": {
"negation": false,
"owner_types": [
"COMMERCIAL"
]
},
"tags": {
"tags": "botnetclient",
"negation": false
},
"session_request_count": {
"request_count": 123,
"negation": false
},
"user_defined_tags": {
"tags": [
"<string>"
],
"negation": false
},
"ja3": {
"ja3_fingerprints": [
"e7d705a3286e19ea42f587b344ee6865"
],
"negation": false
},
"ja4": {
"ja4_fingerprints": [
"t13d3113h2_e8f1e7e78f70_ce5650b735ce"
],
"negation": false
},
"response_header": {
"header": "<string>",
"value": "<string>",
"negation": false,
"match_type": "Contains"
},
"response_header_exists": {
"header": "<string>",
"negation": false
}
}
],
"description": "<string>"
}{
"type": "http-bad-request",
"title": "Bad Request",
"status": 400,
"detail": "Invalid domain name: ''''"
}{
"detail": "Auth token is missing or invalid"
}{
"detail": "Permission denied"
}{
"type": "http-not-found",
"title": "Not Found",
"status": 404,
"detail": "The resource is not found"
}{
"type": "request-validation-failed",
"title": "Request validation error.",
"status": 422,
"detail": "One or more fields have validation errors.",
"errors": [
{
"loc": [
"body",
"name"
],
"detail": "Input should be a valid string"
},
{
"loc": [
"body",
"date"
],
"detail": "Field required"
},
{
"loc": [
"query",
"limit"
],
"detail": "Field required"
}
]
}{
"type": "internal-server-error",
"title": "Internal server error.",
"status": 500,
"detail": "An unexpected condition was encountered which prevented the server from fulfilling the request."
}Authorizations
API key for authentication. Make sure to include the word apikey, followed by a single space and then your token.
Example: apikey 1234_abcdef
Body
A request to update a WAAP rule
The name assigned to the rule
1 - 100^[A-Za-z0-9\s.:'";<>?&|\\_-]+$"Block foobar bot"
The description assigned to the rule
100Whether or not the rule is enabled
The action that the rule takes when triggered
Show child attributes
Show child attributes
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
1 - 5 elementsShow child attributes
Show child attributes
Response
Successful Response
An WAAP rule applied to a domain
The name assigned to the rule
1 - 100^[A-Za-z0-9\s.:'";<>?&|\\_-]+$"Block foobar bot"
Whether or not the rule is enabled
The action that the rule takes when triggered. Only one action can be set per rule.
Show child attributes
Show child attributes
The unique identifier for the rule
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
1 - 5 elementsShow child attributes
Show child attributes
The description assigned to the rule
100Was this page helpful?