Proxies

Purchase a proxy package

Buys a mobile/GB proxy package or a Standard dedicated proxy, either by plan_id (charged to the wallet) or by pool_id (a mobile/GB sub-order drawn from a reseller GB pool the caller owns - see the Proxy pools tag). Provide exactly one of plan_id or pool_id. Returns 202 Accepted. A mobile/GB package comes back status: provisioning and becomes active within 1-2 minutes. A Standard dedicated proxy comes back active with its gateway when the modem is issued immediately, otherwise provisioning (settled within about 5 minutes). The proxy.ready webhook fires when the order becomes active; proxy.provisioning_failed (with the refund) if it cannot be provisioned.

For a Standard dedicated plan, nothing is charged unless the plan is still available: a sold-out plan returns 503 SERVICE_OUT_OF_STOCK and a price above max_price_cents returns 409 PRICE_MISMATCH, both before any charge. Premium dedicated plans are not available over the API.

Wallet deduction and refund-on-failure are atomic for a plan_id purchase. A pool_id purchase never touches the wallet - GB is drawn from the pool's ledger and returned to it if provisioning fails.

post/proxies

Request

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

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

OR

Example request

{
  "plan_id": "plan_RESI100",
  "webhook_endpoint_id": "whep_01HXYZ123ABC"
}

Response

Proxy purchase accepted. Wait for proxy.ready or poll GET /v1/proxies/:id.

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.