Retrieve a specific firewall rule

Extracts a specific firewall rule assigned to a domain

GET /waap/v1/domains/{domain_id}/firewall-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
)
waap_firewall_rule = client.waap.domains.firewall_rules.get(
    rule_id=0,
    domain_id=1,
)
print(waap_firewall_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"),
	)
	waapFirewallRule, err := client.Waap.Domains.FirewallRules.Get(
		context.TODO(),
		0,
		waap.DomainFirewallRuleGetParams{
			DomainID: 1,
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", waapFirewallRule.ID)
}

curl --request GET \
  --url https://api.gcore.com/waap/v1/domains/{domain_id}/firewall-rules/{rule_id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/waap/v1/domains/{domain_id}/firewall-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/v1/domains/{domain_id}/firewall-rules/{rule_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/waap/v1/domains/{domain_id}/firewall-rules/{rule_id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/waap/v1/domains/{domain_id}/firewall-rules/{rule_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "name": "Block foobar bot",
  "enabled": true,
  "action": {
    "allow": {},
    "block": {
      "action_duration": "12h"
    }
  },
  "conditions": [
    {
      "ip": {
        "ip_address": "<string>",
        "negation": false
      },
      "ip_range": {
        "lower_bound": "<string>",
        "upper_bound": "<string>",
        "negation": false
      }
    }
  ],
  "id": 123,
  "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

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

Response

200

application/json

Successful Response

name · string · required

The name assigned to the rule

Required string length: 1 - 100

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

Example:

"Block foobar bot"

enabled · boolean · required

Whether or not the rule is enabled

action · FirewallRuleAction · object · required

The action that the rule takes when triggered

Show child attributes

conditions · FirewallRuleCondition · object[] · required

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

Required array length: 1 element

Show child attributes

id · integer · required

The unique identifier of the rule

description · string

The description assigned to the rule

Maximum string length: 100