IP Whitelist

Manage the list of IP addresses authorized to use your proxies via IP authentication. Up to 150 IPs are allowed per subscription. Only active entries are enforced on the gateway.

List Whitelist

Endpoint

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

Query Parameters

Parameter	Type	Required	Description
search	string	No	Filter by IP or comment
page	integer	No	Page number
page_size	integer	No	Results per page

Request

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

Response

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

Response Fields

Field	Type	Description
id	string	Whitelist entry UUID
ip	string	IPv4 address
status	string	active or paused
comment	string	Free-form note

Replace Whitelist

Overwrites the entire whitelist with the provided list of IPs. IPs not in the list are removed; new IPs are added as active. Send an empty array to clear the whitelist.

Endpoint

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

Request Body

Field	Type	Required	Description
ips	array of string	Yes	IPv4 addresses (max 150)

Request

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"] }'

Response

[
  { "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": "" }
]

Update Whitelist Entry

Change the status or comment of a single entry. The IP itself is immutable.

Endpoint

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

Request Body

Field	Type	Required	Description
status	string	No	active or paused
comment	string	No	New note (max 255 chars)

Request

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)" }'

Response

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

Delete Whitelist Entry

Endpoint

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

Request

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'

Response

204 No Content — empty body.

Error Responses

Whitelist Limit Exceeded (400)

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

IP Is Immutable (400)

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

Entry Not Found (404)

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

Notes

• Only active entries authorize traffic; set an entry to paused to temporarily disable it without deleting it.
• IP authentication and username/password authentication can be used together.