Create Proxy User

curl --request POST \
  --url https://api.byteful.com/1.0/public/user/proxy_user/create \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>' \
  --data '
{
  "ip_address_authentications": [
    "1.1.1.1",
    "2.2.2.2"
  ],
  "proxy_user_access_type": "all",
  "proxy_user_enforce_https": false,
  "proxy_user_id": "stevejobs",
  "proxy_user_is_strict_security": true,
  "proxy_user_metadata": {},
  "proxy_user_mobile_bytes_limit": 1000000,
  "proxy_user_password": "apple1984",
  "proxy_user_residential_bytes_limit": 1000000
}
'

import requests

url = "https://api.byteful.com/1.0/public/user/proxy_user/create"

payload = {
    "ip_address_authentications": ["1.1.1.1", "2.2.2.2"],
    "proxy_user_access_type": "all",
    "proxy_user_enforce_https": False,
    "proxy_user_id": "stevejobs",
    "proxy_user_is_strict_security": True,
    "proxy_user_metadata": {},
    "proxy_user_mobile_bytes_limit": 1000000,
    "proxy_user_password": "apple1984",
    "proxy_user_residential_bytes_limit": 1000000
}
headers = {
    "Content-Type": "<content-type>",
    "X-API-Private-Key": "<api-key>",
    "X-API-Public-Key": "<api-key>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Content-Type': '<content-type>',
    'X-API-Private-Key': '<api-key>',
    'X-API-Public-Key': '<api-key>'
  },
  body: JSON.stringify({
    ip_address_authentications: ['1.1.1.1', '2.2.2.2'],
    proxy_user_access_type: 'all',
    proxy_user_enforce_https: false,
    proxy_user_id: 'stevejobs',
    proxy_user_is_strict_security: true,
    proxy_user_metadata: {},
    proxy_user_mobile_bytes_limit: 1000000,
    proxy_user_password: 'apple1984',
    proxy_user_residential_bytes_limit: 1000000
  })
};

