Skip to main content
POST
Create proxy credential

Authorizations

Authorization
string
header
required

Your organization's active API key.

Body

application/json
name
string
required

Display name shown in the dashboard.

Required string length: 1 - 24
proxy_type
enum<string>
default:residential
Available options:
residential,
datacenter,
mobile

Response

Created 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