BizKitHub Developer Documentation

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

IP address.

Example1.2.3.4

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.2.3.4",
      "tor": false,
      "hosting": false,
      "proxy": false
    }
  ],
  "itemCount": 0
}

/bff/settings/ip-ban-list

Parameters

Response schema

Response example

Request example

Need an API key?