Proxies

Create a per-list configuration on a proxy package

Creates a new geo-targeted list under a package. Geo rules:

  • country (single) xor countries (array of 2-30) is required.
  • region, city, isp, zip are only valid with a single country. Violations return 400 PROXY_GEO_CONFLICT.

Max 100 lists per package by default (higher per-package limits available on request). The returned entries[] and credentials.port are resolved and persisted before the response is returned.

Pass network to authenticate the list by source IP instead of login/password. credentials is then null and entries[] carries a bare host:port. The whitelist is create-time only and an address can be whitelisted on one list at a time, so a clash returns 409 PROXY_NETWORK_UNAVAILABLE - retry with a different address.

post/proxies/{id}/lists

Request

  • Base URL: https://dashboard.voidmob.com/api/v1
  • URL: https://dashboard.voidmob.com/api/v1/proxies/{id}/lists
  • Auth: HTTP bearer

Path parameters

idstring required

Opaque proxy package identifier.

Example:prx_8f6a1b2c

Headers

Idempotency-Keystring required
Example:7c4f08c2-2a4f-4c8e-a1d2-9c2b9c8f7e10

Client-supplied key (any string, up to 255 chars) that scopes idempotent replay for write requests. Required on every POST, PATCH, and DELETE. Replays with the same key + same body return the cached response; same key with a different body returns IDEMPOTENCY_CONFLICT. Headers are case-insensitive; both Idempotency-Key and idempotency-key work.

Request body

namestring required
countrystring

ISO-3166-1 alpha-2 (either case accepted, echoed back as sent). Mutually exclusive with countries.

countriesstring[]

Multi-country list. Mutually exclusive with country; subfilters (region/city/isp/zip) are not allowed with countries.

regionstring
citystring
ispstring
zipstring
rotation_period_secondsinteger
rotation_mode'instant' | 'delayed_5s' | 'no_rotation_on_fail'
format'login_pass_host_port' | 'http_url' | 'socks5_url' | 'host_port_login_pass_colon' | 'login_pass_host_port_colon' | 'host_port_login_pass_comma' | 'login_pass_host_port_at'

Saved credential-format preference for the dashboard's list export. API entries are always login:pass@host:port. Each value names the exported line:

  • login_pass_host_port: login:pass@host:port
  • http_url: http://login:pass@host:port
  • socks5_url: socks5://login:pass@host:port
  • host_port_login_pass_colon: host:port:login:pass
  • login_pass_host_port_colon: login:pass:host:port
  • host_port_login_pass_comma: host,port,login,pass
  • login_pass_host_port_at: login@pass@host@port

Deprecated names are still accepted on input but never returned: host_port_login_pass (= host_port_login_pass_comma), host_port (= login_pass_host_port_colon), login_pass_at_host_port (= host_port_login_pass_colon), json (= login_pass_host_port_at).

networkstring

IP-whitelist authentication. Comma-separated IPv4 addresses and/or /24-/32 subnets (max 5 entries, no spaces). The list then authenticates by source IP and returns credentials: null. Set at creation only - it cannot be changed on an existing list. An address can be whitelisted on one list at a time; a clash returns 409 PROXY_NETWORK_UNAVAILABLE.

Response

List created.

successtrue required

Example response

{
  "data": {
    "list": {
      "id": "list_01HXYZ123ABC",
      "proxy_id": "prx_8f6a1b2c",
      "credentials": {
        "host": "proxy.voidmob.com",
        "port": 9901
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.