Proxy Accesses (Sub-users)

A proxy access (sub-user) is a login/password pair used to authenticate against the proxy gateway. Each access can have its own traffic limit and can be paused or revoked independently. Create accesses to hand out scoped credentials, then build connection usernames from their real_login (see Username grammar).

Your subscription always has one primary access (is_primary: true) which cannot be modified or deleted.

List Accesses

Endpoint

GET /api/v2/rotating-proxies/sub-users/

Query Parameters

Parameter	Type	Required	Description
search	string	No	Filter by login 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/sub-users/' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: your_api_key_here'

Response

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "0f8c4b2e-2d2a-4a7e-9b6a-1f0c2d3e4f5a",
      "login": "primary",
      "real_login": "u12ab",
      "password": "S3cretPass",
      "status": "active",
      "traffic_limit_mb": null,
      "traffic_left_mb": null,
      "comment": "",
      "is_primary": true,
      "provisioning_status": "active"
    },
    {
      "id": "9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d",
      "login": "worker1",
      "real_login": "u12ab_worker1",
      "password": "Str0ngPass",
      "status": "active",
      "traffic_limit_mb": 10240,
      "traffic_left_mb": 8730,
      "comment": "scraper",
      "is_primary": false,
      "provisioning_status": "active"
    }
  ]
}

Response Fields

Field	Type	Description
id	string	Access UUID (use it in /sub-users/{id}/)
login	string	Human-readable label you assigned
real_login	string	Base username for proxy authentication
password	string	Password for proxy authentication
status	string	active or paused
traffic_limit_mb	integer|null	Per-access traffic cap in MB (null = no cap)
traffic_left_mb	integer|null	Remaining traffic for this access (null = no cap)
comment	string	Free-form note
is_primary	boolean	Whether this is the immutable primary access
provisioning_status	string	pending, active or failed

Create Access (Generate)

Creates a new proxy access and provisions it on the gateway.

Endpoint

POST /api/v2/rotating-proxies/sub-users/

Request Body

Field	Type	Required	Description
login	string	Yes	Label and login seed, 3–50 chars, [a-zA-Z0-9]
password	string	Yes	Password, 3–50 chars, [a-zA-Z0-9]
traffic_limit_mb	integer	No	Per-access traffic cap in MB (cannot exceed the plan total)
comment	string	No	Free-form note (max 500 chars)

Request

curl -X 'POST' \
  'https://app.cyberyozh.com/api/v2/rotating-proxies/sub-users/' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: your_api_key_here' \
  -H 'Content-Type: application/json' \
  -d '{
    "login": "worker1",
    "password": "Str0ngPass",
    "traffic_limit_mb": 10240,
    "comment": "scraper"
  }'

Response (201)

{
  "id": "9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d",
  "login": "worker1",
  "real_login": "u12ab_worker1",
  "password": "Str0ngPass",
  "status": "active",
  "traffic_limit_mb": 10240,
  "traffic_left_mb": 10240,
  "comment": "scraper",
  "is_primary": false,
  "provisioning_status": "active"
}

Get Access

Returns a single access, including the real_login and password needed to connect.

Endpoint

GET /api/v2/rotating-proxies/sub-users/{id}/

Request

curl -X 'GET' \
  'https://app.cyberyozh.com/api/v2/rotating-proxies/sub-users/9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d/' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: your_api_key_here'

Response

{
  "id": "9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d",
  "login": "worker1",
  "real_login": "u12ab_worker1",
  "password": "Str0ngPass",
  "status": "active",
  "traffic_limit_mb": 10240,
  "traffic_left_mb": 8730,
  "comment": "scraper",
  "is_primary": false,
  "provisioning_status": "active"
}

Update Access

Change the traffic limit, status, password, login label or comment of a non-primary access.

Endpoint

PATCH /api/v2/rotating-proxies/sub-users/{id}/

Request Body

Field	Type	Required	Description
login	string	No	New label/login seed, 3–50 chars, [a-zA-Z0-9]
password	string	No	New password, 3–50 chars, [a-zA-Z0-9]
traffic_limit_mb	integer	No	New traffic cap in MB
comment	string	No	New note
status	string	No	active or paused

Request

curl -X 'PATCH' \
  'https://app.cyberyozh.com/api/v2/rotating-proxies/sub-users/9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d/' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: your_api_key_here' \
  -H 'Content-Type: application/json' \
  -d '{ "status": "paused" }'

Response

{
  "id": "9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d",
  "login": "worker1",
  "real_login": "u12ab_worker1",
  "password": "Str0ngPass",
  "status": "paused",
  "traffic_limit_mb": 10240,
  "traffic_left_mb": 8730,
  "comment": "scraper",
  "is_primary": false,
  "provisioning_status": "active"
}

Revoke Access (Delete)

Permanently deletes a non-primary access and removes it from the gateway.

Endpoint

DELETE /api/v2/rotating-proxies/sub-users/{id}/

Request

curl -X 'DELETE' \
  'https://app.cyberyozh.com/api/v2/rotating-proxies/sub-users/9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d/' \
  -H 'X-Api-Key: your_api_key_here'

Response

204 No Content — empty body.

Error Responses

Validation Error (400)

{
  "login": [
    "This value does not match the required pattern."
  ]
}

Traffic Limit Too High (400)

{
  "detail": "traffic_limit_mb cannot exceed plan total (51200 MB)."
}

Login Already Exists (409)

{
  "detail": "Login already exists."
}

Primary Access Is Immutable (400)

{
  "detail": "Primary user cannot be deleted."
}

No Active Subscription (404)

{
  "detail": "No active rotating proxy subscription."
}

Notes

• real_login differs from the login label: it is the actual gateway username to which you append targeting suffixes.
• A paused access (status: paused) cannot authenticate until reactivated.
• Setting a traffic_limit_mb caps how much bandwidth that access may consume out of your overall plan balance.