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_is_strict_security: If true, the Proxy User requires an IP address authentication list.
restricted_service_ids: A list of service IDs that the user is restricted to, if service restriction is enabled.
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).

POST

public

user

proxy_user

create

curl --request POST \
  --url https://api.pingproxies.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_id": "stevejobs",
  "proxy_user_is_service_restricted": true,
  "proxy_user_is_strict_security": true,
  "proxy_user_metadata": {},
  "proxy_user_password": "apple1984",
  "proxy_user_residential_bytes_limit": 1000000,
  "restricted_service_ids": [
    "124-1321-123",
    "224-1321-123"
  ]
}'

{
  "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.

The body is of type object.

Response

201 - application/json

Proxy User Successfully Created

The response is of type object.

curl --request POST \
  --url https://api.pingproxies.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_id": "stevejobs",
  "proxy_user_is_service_restricted": true,
  "proxy_user_is_strict_security": true,
  "proxy_user_metadata": {},
  "proxy_user_password": "apple1984",
  "proxy_user_residential_bytes_limit": 1000000,
  "restricted_service_ids": [
    "124-1321-123",
    "224-1321-123"
  ]
}'

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

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_is_strict_security: If true, the Proxy User requires an IP address authentication list.
restricted_service_ids: A list of service IDs that the user is restricted to, if service restriction is enabled.
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).

POST

public

user

proxy_user

create

curl --request POST \
  --url https://api.pingproxies.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_id": "stevejobs",
  "proxy_user_is_service_restricted": true,
  "proxy_user_is_strict_security": true,
  "proxy_user_metadata": {},
  "proxy_user_password": "apple1984",
  "proxy_user_residential_bytes_limit": 1000000,
  "restricted_service_ids": [
    "124-1321-123",
    "224-1321-123"
  ]
}'

{
  "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.

The body is of type object.

Response

201 - application/json

Proxy User Successfully Created

The response is of type object.

curl --request POST \
  --url https://api.pingproxies.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_id": "stevejobs",
  "proxy_user_is_service_restricted": true,
  "proxy_user_is_strict_security": true,
  "proxy_user_metadata": {},
  "proxy_user_password": "apple1984",
  "proxy_user_residential_bytes_limit": 1000000,
  "restricted_service_ids": [
    "124-1321-123",
    "224-1321-123"
  ]
}'

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

Authorizations

Headers

Body

Response

Product Updates

Authorizations

Headers

Body

Response