IP Whitelist

Add IP to Whitelist

post

Support adding whitelisted IPs via API.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

langstringOptional

Language：en|cn

Default: enExample: en

Body

multipart/form-data

productintegerRequired

Product: 1=Residential Proxies,4=Unlimited Proxies,5=Static Proxies

Example: 1

sub_uidstringRequired

The id of the sub-user

Example: 123

ipstringRequired

IP whitelist(separated by commas)

Example: 6.21.16.32,127.0.0.1

remarkstringOptional

Remark

Example: some remark

Responses

200Success

application/json

404Error

application/json

post

/v2/ip_whitelist/create

HTTPcURLJavaScriptPython

POST /v2/ip_whitelist/create HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 80

{
  "product": 1,
  "sub_uid": "123",
  "ip": "6.21.16.32,127.0.0.1",
  "remark": "some remark"
}

{
  "code": 0,
  "data": null,
  "msg": "success",
  "timestamp": 1751455773
}

Remove IP Whitelist

post

Support deleting whitelisted IPs via API.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

langstringOptional

Language：en|cn

Default: enExample: en

Body

multipart/form-data

productintegerRequired

Product: 1=Residential Proxies,4=Unlimited Proxies,5=Static Proxies

Example: 1

sub_uidstringRequired

The id of the sub-user

Example: 123

idstringRequired

The id of ip whitelist

Example: 279

Responses

200Success

application/json

404Error

application/json

post

/v2/ip_whitelist/del

HTTPcURLJavaScriptPython

POST /v2/ip_whitelist/del HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 40

{
  "product": 1,
  "sub_uid": "123",
  "id": "279"
}

{
  "code": 0,
  "data": null,
  "msg": "success",
  "timestamp": 1751455829
}

List IP Whitelist

post

Support retrieving the list of whitelisted IPs via API.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

langstringOptional

Language：en|cn

Default: enExample: en

Body

multipart/form-data

productintegerRequired

Product: 1=Residential Proxies,4=Unlimited Proxies,5=Static Proxies

Example: 1

keywordstringOptional

Search:sub-username/sub_uid

Example: test_name

ipstringOptional

ip whitelist

Example: 10.2.0.4

pageintegerOptional

page

Example: 1

limitintegerOptional

page size

Example: 10

Responses

200Success

application/json

post

/v2/ip_whitelist/list

HTTPcURLJavaScriptPython

POST /v2/ip_whitelist/list HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 71

{
  "product": 1,
  "keyword": "test_name",
  "ip": "10.2.0.4",
  "page": 1,
  "limit": 10
}

200Success

{
  "code": 0,
  "data": {
    "list": [
      {
        "id": 1,
        "sub_uid": 123,
        "ip_whitelist": "6.21.16.33",
        "status": 1,
        "product": 1,
        "sub_username": "test_user_123",
        "created_at": 1766629483,
        "updated_at": 1766629483
      }
    ],
    "total": 2
  },
  "msg": "success",
  "timestamp": 1766630231
}