Skip to navigation

remove

View as Markdown

Remove addresses from a list. An address the list does not hold is ignored.

Request Body

  • ips (array of strings) — the addresses to remove

The response is the whole list after the change.

Errors

StatuscodeWhen
400protection_ip_list.invalid_ipAn address is not a single IPv4 or IPv6 address
404protection_ip_list.ip_list_not_foundThe account has no list with this id

Accepted permissions Account → IP lists → Edit items

Token scope Account IP Lists Action

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

Request

This endpoint expects an object.
ipslist of stringsRequired

Response

success
idstringformat: "uuid"
namestring
versioninteger
itemslist of objects
createdAtstringformat: "utc-millisec"
updatedAtstringformat: "utc-millisec"