PATCH
/
v1
/
proxies
/
auth
/
basic
/
{proxyName}
curl --request PATCH \
  --url https://cmd.illusory.io/v1/proxies/auth/basic/{proxyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "username": "john",
  "password": "wick05"
}'
{
  "ok": true,
  "message": "Both username and password were updated.",
  "data": {
    "proxy_name": "ILL-US-AU1-9999",
    "last_auth_change": "2050-12-04T17:43:16.407+00:00",
    "username": "john",
    "password": "wick05"
  }
}

Basic authentication secures your proxy with a username and password.

By default, all proxies upon deployment utilize a randomly generated basic authorization in the format of username:password.

Whitelist authorization will be disabled upon successfully updating basic 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
username
string

Username for authentication e.g., john. If null, a random username will be generated.

password
string

Password for authentication e.g., wick05. If null, a random password will be generated.

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?

Power Cycle ProxyUpdate Proxy Whitelist