Whitelist IP

Управление списком IP-адресов, авторизованных для использования ваших прокси через аутентификацию по IP. На одну подписку допускается до 150 IP. На шлюзе действуют только записи со статусом active.

Список whitelist

Endpoint

GET /api/v2/rotating-proxies/whitelist/

Параметры запроса

Параметр	Тип	Обязательный	Описание
search	string	Нет	Фильтр по IP или комментарию
page	integer	Нет	Номер страницы
page_size	integer	Нет	Количество результатов на странице

Запрос

curl -X 'GET' \
  'https://app.cyberyozh.com/api/v2/rotating-proxies/whitelist/' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: your_api_key_here'

Ответ

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "3b1f8e9a-7c2d-4e5f-8a9b-0c1d2e3f4a5b",
      "ip": "203.0.113.10",
      "status": "active",
      "comment": "office"
    }
  ]
}

Поля ответа

Поле	Тип	Описание
id	string	UUID записи whitelist
ip	string	IPv4-адрес
status	string	active или paused
comment	string	Произвольная заметка

Заменить whitelist

Перезаписывает весь whitelist предоставленным списком IP. IP, отсутствующие в списке, удаляются; новые IP добавляются как active. Отправьте пустой массив, чтобы очистить whitelist.

Endpoint

PUT /api/v2/rotating-proxies/whitelist/

Тело запроса

Поле	Тип	Обязательный	Описание
ips	array of string	Да	IPv4-адреса (макс. 150)

Запрос

curl -X 'PUT' \
  'https://app.cyberyozh.com/api/v2/rotating-proxies/whitelist/' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: your_api_key_here' \
  -H 'Content-Type: application/json' \
  -d '{ "ips": ["203.0.113.10", "203.0.113.11"] }'

Ответ

[
  { "id": "3b1f8e9a-7c2d-4e5f-8a9b-0c1d2e3f4a5b", "ip": "203.0.113.10", "status": "active", "comment": "" },
  { "id": "5d2a9f0b-8e3c-4f6a-9b0c-1d2e3f4a5b6c", "ip": "203.0.113.11", "status": "active", "comment": "" }
]

Изменить запись whitelist

Изменяет статус или комментарий одной записи. Сам IP неизменяем.

Endpoint

PATCH /api/v2/rotating-proxies/whitelist/{id}/

Тело запроса

Поле	Тип	Обязательный	Описание
status	string	Нет	active или paused
comment	string	Нет	Новая заметка (макс. 255 символов)

Запрос

curl -X 'PATCH' \
  'https://app.cyberyozh.com/api/v2/rotating-proxies/whitelist/3b1f8e9a-7c2d-4e5f-8a9b-0c1d2e3f4a5b/' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: your_api_key_here' \
  -H 'Content-Type: application/json' \
  -d '{ "status": "paused", "comment": "office (disabled)" }'

Ответ

{
  "id": "3b1f8e9a-7c2d-4e5f-8a9b-0c1d2e3f4a5b",
  "ip": "203.0.113.10",
  "status": "paused",
  "comment": "office (disabled)"
}

Удалить запись whitelist

Endpoint

DELETE /api/v2/rotating-proxies/whitelist/{id}/

Запрос

curl -X 'DELETE' \
  'https://app.cyberyozh.com/api/v2/rotating-proxies/whitelist/3b1f8e9a-7c2d-4e5f-8a9b-0c1d2e3f4a5b/' \
  -H 'X-Api-Key: your_api_key_here'

Ответ

204 No Content — пустое тело.

Ответы с ошибками

Превышен лимит whitelist (400)

{
  "detail": "Whitelist limit is 150 IPs per subscription."
}

IP неизменяем (400)

{
  "ip": "IP is immutable."
}

Запись не найдена (404)

{
  "detail": "Whitelist entry not found."
}

Примечания

• Трафик авторизуют только записи со статусом active; установите запись в paused, чтобы временно отключить ее без удаления.
• Аутентификацию по IP и аутентификацию по логину/паролю можно использовать вместе.