Skip to content

Rotate a sub-user proxy password

POST
/users/{id}/password
curl --request POST \
--url https://api.proxyrequest.com/api/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/password \
--header 'Accept-Language: de' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "package_id": "550e8400-e29b-41d4-a716-446655440002" }'

Rotates the proxy password for the selected user’s package order. Send package_id to select the affected order.

id
required
string format: uuid

A UUID string identifying this user.

Accept-Language
string
default: en

Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Examples
de
object
package_id
required

Package whose order’s proxy password should be rotated.

string format: uuid
Examples
ExampleRotatePackagePassword

Rotate package password

{
"package_id": "550e8400-e29b-41d4-a716-446655440002"
}

The request was accepted and the updated resource is returned.

Media typeapplication/json

Customer account with contact details, security settings, package data, referral information, and managed sub-users visible to the caller.

object
id
required
string format: uuid
username
required

At least 3 characters. Spaces and control characters are not allowed.

string
>= 3 characters <= 150 characters
email
required
string format: email
<= 254 characters
is_reseller
Reseller

Reseller can create sub-users and manage their data.

boolean
is_marketer
Marketer

Marketer can manage marketing campaigns and view analytics.

boolean
is_superuser
Superuser status

Designates that this user has all permissions without explicitly assigning them.

boolean
date_joined
required
string format: date-time
date_joined_ts
required

Timestamp of when the user joined

integer
first_name
string
<= 150 characters
last_name
string
<= 150 characters
balance
integer
<= 2147483647
language
  • en - EN * de - DE * fr - FR * it - IT * ru - RU
string
Allowed values: en de fr it ru
country
string
<= 255 characters
state
string
<= 255 characters
city
string
<= 255 characters
address
string
<= 255 characters
zip
string
<= 255 characters
company_name
string
<= 255 characters
company_address
string
<= 255 characters
company_city
string
<= 255 characters
company_postal_code
string
<= 255 characters
company_country
string
<= 255 characters
company_vat_number
string
<= 255 characters
allowed_ips
required

List of IP addresses allowed for this user

Array<string>
blocked_domains
required

List of domains blocked for this user

Array<string>
connection_limit

The maximum number of concurrent connections allowed for this package.

integer
>= -1 <= 2147483647
parent_id
required

ID of the parent user (for sub-accounts)

string
sub_users
required

Number of sub-users managed by this reseller

integer
referrals
required

Number of users referred by this user

integer
referral_id
string
<= 255 characters
referral_code
required
string
referral_data_earned
required
integer
referral_data_pending
required
integer
referral_balance_pending
required
integer
referral_balance_earned
required
integer
currency
required

Currency information for the user’s transactions

object
code
required
string
symbol
required
string
coupons
required

Available coupons for this user

Array<object>
object
id
string
<= 36 characters
is_expired
required
boolean
is_redeemed
required
boolean
packages
required
Array<object>
object
id
string
<= 36 characters
name
required

Unique display name for this package shown to customers and in the admin. Residential Starter Business Pro

string
>= 2 characters <= 255 characters
alias
required

Lowercase alphanumeric identifier used internally for package resolution and proxy username routing. Cannot be changed without affecting active connections. residential01 bizpro

string
>= 2 characters <= 255 characters /^[a-z0-9]+$/
is_unlimited_data
Unlimited Data

When enabled, users on this package have no data cap. The proxy will not enforce any bandwidth limit.

boolean
targeting_options
required
object
package
required
string
split_char
required
string
value_char
required
string
continent
required
string
country
required
string
region
required
string
city
required
string
asn
required
string
isp
required
string
username
required
string
pool
required
string
location
required
string
location_format
required
string
session
required
string
session_mode_tag
required
string
session_ttl
required
string
session_ttl_format
required
integer
os
required
string
os_combined
required
boolean
os_split_char
required
string
os_linux
required
string
os_windows
required
string
os_ios
required
string
os_macos
required
string
os_android
required
string
connection_limit
required
integer
created
required
string format: date-time
value
required

Arbitrary coupon value

integer format: int64
>= -9223372036854776000 <= 9223372036854776000
code
required

Leaving this field empty will generate a random code.

string
is_multi_use
Multi-use

If true, coupon can be used multiple times.

boolean
is_available_to_one_time
Available for One-Time Purchases

If true, coupon can not be used for one-time package tiers.

boolean
type
required
  • free_data - Free Data * monetary - Money * percentage - Percentage
string
Allowed values: free_data monetary percentage
limit

Number of times coupon can be used

integer
>= -2147483648 <= 2147483647
valid_until

Leave empty for coupons that never expire

string format: date-time
nullable
marketer

The marketer who owns this coupon. Required if is_marketer is true.

string format: uuid
nullable
user
required

The user who created this coupon.

string format: uuid
nullable
orders
required

The user’s package orders, including inactive orders. Each order contains its own data allowance, usage, ledgers, and proxy credentials. An empty list means the user has no orders.

Array<object>
object
id
string
<= 36 characters
connection_limit
required
integer
fulfillment_kind
required
string
rental_status
required
string
nullable
is_auto_renewal
required
boolean
auto_renewal_percentage
Auto Renewal Threshold (%)

