Proxies

Add GB to a proxy package

Prorated from the plan's per-GB price. Accepted on active, exhausted, and expired packages within 7 days of expiry; a successful top-up leaves the package active and re-arms the proxy.traffic_low / proxy.traffic_exhausted webhooks. Expiry grows in proportion to the GB added, from the current expiry or from now if the package had lapsed.

On a pool-backed sub-order (proxy.pool_id set), the GB is drawn from the pool instead of the wallet and max_price_cents is ignored. See the Proxy pools tag.

Dedicated proxies are unmetered and return 422 NOT_SUPPORTED.

post/proxies/{id}/topup

Request

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

additional_gbinteger required
max_price_centsinteger

Required for a catalog (plan-backed) package; ignored for a pool-backed sub-order, where GB is drawn from the pool instead.

Response

GB added; new totals reflected on the proxy. pool_gb_charged is present when the order is pool-backed.

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.