Get protection template

Get a specific protection template. Returns 404 if template not found.

GET /security/sifter/v3/templates/{protection_template_id}

Get protection template

cURL

curl --request GET \
  --url https://api.gcore.com/security/sifter/v3/templates/{protection_template_id} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.gcore.com/security/sifter/v3/templates/{protection_template_id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.gcore.com/security/sifter/v3/templates/{protection_template_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/security/sifter/v3/templates/{protection_template_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;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/security/sifter/v3/templates/{protection_template_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/security/sifter/v3/templates/{protection_template_id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/security/sifter/v3/templates/{protection_template_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

{
  "allow_merge": false,
  "client_id": 42,
  "description": "Template for configuring DDoS protection policies",
  "fields": [
    {
      "description": "Maximum number of requests per second before triggering protection",
      "field_type": "RULES",
      "id": 1,
      "name": "Rate Limit Threshold",
      "name_in_config": "rate_limit_threshold",
      "validation_schema": {
        "maximum": 100000,
        "minimum": 1,
        "type": "integer"
      }
    }
  ],
  "id": 7,
  "name": "DDoS Protection Template",
  "template": {
    "properties": {
      "threshold": {
        "minimum": 1,
        "type": "integer"
      },
      "action": {
        "enum": [
          "block",
          "challenge",
          "log"
        ],
        "type": "string"
      }
    },
    "type": "object"
  }
}

{}

{}

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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

protection_template_id · integer · required

A positive integer ID

Required range: 1 <= x <= 1000000000

Response

200

application/json

Successful Response

name · string · required

Name of the template

Required string length: 1 - 100

description · string · required

Description of the template

template · any · required

JSON schema for the template

allow_merge · boolean · required

Allow merging of this config with others

client_id · integer | null · required

ID of the client this template belongs to

id · integer · required

Unique identifier for the template

fields · ProtectionTemplateFieldResponse · object[] · required

List of fields in the template

Show child attributes