Skip to navigation

add

View as Markdown

Add addresses to a list. An address the list already holds takes the new comment and expiresAt, so posting it again moves its expiry.

Request Body

  • items (array) — the addresses to add
  • items[].ip (string) — a single IPv4 or IPv6 address
  • items[].comment (string) — optional, up to 256 characters
  • items[].expiresAt (string) — optional, epoch milliseconds, at most 30 days ahead

The response is the whole list after the change.

Errors

StatuscodeWhen
400protection_ip_list.invalid_ipAn ip is not a single IPv4 or IPv6 address
400protection_ip_list.duplicate_ipThe body names the same address twice
400protection_ip_list.comment_too_longA comment is longer than 256 characters
400protection_ip_list.expires_at_too_lateAn expiresAt is more than 30 days ahead
404protection_ip_list.ip_list_not_foundThe account has no list with this id
409protection_ip_list.ip_list_size_exceededThe list would hold more than 10,000 addresses
409protection_ip_list.ip_list_items_count_exceededThe account’s lists together would hold more addresses than the plan allows

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.
itemslist of objectsRequired

Response

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