Edit Proxy User
curl --request PATCH \
--url https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id} \
--header 'Content-Type: <content-type>' \
--header 'X-API-Private-Key: <api-key>' \
--header 'X-API-Public-Key: <api-key>' \
--data '
{
"clear_proxy_user_acl": true,
"ip_address_authentications": [
"1.1.1.1",
"2.2.2.2"
],
"proxy_user_enforce_https": false,
"proxy_user_is_strict_security": false,
"proxy_user_metadata": {
"internal_customer_id": "94266dc6-b29f-4499-a7a8-35232d186706"
},
"proxy_user_mobile_bytes_limit": 1000000,
"proxy_user_password": "newPass1241233",
"proxy_user_residential_bytes_limit": 1000000,
"tcp_fingerprint_label": "windows"
}
'import requests
url = "https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}"
payload = {
"clear_proxy_user_acl": True,
"ip_address_authentications": ["1.1.1.1", "2.2.2.2"],
"proxy_user_enforce_https": False,
"proxy_user_is_strict_security": False,
"proxy_user_metadata": { "internal_customer_id": "94266dc6-b29f-4499-a7a8-35232d186706" },
"proxy_user_mobile_bytes_limit": 1000000,
"proxy_user_password": "newPass1241233",
"proxy_user_residential_bytes_limit": 1000000,
"tcp_fingerprint_label": "windows"
}
headers = {
"Content-Type": "<content-type>",
"X-API-Private-Key": "<api-key>",
"X-API-Public-Key": "<api-key>"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Content-Type': '<content-type>',
'X-API-Private-Key': '<api-key>',
'X-API-Public-Key': '<api-key>'
},
body: JSON.stringify({
clear_proxy_user_acl: true,
ip_address_authentications: ['1.1.1.1', '2.2.2.2'],
proxy_user_enforce_https: false,
proxy_user_is_strict_security: false,
proxy_user_metadata: {internal_customer_id: '94266dc6-b29f-4499-a7a8-35232d186706'},
proxy_user_mobile_bytes_limit: 1000000,
proxy_user_password: 'newPass1241233',
proxy_user_residential_bytes_limit: 1000000,
tcp_fingerprint_label: 'windows'
})
};
fetch('https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'clear_proxy_user_acl' => true,
'ip_address_authentications' => [
'1.1.1.1',
'2.2.2.2'
],
'proxy_user_enforce_https' => false,
'proxy_user_is_strict_security' => false,
'proxy_user_metadata' => [
'internal_customer_id' => '94266dc6-b29f-4499-a7a8-35232d186706'
],
'proxy_user_mobile_bytes_limit' => 1000000,
'proxy_user_password' => 'newPass1241233',
'proxy_user_residential_bytes_limit' => 1000000,
'tcp_fingerprint_label' => 'windows'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: <content-type>",
"X-API-Private-Key: <api-key>",
"X-API-Public-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}"
payload := strings.NewReader("{\n \"clear_proxy_user_acl\": true,\n \"ip_address_authentications\": [\n \"1.1.1.1\",\n \"2.2.2.2\"\n ],\n \"proxy_user_enforce_https\": false,\n \"proxy_user_is_strict_security\": false,\n \"proxy_user_metadata\": {\n \"internal_customer_id\": \"94266dc6-b29f-4499-a7a8-35232d186706\"\n },\n \"proxy_user_mobile_bytes_limit\": 1000000,\n \"proxy_user_password\": \"newPass1241233\",\n \"proxy_user_residential_bytes_limit\": 1000000,\n \"tcp_fingerprint_label\": \"windows\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "<content-type>")
req.Header.Add("X-API-Private-Key", "<api-key>")
req.Header.Add("X-API-Public-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}")
.header("Content-Type", "<content-type>")
.header("X-API-Private-Key", "<api-key>")
.header("X-API-Public-Key", "<api-key>")
.body("{\n \"clear_proxy_user_acl\": true,\n \"ip_address_authentications\": [\n \"1.1.1.1\",\n \"2.2.2.2\"\n ],\n \"proxy_user_enforce_https\": false,\n \"proxy_user_is_strict_security\": false,\n \"proxy_user_metadata\": {\n \"internal_customer_id\": \"94266dc6-b29f-4499-a7a8-35232d186706\"\n },\n \"proxy_user_mobile_bytes_limit\": 1000000,\n \"proxy_user_password\": \"newPass1241233\",\n \"proxy_user_residential_bytes_limit\": 1000000,\n \"tcp_fingerprint_label\": \"windows\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = '<content-type>'
request["X-API-Private-Key"] = '<api-key>'
request["X-API-Public-Key"] = '<api-key>'
request.body = "{\n \"clear_proxy_user_acl\": true,\n \"ip_address_authentications\": [\n \"1.1.1.1\",\n \"2.2.2.2\"\n ],\n \"proxy_user_enforce_https\": false,\n \"proxy_user_is_strict_security\": false,\n \"proxy_user_metadata\": {\n \"internal_customer_id\": \"94266dc6-b29f-4499-a7a8-35232d186706\"\n },\n \"proxy_user_mobile_bytes_limit\": 1000000,\n \"proxy_user_password\": \"newPass1241233\",\n \"proxy_user_residential_bytes_limit\": 1000000,\n \"tcp_fingerprint_label\": \"windows\"\n}"
response = http.request(request)
puts response.read_body{
"edited": [
"stevejobs"
],
"message": "Proxy User successfully edited.",
"proxy_user_acl_deleted": [
"123e4567-e89b-12d3-a456-426614174000"
]
}Proxy User
Edit Proxy User
This endpoint allows a user to edit an existing Proxy User entry by providing the necessary proxy_user_id.
For access control, use the ProxyUserAcl endpoints to manage specific service or proxy access when using “service_restricted” or “proxy_restricted” access types.
PATCH
/
public
/
user
/
proxy_user
/
edit
/
{proxy_user_id}
Edit Proxy User
curl --request PATCH \
--url https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id} \
--header 'Content-Type: <content-type>' \
--header 'X-API-Private-Key: <api-key>' \
--header 'X-API-Public-Key: <api-key>' \
--data '
{
"clear_proxy_user_acl": true,
"ip_address_authentications": [
"1.1.1.1",
"2.2.2.2"
],
"proxy_user_enforce_https": false,
"proxy_user_is_strict_security": false,
"proxy_user_metadata": {
"internal_customer_id": "94266dc6-b29f-4499-a7a8-35232d186706"
},
"proxy_user_mobile_bytes_limit": 1000000,
"proxy_user_password": "newPass1241233",
"proxy_user_residential_bytes_limit": 1000000,
"tcp_fingerprint_label": "windows"
}
'import requests
url = "https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}"
payload = {
"clear_proxy_user_acl": True,
"ip_address_authentications": ["1.1.1.1", "2.2.2.2"],
"proxy_user_enforce_https": False,
"proxy_user_is_strict_security": False,
"proxy_user_metadata": { "internal_customer_id": "94266dc6-b29f-4499-a7a8-35232d186706" },
"proxy_user_mobile_bytes_limit": 1000000,
"proxy_user_password": "newPass1241233",
"proxy_user_residential_bytes_limit": 1000000,
"tcp_fingerprint_label": "windows"
}
headers = {
"Content-Type": "<content-type>",
"X-API-Private-Key": "<api-key>",
"X-API-Public-Key": "<api-key>"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Content-Type': '<content-type>',
'X-API-Private-Key': '<api-key>',
'X-API-Public-Key': '<api-key>'
},
body: JSON.stringify({
clear_proxy_user_acl: true,
ip_address_authentications: ['1.1.1.1', '2.2.2.2'],
proxy_user_enforce_https: false,
proxy_user_is_strict_security: false,
proxy_user_metadata: {internal_customer_id: '94266dc6-b29f-4499-a7a8-35232d186706'},
proxy_user_mobile_bytes_limit: 1000000,
proxy_user_password: 'newPass1241233',
proxy_user_residential_bytes_limit: 1000000,
tcp_fingerprint_label: 'windows'
})
};
fetch('https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'clear_proxy_user_acl' => true,
'ip_address_authentications' => [
'1.1.1.1',
'2.2.2.2'
],
'proxy_user_enforce_https' => false,
'proxy_user_is_strict_security' => false,
'proxy_user_metadata' => [
'internal_customer_id' => '94266dc6-b29f-4499-a7a8-35232d186706'
],
'proxy_user_mobile_bytes_limit' => 1000000,
'proxy_user_password' => 'newPass1241233',
'proxy_user_residential_bytes_limit' => 1000000,
'tcp_fingerprint_label' => 'windows'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: <content-type>",
"X-API-Private-Key: <api-key>",
"X-API-Public-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}"
payload := strings.NewReader("{\n \"clear_proxy_user_acl\": true,\n \"ip_address_authentications\": [\n \"1.1.1.1\",\n \"2.2.2.2\"\n ],\n \"proxy_user_enforce_https\": false,\n \"proxy_user_is_strict_security\": false,\n \"proxy_user_metadata\": {\n \"internal_customer_id\": \"94266dc6-b29f-4499-a7a8-35232d186706\"\n },\n \"proxy_user_mobile_bytes_limit\": 1000000,\n \"proxy_user_password\": \"newPass1241233\",\n \"proxy_user_residential_bytes_limit\": 1000000,\n \"tcp_fingerprint_label\": \"windows\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "<content-type>")
req.Header.Add("X-API-Private-Key", "<api-key>")
req.Header.Add("X-API-Public-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}")
.header("Content-Type", "<content-type>")
.header("X-API-Private-Key", "<api-key>")
.header("X-API-Public-Key", "<api-key>")
.body("{\n \"clear_proxy_user_acl\": true,\n \"ip_address_authentications\": [\n \"1.1.1.1\",\n \"2.2.2.2\"\n ],\n \"proxy_user_enforce_https\": false,\n \"proxy_user_is_strict_security\": false,\n \"proxy_user_metadata\": {\n \"internal_customer_id\": \"94266dc6-b29f-4499-a7a8-35232d186706\"\n },\n \"proxy_user_mobile_bytes_limit\": 1000000,\n \"proxy_user_password\": \"newPass1241233\",\n \"proxy_user_residential_bytes_limit\": 1000000,\n \"tcp_fingerprint_label\": \"windows\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = '<content-type>'
request["X-API-Private-Key"] = '<api-key>'
request["X-API-Public-Key"] = '<api-key>'
request.body = "{\n \"clear_proxy_user_acl\": true,\n \"ip_address_authentications\": [\n \"1.1.1.1\",\n \"2.2.2.2\"\n ],\n \"proxy_user_enforce_https\": false,\n \"proxy_user_is_strict_security\": false,\n \"proxy_user_metadata\": {\n \"internal_customer_id\": \"94266dc6-b29f-4499-a7a8-35232d186706\"\n },\n \"proxy_user_mobile_bytes_limit\": 1000000,\n \"proxy_user_password\": \"newPass1241233\",\n \"proxy_user_residential_bytes_limit\": 1000000,\n \"tcp_fingerprint_label\": \"windows\"\n}"
response = http.request(request)
puts response.read_body{
"edited": [
"stevejobs"
],
"message": "Proxy User successfully edited.",
"proxy_user_acl_deleted": [
"123e4567-e89b-12d3-a456-426614174000"
]
}Authorizations
Private API key for user-level authentication.
Public API key for user-level authentication.
Headers
Content type for the request body as application/json.
Path Parameters
ID of the proxy user record to edit.
Body
application/json
The Proxy User details to be edited.
When changing access_type, set to True to clear all existing ProxyUserAcl entries. Required when changing to "all" if ACLs exist. Optional for other access_type changes.
A list of valid IP addresses authenticated for this Proxy User.
Example:
["1.1.1.1", "2.2.2.2"]
Access control type for the proxy user:
- "all": Unrestricted access
- "service_restricted": Access restricted by ProxyUserAcl service entries
- "proxy_restricted": Access restricted by ProxyUserAcl proxy entries
Note: Default proxy users (proxy_user_is_default=true) must always have access_type "all" and cannot be changed to restricted access types.
Available options:
all, service_restricted, proxy_restricted If true, this Proxy User can only access targets on port 443 (HTTPS). This is useful for enforcing secure connections.
Example:
false
Enable or disable strict security for the Proxy User.
Example:
false
Arbitrary metadata object associated with the Proxy User. Constraints
- Supports string, boolean, float and integer values.
- Must be a non-nested JSON object.
- Maximum 30 keys.
- Each value's string representation ≤ 300 characters.
- Total size ≤ 32KB.
Example:
{
"internal_customer_id": "94266dc6-b29f-4499-a7a8-35232d186706"
}
The mobile bytes limit for the Proxy User (must be ≥ current usage).
Example:
1000000
The new password for the Proxy User. Must be alphanumeric, 10 to 32 characters.
Example:
"newPass1241233"
The residential bytes limit for the Proxy User (must be ≥ current usage).
Example:
1000000
The name of the TCP fingerprint label to apply to the Proxy User (for example windows, linux or macos). Must match an existing TCP fingerprint label. Set to null to remove the label.
Example:
"windows"
Response
200 - application/json
Proxy User Successfully Edited
List of Proxy User IDs that were successfully edited.
The Proxy User ID.
Example:
["stevejobs"]
Success message indicating the Proxy User was edited.
Example:
"Proxy User successfully edited."
List of ProxyUserAcl IDs that were deleted during the edit operation (when access_type is set to "all").
The ProxyUserAcl ID.
Example:
["123e4567-e89b-12d3-a456-426614174000"]