Skip to navigation

list

View as Markdown

List the account’s IP lists with the number of addresses in each.

A custom rule matches the addresses of a list with the condition ip IN ["@ip_list:<list id>"] (or NOT IN).

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

Response

success
idstringformat: "uuid"
namestring
versioninteger
Grows by one on every change of the list's items
itemsCountinteger
createdAtstringformat: "utc-millisec"
updatedAtstringformat: "utc-millisec"