Session Options

Returns the vocabulary of rotation types, session durations and IP filters supported by the network, along with the username suffix each one maps to. Use it together with the geo endpoints to build a proxy username (see Username grammar).

This is a static catalog — it does not depend on your subscription.

Get Session Options

Endpoint

GET /api/v2/rotating-proxies/session-options/

Request

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

Response

{
  "protocols": [
    { "value": "http", "label": "HTTP(S)", "port_field": "proxy_port" },
    { "value": "socks5", "label": "SOCKS5", "port_field": "proxy_port_socks5" }
  ],
  "session_durations": [
    { "value": "rotating", "label": "Rotating (new IP every request)", "suffix": null },
    { "value": "5m", "label": "Sticky 5 minutes", "suffix": "s-<id>-ttl-5m" },
    { "value": "10m", "label": "Sticky 10 minutes", "suffix": "s-<id>-ttl-10m" },
    { "value": "15m", "label": "Sticky 15 minutes", "suffix": "s-<id>-ttl-15m" },
    { "value": "30m", "label": "Sticky 30 minutes", "suffix": "s-<id>-ttl-30m" },
    { "value": "custom", "label": "Sticky custom minutes", "suffix": "s-<id>-ttl-<minutes>m" }
  ],
  "ip_filters": [
    { "value": "max-size-security", "label": "Max pool size", "suffix": null },
    { "value": "max-speed-security", "label": "Max speed", "suffix": "filter-speed" },
    { "value": "quality-security", "label": "Quality (IQS)", "suffix": "filter-iqs" },
    { "value": "speed-quality-security", "label": "Speed + Quality (IQS)", "suffix": "filter-speed+iqs" }
  ],
  "username_grammar": {
    "order": ["base_login", "country", "region", "city", "zip", "isp", "session", "ttl", "filter"],
    "separator": "-",
    "session_id_length": 8,
    "session_id_alphabet": "A-Za-z0-9",
    "example": "user1-{country_suffix}-s-Ab3xK9pQ-ttl-5m-filter-iqs"
  }
}

Response Fields

Field	Type	Description
protocols	array	Supported protocols. port_field names the field of GET /subscription/ that holds the matching port
session_durations	array	Rotation / sticky-session presets and their username suffix template
ip_filters	array	IP-quality filters and their username suffix
username_grammar	object	Reference describing how to assemble a username

Rotation and session model

value	Behavior	Suffix to append
rotating	A new IP is used on every request	(none)
5m / 10m / 15m / 30m	The same IP is held for the given duration	s-<id>-ttl-<duration>
custom	The same IP is held for a custom number of minutes	s-<id>-ttl-<minutes>m

Where <id> is a random 8-character string from the alphabet A-Za-z0-9 that you generate per session. Reusing the same <id> keeps the same exit IP (until the TTL expires); a new <id> starts a new sticky session.

IP filters

value	Meaning	Suffix
max-size-security	Largest IP pool (default)	(none)
max-speed-security	Prefer fastest IPs	filter-speed
quality-security	Prefer high IP-quality score (IQS)	filter-iqs
speed-quality-security	Balance speed and quality	filter-speed+iqs

Example

Targeting the US (country suffix = us), a 5-minute sticky session and the quality filter:

real_login           = u12ab
session id           = Ab3xK9pQ
final username       = u12ab-us-s-Ab3xK9pQ-ttl-5m-filter-iqs