Blacklist
Create blacklist value
Adds a blacklist entry that blocks a value at a given field_path, optionally with a ttl_seconds expiry.
POST
/
api
/
admin
/
blacklist
Create blacklist value
curl --request POST \
--url https://{instance}.{env}.on-hellgate.cloud/api/admin/blacklist \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"field_path": "$.device.ip",
"value": "1.2.3.4",
"ttl_seconds": 86400
}
'import requests
url = "https://{instance}.{env}.on-hellgate.cloud/api/admin/blacklist"
payload = {
"field_path": "$.device.ip",
"value": "1.2.3.4",
"ttl_seconds": 86400
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({field_path: '$.device.ip', value: '1.2.3.4', ttl_seconds: 86400})
};
fetch('https://{instance}.{env}.on-hellgate.cloud/api/admin/blacklist', 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://{instance}.{env}.on-hellgate.cloud/api/admin/blacklist",
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([
'field_path' => '$.device.ip',
'value' => '1.2.3.4',
'ttl_seconds' => 86400
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{instance}.{env}.on-hellgate.cloud/api/admin/blacklist"
payload := strings.NewReader("{\n \"field_path\": \"$.device.ip\",\n \"value\": \"1.2.3.4\",\n \"ttl_seconds\": 86400\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{instance}.{env}.on-hellgate.cloud/api/admin/blacklist")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"field_path\": \"$.device.ip\",\n \"value\": \"1.2.3.4\",\n \"ttl_seconds\": 86400\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.{env}.on-hellgate.cloud/api/admin/blacklist")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"field_path\": \"$.device.ip\",\n \"value\": \"1.2.3.4\",\n \"ttl_seconds\": 86400\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_hint": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"field_path": "$.device.ip",
"inserted_at": "2023-11-07T05:31:56Z",
"source_decision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z",
"value": "1.2.3.4"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "VALIDATION_ERROR",
"code": 422,
"validation_errors": [
{
"message": "must be a positive integer",
"path": "limit"
}
]
}Authorizations
HS256-signed JWT bearer token, obtained via the OAuth2 client-credentials grant (see Authentication).
Body
application/json
Blacklist value
Response
Created value
Human-readable hint, e.g. masked PAN for $.credential_fingerprint entries.
When the entry expires. Null means it never expires.
JSON path of the field, e.g. $.device.ip.
Example:
"$.device.ip"
ID of the decision that triggered this entry.
The blacklisted value for this field.
Example:
"1.2.3.4"
⌘I
Create blacklist value
curl --request POST \
--url https://{instance}.{env}.on-hellgate.cloud/api/admin/blacklist \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"field_path": "$.device.ip",
"value": "1.2.3.4",
"ttl_seconds": 86400
}
'import requests
url = "https://{instance}.{env}.on-hellgate.cloud/api/admin/blacklist"
payload = {
"field_path": "$.device.ip",
"value": "1.2.3.4",
"ttl_seconds": 86400
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({field_path: '$.device.ip', value: '1.2.3.4', ttl_seconds: 86400})
};
fetch('https://{instance}.{env}.on-hellgate.cloud/api/admin/blacklist', 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://{instance}.{env}.on-hellgate.cloud/api/admin/blacklist",
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([
'field_path' => '$.device.ip',
'value' => '1.2.3.4',
'ttl_seconds' => 86400
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{instance}.{env}.on-hellgate.cloud/api/admin/blacklist"
payload := strings.NewReader("{\n \"field_path\": \"$.device.ip\",\n \"value\": \"1.2.3.4\",\n \"ttl_seconds\": 86400\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{instance}.{env}.on-hellgate.cloud/api/admin/blacklist")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"field_path\": \"$.device.ip\",\n \"value\": \"1.2.3.4\",\n \"ttl_seconds\": 86400\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.{env}.on-hellgate.cloud/api/admin/blacklist")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"field_path\": \"$.device.ip\",\n \"value\": \"1.2.3.4\",\n \"ttl_seconds\": 86400\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_hint": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"field_path": "$.device.ip",
"inserted_at": "2023-11-07T05:31:56Z",
"source_decision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z",
"value": "1.2.3.4"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "VALIDATION_ERROR",
"code": 422,
"validation_errors": [
{
"message": "must be a positive integer",
"path": "limit"
}
]
}