Skip to main content
GET
Get proxy credential

Authorizations

Authorization
string
header
required

Your organization's active API key.

Path Parameters

username
string
required

Base proxy username, without targeting or session suffixes.

Pattern: ^[a-zA-Z0-9_-]{1,128}$

Response

Credential with its password

id
string<uuid>
required
username
string
required

Base proxy username. Append targeting parameters when you connect.

display_name
string
required
proxy_type
enum<string>
required
Available options:
residential,
datacenter,
mobile
enabled
boolean
required
funding_source
enum<string> | null
required

What pays for traffic: a GB package or the organization balance.

Available options:
package_bytes,
workspace_balance,
null
traffic_used_mb
number
required
Required range: x >= 0
limits_mb
object
required

Traffic limits in MB. 0 means no limit.

created_at
string<date-time>
required
password
string
required

Proxy password. Treat it as a secret.

connection
object
required