Create blacklist value

POST

api

admin

blacklist

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": "7d3b9f1e-4a6c-4c8d-b2e5-1f8a4c6e9d3b",
  "display_hint": "411111 •••••• 4242",
  "expires_at": "2026-09-01T00:00:00Z",
  "field_path": "$.device.ip",
  "inserted_at": "2026-06-01T10:00:05Z",
  "source_decision_id": "1e7b9c0a-2d43-4f6a-8d29-c4a1f2d05b3e",
  "updated_at": "2026-06-01T10:00:05Z",
  "value": "1.2.3.4",
  "value_classification": "any"
}

{
  "classifier": "UNAUTHORIZED",
  "code": 401,
  "message": "No valid means of authentication was provided"
}

{
  "classifier": "FORBIDDEN",
  "code": 403,
  "message": "Not allowed to access this resource or feature"
}

{
  "classifier": "VALIDATION_ERROR",
  "code": 422,
  "validation_errors": [
    {
      "message": "must be a positive integer",
      "path": "limit"
    }
  ]
}

Authorizations

Authorization

string

header

required

RS256-signed JWT bearer token, obtained via the OAuth2 client-credentials grant and verifiable against the issuer's JWKS (see Authentication).

Body

application/json

Blacklist value

field_path

string

required

JSON path of the field to blacklist, e.g. $.device.ip.

Example:

"$.device.ip"

value

string

required

The value to blacklist for this field.

Example:

"1.2.3.4"

ttl_seconds

integer | null

Optional TTL in seconds. If omitted, the entry never expires.

Required range: x >= 1

Example:

86400

Response

Created value

string<uuid>

Example:

"7d3b9f1e-4a6c-4c8d-b2e5-1f8a4c6e9d3b"

display_hint

string | null

Human-readable hint, e.g. masked PAN for $.credential_fingerprint entries.

Example:

"411111 •••••• 4242"

expires_at

string<date-time> | null

When the entry expires. Null means it never expires.

Example:

"2026-09-01T00:00:00Z"

field_path

string

JSON path of the field, e.g. $.device.ip.

Example:

"$.device.ip"

inserted_at

string<date-time>

Example:

"2026-06-01T10:00:05Z"

source_decision_id

string<uuid> | null

ID of the decision that triggered this entry.

Example:

"1e7b9c0a-2d43-4f6a-8d29-c4a1f2d05b3e"

updated_at

string<date-time>

Example:

"2026-06-01T10:00:05Z"

value

string

The blacklisted value for this field.

Example:

"1.2.3.4"

value_classification

enum<string>

The x-data-classification that field_path resolves to across the registered schemas. A path no schema declares is any — an omitted marker is a positive assertion, and an entry on such a path is inert anyway, since undeclared keys never enter a decision payload.

Available options:

any,

pii

Example:

"any"

⌘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": "7d3b9f1e-4a6c-4c8d-b2e5-1f8a4c6e9d3b",
  "display_hint": "411111 •••••• 4242",
  "expires_at": "2026-09-01T00:00:00Z",
  "field_path": "$.device.ip",
  "inserted_at": "2026-06-01T10:00:05Z",
  "source_decision_id": "1e7b9c0a-2d43-4f6a-8d29-c4a1f2d05b3e",
  "updated_at": "2026-06-01T10:00:05Z",
  "value": "1.2.3.4",
  "value_classification": "any"
}

{
  "classifier": "UNAUTHORIZED",
  "code": 401,
  "message": "No valid means of authentication was provided"
}

{
  "classifier": "FORBIDDEN",
  "code": 403,
  "message": "Not allowed to access this resource or feature"
}

{
  "classifier": "VALIDATION_ERROR",
  "code": 422,
  "validation_errors": [
    {
      "message": "must be a positive integer",
      "path": "limit"
    }
  ]
}

Getting Started

Decisions

Lifecycle Events

Admin

Authorizations

Body

Response