When this percentage of the data allowance has been consumed, the order is automatically renewed if the user has sufficient balance. Set to 0 to disable auto-renewal. 80 → renew when 80% of data is used

integer
<= 70
auto_renewal_data
Auto Renewal Data (GB)

Amount of data in GB to add when auto-renewal is triggered. Set to 0 to use the package default.

integer
<= 10000
package
required
object
id
string
<= 36 characters
name
required

Unique display name for this package shown to customers and in the admin. Residential Starter Business Pro

string
>= 2 characters <= 255 characters
alias
required

Lowercase alphanumeric identifier used internally for package resolution and proxy username routing. Cannot be changed without affecting active connections. residential01 bizpro

string
>= 2 characters <= 255 characters /^[a-z0-9]+$/
is_unlimited_data
Unlimited Data

When enabled, users on this package have no data cap. The proxy will not enforce any bandwidth limit.

boolean
targeting_options
required
object
package
required
string
split_char
required
string
value_char
required
string
continent
required
string
country
required
string
region
required
string
city
required
string
asn
required
string
isp
required
string
username
required
string
pool
required
string
location
required
string
location_format
required
string
session
required
string
session_mode_tag
required
string
session_ttl
required
string
session_ttl_format
required
integer
os
required
string
os_combined
required
boolean
os_split_char
required
string
os_linux
required
string
os_windows
required
string
os_ios
required
string
os_macos
required
string
os_android
required
string
connection_limit
required
integer
proxy_password

Password used by the customer to authenticate proxy connections. Auto-generated by default — change only if a custom value is needed. Must be between 4 and 64 characters.

string
<= 64 characters
proxy_password_reset
Password Last Changed

Timestamp of the last proxy password change. Read-only — updated automatically whenever the password is rotated.

string format: date-time
nullable
pools

Private proxy pools assigned to this order. Pools restrict which proxy IPs are available to this customer. Leave blank to use the full provider pool.

Array<string>
data
Data Allowance (bytes)

Total data allowance for this order in bytes. 1073741824 = 1 GiB 10737418240 = 10 GiB

integer format: int64
<= 1000000000000000
data_remaining
required

Integer bytes. Root order: sum of usable ledger balances, not data minus data_spent. Virtual child order: max(data - data_spent, 0), a personal quota that does not guarantee the parent still has usable data.

integer
data_spent
required

Integer bytes. Root order: its own usage plus usage of existing linked child orders, including inactive ones. Deleted child orders are excluded. Child order: its own usage.

integer format: int64
ledgers
required

Usable, non-expired ledger balances for a purchased root order; empty for a virtual child order using its parent’s pool. Not a complete history. Array position does not identify the active ledger or spending order.

Array<object>

A purchased data bucket, not a complete transaction history. Finite purchases with an expiration have separate buckets. Compatible non-expiring top-ups and unlimited packages may reuse an existing bucket.

object
id
required
string
data
required
Data Amount (bytes)

Total data allocated to this ledger entry in bytes. 1073741824 = 1 GiB 10737418240 = 10 GiB

integer
data_remaining
required
Remaining Data (bytes)

Bytes still available for consumption from this ledger entry. Decremented in FIFO order as the customer uses the proxy. When this reaches zero the entry is exhausted.

integer
expires
required
Expiration Date

Date and time when this ledger entry expires and any remaining data is forfeited. Leave blank for entries that do not expire.

string format: date-time
nullable
updated
required
string format: date-time
created
required
string format: date-time
latest_data_top_up
Latest Top-up (bytes)

Amount of data added to this order in bytes during the most recent top-up.

integer format: int64
>= -9223372036854776000 <= 9223372036854776000
latest_data_top_up_date
Latest Top-up Date

Timestamp of the most recent data top-up, set when an invoice is fulfilled.

string format: date-time
nullable
data_updated
required
Last Used
string format: date-time
updated
required
string format: date-time
created
required
string format: date-time
Examples
ExampleUpdatedUser

Updated user

{
"id": "550e8400-e29b-41d4-a716-446655440001",
"email": "[email protected]",
"username": "developer",
"first_name": "Dana",
"last_name": "Morgan",
"is_reseller": false,
"orders": []
}

The request is malformed or violates a business rule.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
key
additional properties
One of:
string
Examples
ExampleValidationError

Validation error

{
"non_field_errors": [
"The request could not be processed."
]
}
Content-Language
string

Language used for human-readable errors.

Authentication credentials are missing, expired, or invalid.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
key
additional properties
One of:
string
Examples
ExampleAuthenticationRequired

Authentication required

{
"detail": "Authentication credentials were not provided."
}
Content-Language
string

Language used for human-readable errors.

The authenticated account cannot perform this operation.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
key
additional properties
One of:
string
Examples
ExamplePermissionDenied

Permission denied

{
"detail": "You do not have permission to perform this action."
}
Content-Language
string

Language used for human-readable errors.

The requested resource does not exist in the current account scope.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
key
additional properties
One of:
string
Examples
ExampleResourceNotFound

Resource not found

{
"detail": "Not found."
}
Content-Language
string

Language used for human-readable errors.