PATCH
/
v1
/
proxies
/
auth
/
whitelist
/
{proxyName}
curl --request PATCH \
  --url https://cmd.illusory.io/v1/proxies/auth/whitelist/{proxyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "authorize_ip": "123.123.23,456.456.56/24,789.789.89"
}'
{
  "ok": true,
  "message": "Successfully updated and enabled the whitelist IP(s).",
  "data": {
    "proxy_name": "ILL-US-AU1-9999",
    "last_auth_change": "2050-12-04T17:43:16.407+00:00",
    "whitelist": "123.123.23,456.456.56/24,789.789.89"
  }
}

Whitelist Authentication is a method of restricting access to a proxy server based on the client’s IP address. This is a useful method of restricting access to a proxy server to only those who need it.

By default, all proxies upon deployment utilize a randomly generated basic authorization in the format of username:password. You can disable this basic authorization by updating the proxy’s whitelisted IPs authorized to access the proxy server.

Basic authorization will be disabled upon successfully updating whitelist authorization.

Authorizations

Authorization
string
headerrequired

The Authorization header is used to authenticate with the API using your Master API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

proxyName
string
required

Replace {proxyName} in the url path with YOUR_PROXY.

Body

application/json
authorize_ip
string
required

Set the IP address to authorize. Use commas to specify multiple IP addresses. e.g. 123.123.23,456.456.56/24,789.789.89.

Response

200 - application/json
ok
boolean

Indicates whether the request was successful e.g., true

message
string

Success message

data
object

Was this page helpful?

Update Proxy BasicGet Proxy