> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api-docs.botbye.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.botbye.com/_mcp/server.

# add

POST https://api.botbye.com/api/v1/{account_id}/ip-lists/{ip_list_id}/items
Content-Type: application/json

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

| Status | `code` | When |
| --- | --- | --- |
| 400 | `protection_ip_list.invalid_ip` | An `ip` is not a single IPv4 or IPv6 address |
| 400 | `protection_ip_list.duplicate_ip` | The body names the same address twice |
| 400 | `protection_ip_list.comment_too_long` | A comment is longer than 256 characters |
| 400 | `protection_ip_list.expires_at_too_late` | An `expiresAt` is more than 30 days ahead |
| 404 | `protection_ip_list.ip_list_not_found` | The account has no list with this id |
| 409 | `protection_ip_list.ip_list_size_exceeded` | The list would hold more than 10,000 addresses |
| 409 | `protection_ip_list.ip_list_items_count_exceeded` | The 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`

Reference: https://api-docs.botbye.com/bot-bye-api/protection/ip-lists/add

## Authentication

- `X-Api-Key` header (required) — 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.

## Request

### Path parameters

- `account_id` (string, required)
- `ip_list_id` (string, required)

### Body (application/json)

This endpoint expects an object.

- `items` (list of ApiV1AccountIdIpListsIpListIdItemsPostRequestBodyContentApplicationJsonSchemaItemsItems, required)

## Response

### 200

success

- `id` (string, required)
- `name` (string, required)
- `version` (integer, required)
- `items` (list of ApiV1AccountIdIpListsIpListIdItemsPostResponsesContentApplicationJsonSchemaItemsItems, required)
- `createdAt` (string, required)
- `updatedAt` (string, required)

## Types

### ApiV1AccountIdIpListsIpListIdItemsPostRequestBodyContentApplicationJsonSchemaItemsItems

- `ip` (string, required) — A single IPv4 or IPv6 address
- `comment` (string, optional) — Up to 256 characters
- `expiresAt` (string, optional) — When the address stops matching rules, epoch milliseconds; at most 30 days ahead. Omit for an address that never expires

### ApiV1AccountIdIpListsIpListIdItemsPostResponsesContentApplicationJsonSchemaItemsItems

- `ip` (string, required)
- `comment` (string, required, nullable)
- `expiresAt` (string, required, nullable)

## Examples

**Request**

```json
{
  "items": [
    {
      "ip": "203.0.113.7",
      "comment": "gateway"
    },
    {
      "ip": "198.51.100.9",
      "expiresAt": "1794650675478"
    }
  ]
}
```

**Response**

```json
{
  "id": "01a1d45d-bd8b-7796-9184-2fba2b8a5c0e",
  "name": "office",
  "version": 2,
  "items": [
    {
      "ip": "203.0.113.7",
      "comment": "gateway",
      "expiresAt": null
    },
    {
      "ip": "198.51.100.9",
      "comment": null,
      "expiresAt": "1794650675478"
    }
  ],
  "createdAt": "1794564275595",
  "updatedAt": "1794564275698"
}
```

**SDK Code**

```python IP Lists_add_example
import requests

url = "https://api.botbye.com/api/v1/account_id/ip-lists/ip_list_id/items"

payload = { "items": [
        {
            "ip": "203.0.113.7",
            "comment": "gateway"
        },
        {
            "ip": "198.51.100.9",
            "expiresAt": "1794650675478"
        }
    ] }
headers = {
    "X-Api-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript IP Lists_add_example
const url = 'https://api.botbye.com/api/v1/account_id/ip-lists/ip_list_id/items';
const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"items":[{"ip":"203.0.113.7","comment":"gateway"},{"ip":"198.51.100.9","expiresAt":"1794650675478"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go IP Lists_add_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.botbye.com/api/v1/account_id/ip-lists/ip_list_id/items"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"ip\": \"203.0.113.7\",\n      \"comment\": \"gateway\"\n    },\n    {\n      \"ip\": \"198.51.100.9\",\n      \"expiresAt\": \"1794650675478\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby IP Lists_add_example
require 'uri'
require 'net/http'

url = URI("https://api.botbye.com/api/v1/account_id/ip-lists/ip_list_id/items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"ip\": \"203.0.113.7\",\n      \"comment\": \"gateway\"\n    },\n    {\n      \"ip\": \"198.51.100.9\",\n      \"expiresAt\": \"1794650675478\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java IP Lists_add_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.botbye.com/api/v1/account_id/ip-lists/ip_list_id/items")
  .header("X-Api-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"ip\": \"203.0.113.7\",\n      \"comment\": \"gateway\"\n    },\n    {\n      \"ip\": \"198.51.100.9\",\n      \"expiresAt\": \"1794650675478\"\n    }\n  ]\n}")
  .asString();
```

```php IP Lists_add_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.botbye.com/api/v1/account_id/ip-lists/ip_list_id/items', [
  'body' => '{
  "items": [
    {
      "ip": "203.0.113.7",
      "comment": "gateway"
    },
    {
      "ip": "198.51.100.9",
      "expiresAt": "1794650675478"
    }
  ]
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-Api-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp IP Lists_add_example
using RestSharp;

var client = new RestClient("https://api.botbye.com/api/v1/account_id/ip-lists/ip_list_id/items");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Api-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"items\": [\n    {\n      \"ip\": \"203.0.113.7\",\n      \"comment\": \"gateway\"\n    },\n    {\n      \"ip\": \"198.51.100.9\",\n      \"expiresAt\": \"1794650675478\"\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift IP Lists_add_example
import Foundation

let headers = [
  "X-Api-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["items": [
    [
      "ip": "203.0.113.7",
      "comment": "gateway"
    ],
    [
      "ip": "198.51.100.9",
      "expiresAt": "1794650675478"
    ]
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.botbye.com/api/v1/account_id/ip-lists/ip_list_id/items")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```