Skip to navigation

items

View as Markdown

Page through the addresses of a list in the order they were added.

An address past its expiresAt no longer matches rules and is removed from the list within minutes.

Errors

StatuscodeWhen
404protection_ip_list.ip_list_not_foundThe account has no list with this id

Accepted permissions Account → IP lists → Lists

Token scope Account IP Lists View

Authentication

X-Api-Keystring

Personal access token. Create it in your BotBye account under Profile → Personal Access Tokens, tick the scopes the endpoints you call require (see each endpoint’s Token scope), and send the token in the X-Api-Key request header exactly as the console shows it (it is already Base64-encoded; a token saved earlier in the UUID form must be Base64-encoded first). A token works only for the account it was created in.

Path parameters

account_idstringRequired
ip_list_idstringRequired

Query parameters

searchstringOptional
Keep the addresses that contain this text, ignoring case
cursorstringOptional

Cursor-based pagination JSON: {“first”: N, “after”: ”…”}; at most 1000 per page, 20 by default

totalbooleanOptional

true to count the matching addresses in pageInfo.total

Response

success
edgeslist of objectsOptional
pageInfoobjectOptional