traffic

Traffic balance, expiry, credentials and purchase limits

One GB balance per organisation, usable on the mobile 4G/5G and the residential pool. credentials is null until the first purchase is fulfilled, and for an API key without the ports:write scope (the balance stays readable with ports:read). usage is synced from the gateway every 5 minutes. With limits.validity_days 0 GB never expire and expires_at is null; with a positive value every purchase extends expires_at to max(now, current expiry) + that many days.

get/v1/traffic

Request

  • Base URL: https://api.portproof.org
  • URL: https://api.portproof.org/v1/traffic
  • Auth: one of:
    • API key in cookie pp_session
    • HTTP bearer

Response

Default Response

idstring nullable required
status'none' | 'active' | 'exhausted' | 'expired' | 'suspended' required
gb_totalnumber required
gb_usednumber required
gb_leftnumber required
expires_atstring date-time nullable required
enabledboolean required
last_synced_atstring date-time nullable required

Changes

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