Sign in

v1

latestOpenAPI 3.0.12026-07-265331168.0 KB
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

Headers

Content-Typestring required

Content type for the request body as application/json.

Request body

ip_address_authenticationsstring[]

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

proxy_user_access_type'all' | 'service_restricted' | 'proxy_restricted'

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
proxy_user_enforce_httpsboolean

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

proxy_user_idstring

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

proxy_user_is_strict_securityboolean

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

proxy_user_metadataobject

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_limitinteger

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

proxy_user_passwordstring

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

proxy_user_residential_bytes_limitinteger

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

Example request

{
  "ip_address_authentications": [
    "1.1.1.1",
    "2.2.2.2"
  ],
  "proxy_user_id": "stevejobs",
  "proxy_user_is_strict_security": true,
  "proxy_user_mobile_bytes_limit": 1000000,
  "proxy_user_password": "apple1984",
  "proxy_user_residential_bytes_limit": 1000000
}

Response

Proxy User Successfully Created

createdstring[] required
messagestring required

A message indicating success.