fetch('https://api.byteful.com/1.0/public/user/proxy_user/create', 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/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ip_address_authentications' => [
        '1.1.1.1',
        '2.2.2.2'
    ],
    'proxy_user_access_type' => 'all',
    'proxy_user_enforce_https' => false,
    'proxy_user_id' => 'stevejobs',
    'proxy_user_is_strict_security' => true,
    'proxy_user_metadata' => [
        
    ],
    'proxy_user_mobile_bytes_limit' => 1000000,
    'proxy_user_password' => 'apple1984',
    'proxy_user_residential_bytes_limit' => 1000000
  ]),
  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/create"

	payload := strings.NewReader("{\n  \"ip_address_authentications\": [\n    \"1.1.1.1\",\n    \"2.2.2.2\"\n  ],\n  \"proxy_user_access_type\": \"all\",\n  \"proxy_user_enforce_https\": false,\n  \"proxy_user_id\": \"stevejobs\",\n  \"proxy_user_is_strict_security\": true,\n  \"proxy_user_metadata\": {},\n  \"proxy_user_mobile_bytes_limit\": 1000000,\n  \"proxy_user_password\": \"apple1984\",\n  \"proxy_user_residential_bytes_limit\": 1000000\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.byteful.com/1.0/public/user/proxy_user/create")
  .header("Content-Type", "<content-type>")
  .header("X-API-Private-Key", "<api-key>")
  .header("X-API-Public-Key", "<api-key>")
  .body("{\n  \"ip_address_authentications\": [\n    \"1.1.1.1\",\n    \"2.2.2.2\"\n  ],\n  \"proxy_user_access_type\": \"all\",\n  \"proxy_user_enforce_https\": false,\n  \"proxy_user_id\": \"stevejobs\",\n  \"proxy_user_is_strict_security\": true,\n  \"proxy_user_metadata\": {},\n  \"proxy_user_mobile_bytes_limit\": 1000000,\n  \"proxy_user_password\": \"apple1984\",\n  \"proxy_user_residential_bytes_limit\": 1000000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.byteful.com/1.0/public/user/proxy_user/create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["X-API-Private-Key"] = '<api-key>'
request["X-API-Public-Key"] = '<api-key>'
request.body = "{\n  \"ip_address_authentications\": [\n    \"1.1.1.1\",\n    \"2.2.2.2\"\n  ],\n  \"proxy_user_access_type\": \"all\",\n  \"proxy_user_enforce_https\": false,\n  \"proxy_user_id\": \"stevejobs\",\n  \"proxy_user_is_strict_security\": true,\n  \"proxy_user_metadata\": {},\n  \"proxy_user_mobile_bytes_limit\": 1000000,\n  \"proxy_user_password\": \"apple1984\",\n  \"proxy_user_residential_bytes_limit\": 1000000\n}"

response = http.request(request)
puts response.read_body

{
  "created": [
    "stevejobs"
  ],
  "data": {
    "proxy_user_id": "stevejobs",
    "proxy_user_password": "apple1984"
  },
  "message": "Proxy User successfully created."
}

Proxy User

Create Proxy User

This endpoint allows you to create a new proxy user.

The proxy_user_id and proxy_user_password can be provided or, if omitted, will be randomly generated.

Additional considerations when creating a Proxy User:

proxy_user_access_type: Controls access restrictions (“all”, “service_restricted”, “proxy_restricted”)
proxy_user_is_strict_security: If true, the Proxy User requires an IP address authentication list.
proxy_user_enforce_https: If true, this Proxy User can only access targets on port 443 (HTTPS).
ip_address_authentications must be a list of valid IP addresses. Each IP address can only be used by one Proxy User.
proxy_user_residential_bytes_limit: An integer limiting residential traffic (must not be negative).
proxy_user_mobile_bytes_limit: An integer limiting mobile traffic (must not be negative).

For access control, use the ProxyUserAcl endpoints to grant specific service or proxy access when using “service_restricted” or “proxy_restricted” access types.

POST

public

user

proxy_user

create

Create Proxy User

curl --request POST \
  --url https://api.byteful.com/1.0/public/user/proxy_user/create \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>' \
  --data '
{
  "ip_address_authentications": [
    "1.1.1.1",
    "2.2.2.2"
  ],
  "proxy_user_access_type": "all",
  "proxy_user_enforce_https": false,
  "proxy_user_id": "stevejobs",
  "proxy_user_is_strict_security": true,
  "proxy_user_metadata": {},
  "proxy_user_mobile_bytes_limit": 1000000,
  "proxy_user_password": "apple1984",
  "proxy_user_residential_bytes_limit": 1000000
}
'

import requests

url = "https://api.byteful.com/1.0/public/user/proxy_user/create"

payload = {
    "ip_address_authentications": ["1.1.1.1", "2.2.2.2"],
    "proxy_user_access_type": "all",
    "proxy_user_enforce_https": False,
    "proxy_user_id": "stevejobs",
    "proxy_user_is_strict_security": True,
    "proxy_user_metadata": {},
    "proxy_user_mobile_bytes_limit": 1000000,
    "proxy_user_password": "apple1984",
    "proxy_user_residential_bytes_limit": 1000000
}
headers = {
    "Content-Type": "<content-type>",
    "X-API-Private-Key": "<api-key>",
    "X-API-Public-Key": "<api-key>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Content-Type': '<content-type>',
    'X-API-Private-Key': '<api-key>',
    'X-API-Public-Key': '<api-key>'
  },
  body: JSON.stringify({
    ip_address_authentications: ['1.1.1.1', '2.2.2.2'],
    proxy_user_access_type: 'all',
    proxy_user_enforce_https: false,
    proxy_user_id: 'stevejobs',
    proxy_user_is_strict_security: true,
    proxy_user_metadata: {},
    proxy_user_mobile_bytes_limit: 1000000,
    proxy_user_password: 'apple1984',
    proxy_user_residential_bytes_limit: 1000000
  })
};

