Skip to navigation

update

View as Markdown

Rename an IP list. Rules refer to a list by its id, so renaming changes none of them.

Request Body

  • name (string) — 1 to 64 lowercase letters, digits or underscores, unique within the account

Errors

StatuscodeWhen
400protection_ip_list.invalid_ip_list_nameThe name breaks the rule above
404protection_ip_list.ip_list_not_foundThe account has no list with this id
409protection_ip_list.ip_list_name_already_existsThe account already has a list with this name

Accepted permissions Account → IP lists → Update

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.
namestringRequired

Response

success