Proxies

Get or create the Flex mode gateway credentials

Idempotent get-or-create for the package-level gateway used by Flex mode. First call provisions the credentials; subsequent calls return the persisted credentials without additional work.

Requires the package to be status: active (else 409 PROXY_NOT_READY).

Once provisioned, geo / session / rotation are controlled per request via underscore-prefixed username parameters: _c_<iso>, _sd_<id>, _city_<name>, _asn_<n>, _zip_<code>, _s_<id>, _ttl_<duration>, _rotm_<0|1|2>. See the proxies docs reference for the full parameter list and chaining rules.

post/proxies/{id}/flex_credentials

Request

Base URL: https://dashboard.voidmob.com/api/v1
URL: https://dashboard.voidmob.com/api/v1/proxies/{id}/flex_credentials
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.

Response

Gateway credentials returned on proxy.gateway.

successtrue required

Example response

{
  "data": {
    "proxy": {
      "id": "prx_8f6a1b2c",
      "display_id": "PRX08781M",
      "country": "us",
      "plan_id": "plan_RESI100",
      "pool_id": "pool_3f2b9d3a-1c4e-4a3b-9f0e-6c1d2b3a4f5e",
      "data_gb_total": 100,
      "gateway": {
        "host": "proxy.voidmob.com",
        "port": 10092
      },
      "lists": [
        {
          "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.