fetch('https://api.byteful.com/1.0/public/user/proxy_user/create', 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/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ip_address_authentications' => [
        '1.1.1.1',
        '2.2.2.2'
    ],
    'proxy_user_access_type' => 'all',
    'proxy_user_enforce_https' => false,
    'proxy_user_id' => 'stevejobs',
    'proxy_user_is_strict_security' => true,
    'proxy_user_metadata' => [
        
    ],
    'proxy_user_mobile_bytes_limit' => 1000000,
    'proxy_user_password' => 'apple1984',
    'proxy_user_residential_bytes_limit' => 1000000
  ]),
  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/create"

	payload := strings.NewReader("{\n  \"ip_address_authentications\": [\n    \"1.1.1.1\",\n    \"2.2.2.2\"\n  ],\n  \"proxy_user_access_type\": \"all\",\n  \"proxy_user_enforce_https\": false,\n  \"proxy_user_id\": \"stevejobs\",\n  \"proxy_user_is_strict_security\": true,\n  \"proxy_user_metadata\": {},\n  \"proxy_user_mobile_bytes_limit\": 1000000,\n  \"proxy_user_password\": \"apple1984\",\n  \"proxy_user_residential_bytes_limit\": 1000000\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.byteful.com/1.0/public/user/proxy_user/create")
  .header("Content-Type", "<content-type>")
  .header("X-API-Private-Key", "<api-key>")
  .header("X-API-Public-Key", "<api-key>")
  .body("{\n  \"ip_address_authentications\": [\n    \"1.1.1.1\",\n    \"2.2.2.2\"\n  ],\n  \"proxy_user_access_type\": \"all\",\n  \"proxy_user_enforce_https\": false,\n  \"proxy_user_id\": \"stevejobs\",\n  \"proxy_user_is_strict_security\": true,\n  \"proxy_user_metadata\": {},\n  \"proxy_user_mobile_bytes_limit\": 1000000,\n  \"proxy_user_password\": \"apple1984\",\n  \"proxy_user_residential_bytes_limit\": 1000000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.byteful.com/1.0/public/user/proxy_user/create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["X-API-Private-Key"] = '<api-key>'
request["X-API-Public-Key"] = '<api-key>'
request.body = "{\n  \"ip_address_authentications\": [\n    \"1.1.1.1\",\n    \"2.2.2.2\"\n  ],\n  \"proxy_user_access_type\": \"all\",\n  \"proxy_user_enforce_https\": false,\n  \"proxy_user_id\": \"stevejobs\",\n  \"proxy_user_is_strict_security\": true,\n  \"proxy_user_metadata\": {},\n  \"proxy_user_mobile_bytes_limit\": 1000000,\n  \"proxy_user_password\": \"apple1984\",\n  \"proxy_user_residential_bytes_limit\": 1000000\n}"

response = http.request(request)
puts response.read_body

{
  "created": [
    "stevejobs"
  ],
  "data": {
    "proxy_user_id": "stevejobs",
    "proxy_user_password": "apple1984"
  },
  "message": "Proxy User successfully created."
}

Authorizations

X-API-Private-Key

string

header

required

Private API key for user-level authentication.

X-API-Public-Key

string

header

required

Public API key for user-level authentication.

Headers

Content-Type

string

default:application/json

required

Content type for the request body as application/json.

Body

application/json

The details of the proxy user to be created.

ip_address_authentications

string[]

A list of IP addresses for Proxy User authentication. Each IP can only be used by one Proxy User.

Example:

["1.1.1.1", "2.2.2.2"]

proxy_user_access_type

enum<string>

default:all

Access control type for the proxy user:

"all": Unrestricted access (default)
"service_restricted": Access restricted by ProxyUserAcl service entries
"proxy_restricted": Access restricted by ProxyUserAcl proxy entries

Available options:

all,

service_restricted,

proxy_restricted

proxy_user_enforce_https

boolean

default:false

If true, this Proxy User can only access targets on port 443 (HTTPS). This is useful for enforcing secure connections.

Example:

false

proxy_user_id

string

default:Randomly generated

The ID of the proxy user. If not provided, it will be randomly generated.

Required string length: 10 - 32

Example:

"stevejobs"

proxy_user_is_strict_security

boolean

default:false

Enable strict security. If true, IP authentication is required.

Example:

true

proxy_user_metadata

object

Arbitrary metadata object for the Proxy User. Constraints

Supports string, boolean, float and integer values.
Non-nested JSON object
Max 30 keys
Each value ≤ 300 chars
Total size ≤ 32KB Defaults to {} if not provided.

proxy_user_mobile_bytes_limit

integer

Mobile bytes limit for the Proxy User (must not be negative).

Example:

1000000

proxy_user_password

string

default:Randomly generated

The password of the proxy user. If not provided, it will be randomly generated.

Required string length: 10 - 32

Example:

"apple1984"

proxy_user_residential_bytes_limit

integer

Residential bytes limit for the Proxy User (must not be negative).

Example:

1000000

Response

201 - application/json

Proxy User Successfully Created

created

string[]

required

A list containing the ID of the created Proxy User.

data

object

required

Show child attributes

message

string

required

A message indicating success.

Get Proxy User List Options Retrieve Proxy User

Customer

Proxy

Proxy User

Proxy User ACL

Residential

Residential Availability

Residential Ledger

Mobile

Mobile Availability

Mobile Ledger

Service

Service Adjustment

Checkout

Analytics

Product

ASN

Continent

Country

Subdivision

City

Zip Code

Proxy Tester

Create Proxy User

Authorizations

Headers

Body

Response