Create blacklist value - Hellgate Cloud Platform

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 } '

{ "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" }

Authorizations

Authorization

string

header

required

HS256-signed JWT bearer token, obtained via the OAuth2 client-credentials grant (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.

Example:

86400

Response

Created value

string<uuid>

display_hint

string | null

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

expires_at

string<date-time> | null

When the entry expires. Null means it never expires.

field_path

string

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

Example:

"$.device.ip"

inserted_at

string<date-time>

source_decision_id

string<uuid> | null

ID of the decision that triggered this entry.

updated_at

string<date-time>

value

string

The blacklisted value for this field.

Example:

"1.2.3.4"