BizKitHub
DocsAPI ReferenceSettings/bff/settings/ip-ban-list
getSettingsAdmin BFF

/bff/settings/ip-ban-list

Returns all IP addresses banned for this organisation.

SettingsgetBffSettingsIp-ban-list

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
geoIdnumberRequired

Geo IP record ID.

ipstringRequired

Accepted formats:

  • IPv4 dot-decimal, e.g. 1.1.1.1 (4 octets, 0–255, no leading zeros).
  • IPv6 as defined by RFC 4291 — full 2001:0db8:0000:0000:0000:0000:0000:0001, zero-compressed 2001:db8::1, IPv4-mapped ::ffff:1.2.3.4, or scoped literals. Both upper- and lower-case hex are accepted.

Server-side canonicalization (ipNormalize in core/src/lib/network/ipNormalize.ts):

  • Valid IPv4 is passed through verbatim.
  • Valid IPv6 is lowercased (RFC 5952 §4.3).
  • IPv4-mapped IPv6 ::ffff:X.X.X.X is unwrapped to plain IPv4 (RFC 4291 §2.5.5.2) so 1.2.3.4 and ::ffff:1.2.3.4 share one brj__geo_ip row.
  • Loopback aliases (::1, 0.0.0.0, localhost, empty string) collapse to 127.0.0.1.
  • Junk values that fail both IPv4 and IPv6 validation are silently rejected and replaced with 127.0.0.1 (loopback).

On the wire: every response returns the canonicalized form — clients can safely rely on lowercase IPv6 and the plain-IPv4 unwrap when de-duping or joining. Server-originated writers (activity log, session log, ban list) resolve the visitor IP via resolveClientIp / resolveClientIpOrNull — always native IPv6 on Vercel Edge (there is no auto-mapping to ::ffff:X.X.X.X).

Enrichment: the system resolves reverse DNS, geolocation, ASN, mobile/proxy/hosting/Tor flags via our VikiTron GEO/IP resolver for both address families. Learn more

Examples1.1.1.12001:4860:4860::8888
hostnamestring | nullRequired
One of 2:
Variant 1
string

Reverse DNS hostname.

Variant 2
null
citystring | nullRequired
One of 2:
Variant 1
string

City name.

Variant 2
null
countrystring | nullRequired
One of 2:
Variant 1
string

Country code.

ExampleCZ
Variant 2
null
countryRegionstring | nullRequired
One of 2:
Variant 1
string

Country region.

Variant 2
null
latitudenumber | nullRequired
One of 2:
Variant 1
number

Latitude.

Variant 2
null
longitudenumber | nullRequired
One of 2:
Variant 1
number

Longitude.

Variant 2
null
ispstring | nullRequired
One of 2:
Variant 1
string

Internet service provider.

Variant 2
null
organisationstring | nullRequired
One of 2:
Variant 1
string

IP organisation.

Variant 2
null
torbooleanRequired

Whether the IP is a known Tor exit node.

hostingbooleanRequired

Whether the IP belongs to a hosting provider.

proxybooleanRequired

Whether the IP is a known proxy.

reasonstring | nullRequired
One of 2:
Variant 1
string

Reason for the ban.

Variant 2
null
insertedDateDate | string | string | numberRequired

ISO date when the ban was created.

One of 4:
Variant 1
Date

ISO date when the ban was created.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
itemCountnumberRequired

Total number of banned IPs.

Response example

application/json
{
  "items": [
    {
      "geoId": 0,
      "ip": "1.1.1.1",
      "tor": false,
      "hosting": false,
      "proxy": false
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/settings/ip-ban-list

get
curl -X GET "https://api.bizkithub.com/bff/settings/ip-ban-list" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key