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
)
waap_custom_rule = client.waap.domains.custom_rules.create(
domain_id=1,
action={},
conditions=[{}],
enabled=True,
name="Block foobar bot",
)
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.New(
context.TODO(),
1,
waap.DomainCustomRuleNewParams{
Action: waap.DomainCustomRuleNewParamsAction{},
Conditions: []waap.DomainCustomRuleNewParamsCondition{{}},
Enabled: true,
Name: "Block foobar bot",
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", waapCustomRule.ID)
}
curl --request POST \
--url https://api.gcore.com/waap/v1/domains/{domain_id}/custom-rules \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Block foobar bot",
"enabled": true,
"action": {
"allow": {},
"block": {
"status_code": 403,
"action_duration": "12h"
},
"captcha": {},
"handshake": {},
"monitor": {}
},
"conditions": [
{
"owner_types": {
"negation": false,
"owner_types": [
"COMMERCIAL"
]
}
}
],
"description": ""
}
'const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Block foobar bot',
enabled: true,
action: {
allow: {},
block: {status_code: 403, action_duration: '12h'},
captcha: {},
handshake: {},
monitor: {}
},
conditions: [{owner_types: {negation: false, owner_types: ['COMMERCIAL']}}],
description: ''
})
};
fetch('https://api.gcore.com/waap/v1/domains/{domain_id}/custom-rules', 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/v1/domains/{domain_id}/custom-rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Block foobar bot',
'enabled' => true,
'action' => [
'allow' => [
],
'block' => [
'status_code' => 403,
'action_duration' => '12h'
],
'captcha' => [
],
'handshake' => [
],
'monitor' => [
]
],
'conditions' => [
[
'owner_types' => [
'negation' => false,
'owner_types' => [
'COMMERCIAL'
]
]
]
],
'description' => ''
]),
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.post("https://api.gcore.com/waap/v1/domains/{domain_id}/custom-rules")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Block foobar bot\",\n \"enabled\": true,\n \"action\": {\n \"allow\": {},\n \"block\": {\n \"status_code\": 403,\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 \"description\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/waap/v1/domains/{domain_id}/custom-rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Block foobar bot\",\n \"enabled\": true,\n \"action\": {\n \"allow\": {},\n \"block\": {\n \"status_code\": 403,\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 \"description\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "Block foobar bot",
"enabled": true,
"description": "<string>",
"action": {
"allow": {},
"block": {
"status_code": 403,
"action_duration": "12h"
},
"captcha": {},
"handshake": {},
"monitor": {},
"tag": {
"tags": [
"<string>"
]
}
},
"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
},
"asn": {
"asns": 15169,
"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
}
}
]
}{
"type": "http-bad-request",
"title": "Bad Request",
"status": 400,
"detail": "Invalid domain name: ''''"
}{
"detail": "Auth token is missing or invalid"
}{
"title": "Quota limit exceeded",
"type": "quota-check-limit-exceeded",
"status": 403,
"detail": "You have reached the maximum limit allowed for your current plan. Please upgrade your plan to add more."
}{
"title": "Resource not found",
"type": "quota-check-no-resource",
"status": 404,
"detail": "The quota resource requested does not exist. Cannot enable WAAP for this domain. Please reach out to our support team."
}{
"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."
}Custom Rules
Create custom rule
POST
/
waap
/
v1
/
domains
/
{domain_id}
/
custom-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
)
waap_custom_rule = client.waap.domains.custom_rules.create(
domain_id=1,
action={},
conditions=[{}],
enabled=True,
name="Block foobar bot",
)
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.New(
context.TODO(),
1,
waap.DomainCustomRuleNewParams{
Action: waap.DomainCustomRuleNewParamsAction{},
Conditions: []waap.DomainCustomRuleNewParamsCondition{{}},
Enabled: true,
Name: "Block foobar bot",
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", waapCustomRule.ID)
}
curl --request POST \
--url https://api.gcore.com/waap/v1/domains/{domain_id}/custom-rules \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Block foobar bot",
"enabled": true,
"action": {
"allow": {},
"block": {
"status_code": 403,
"action_duration": "12h"
},
"captcha": {},
"handshake": {},
"monitor": {}
},
"conditions": [
{
"owner_types": {
"negation": false,
"owner_types": [
"COMMERCIAL"
]
}
}
],
"description": ""
}
'const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Block foobar bot',
enabled: true,
action: {
allow: {},
block: {status_code: 403, action_duration: '12h'},
captcha: {},
handshake: {},
monitor: {}
},
conditions: [{owner_types: {negation: false, owner_types: ['COMMERCIAL']}}],
description: ''
})
};
fetch('https://api.gcore.com/waap/v1/domains/{domain_id}/custom-rules', 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/v1/domains/{domain_id}/custom-rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Block foobar bot',
'enabled' => true,
'action' => [
'allow' => [
],
'block' => [
'status_code' => 403,
'action_duration' => '12h'
],
'captcha' => [
],
'handshake' => [
],
'monitor' => [
]
],
'conditions' => [
[
'owner_types' => [
'negation' => false,
'owner_types' => [
'COMMERCIAL'
]
]
]
],
'description' => ''
]),
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.post("https://api.gcore.com/waap/v1/domains/{domain_id}/custom-rules")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Block foobar bot\",\n \"enabled\": true,\n \"action\": {\n \"allow\": {},\n \"block\": {\n \"status_code\": 403,\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 \"description\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/waap/v1/domains/{domain_id}/custom-rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Block foobar bot\",\n \"enabled\": true,\n \"action\": {\n \"allow\": {},\n \"block\": {\n \"status_code\": 403,\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 \"description\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "Block foobar bot",
"enabled": true,
"description": "<string>",
"action": {
"allow": {},
"block": {
"status_code": 403,
"action_duration": "12h"
},
"captcha": {},
"handshake": {},
"monitor": {},
"tag": {
"tags": [
"<string>"
]
}
},
"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
},
"asn": {
"asns": 15169,
"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
}
}
]
}{
"type": "http-bad-request",
"title": "Bad Request",
"status": 400,
"detail": "Invalid domain name: ''''"
}{
"detail": "Auth token is missing or invalid"
}{
"title": "Quota limit exceeded",
"type": "quota-check-limit-exceeded",
"status": 403,
"detail": "You have reached the maximum limit allowed for your current plan. Please upgrade your plan to add more."
}{
"title": "Resource not found",
"type": "quota-check-no-resource",
"status": 404,
"detail": "The quota resource requested does not exist. Cannot enable WAAP for this domain. Please reach out to our support team."
}{
"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
Body
application/json
Custom rule data in the rule creation request context
Response
Successful Response
Full custom rule representation
Was this page helpful?