SOsoax
Packages

Get package details

Retrieve full configuration for one proxy package: status, network types, tiers, traffic usage (in bytes), the package password used for proxy authentication, connection limits, allowed IPs, port and target rules, and enabled protocols.

If the API key is restricted to specific packages, requesting a package outside the restriction returns 404 (not 403), so the existence of other packages is not revealed.

Requires the proxy:packages:read scope.

get/v1/proxy/packages/{package_id}

Request

Path parameters

package_idstring required

The ID of the proxy package

Response

Successful Response

idstring required
namestring required
statusstring required

Display status: active, paused (manually paused), limited (traffic limit reached), suspended, or deleted.

status_reasonstring nullable

Why the package is not active: user_paused, traffic_limit_reached, out_of_credits, account_suspended, plan_limit_exceeded, or null.

created_atstring date-time nullable
typesProxyPackageType[]
tiersinteger[]
allowed_countriesstring[] nullable
traffic_limitinteger nullable
traffic_spentinteger nullable
passwordstring nullable
max_connectionsinteger nullable
allowed_usersstring[] nullable
allowed_ipsstring[]
ports_modestring required
dns_resolverstring required
auth_methodstring required
http_allowedboolean
https_allowedboolean
socks5_tcp_allowedboolean
socks5_udp_allowedboolean
allowed_targetsstring[]
blocked_targetsstring[]
targets_modestring required
special_allowed_targetsstring[]
allowed_target_typesstring[] nullable
traffic_leftinteger nullable required

Calculate the remaining traffic for the package.

Changes

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