Skip to main content
GET
Get package details

Authorizations

Authorization
string
header
required

API key secret (starts with s_live_). Create keys in the dashboard under Settings → API keys, or via POST /v1/api-keys/. Send it as Authorization: Bearer <secret>.

Path Parameters

package_id
string
required

The ID of the proxy package

Response

Successful Response

Response model for package detail endpoint (GET /v1/proxy/packages/{package_id}).

id
string
required
name
string
required
status
string
required

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

ports_mode
string
required
dns_resolver
string
required
auth_method
string
required
targets_mode
string
required
traffic_left
integer | null
required

Calculate the remaining traffic for the package.

status_reason
string | null

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

created_at
string<date-time> | null
types
enum<string>[]
Available options:
mix,
wifi,
mobile
tiers
integer[]
allowed_countries
string[] | null
traffic_limit
integer | null
traffic_spent
integer | null
password
string | null
max_connections
integer | null
allowed_users
string[] | null
allowed_ips
string[]
tcp_available_ports
(integer | string)[]
udp_available_ports
(integer | string)[]
tcp_allowed_ports
(integer | string)[]
udp_allowed_ports
(integer | string)[]
tcp_blocked_ports
(integer | string)[]
udp_blocked_ports
(integer | string)[]
http_allowed
boolean
default:true
https_allowed
boolean
default:true
socks5_tcp_allowed
boolean
default:true
socks5_udp_allowed
boolean
default:true
allowed_targets
string[]
blocked_targets
string[]
special_allowed_targets
string[]
allowed_target_types
string[] | null