Users

Add Users

post

Support adding authentication account 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,9=Mobile Proxies

Example: 1

sub_uidstringRequired

The id of the sub-user

Example: 123

userstringRequired

User name

Example: test_account1

passwordstringRequired

User password

Example: Testpassword002

statusintegerRequired

Status:1=normal,-5=disabled

Example: 1

remarkstringOptional

User Remark

Example: some remark

use_upper_limitintegerOptional

Traffic usage cap for the account (Unit: GB). Optional field; if null/empty, there is no usage limit.

Example: 1

Responses

200Success

application/json

404Error

application/json

post

/v2/users/create

HTTPcURLJavaScriptPython

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

{
  "product": 1,
  "sub_uid": "123",
  "user": "test_account1",
  "password": "Testpassword002",
  "status": 1,
  "remark": "some remark",
  "use_upper_limit": 1
}

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

Edit Users

post

Support editing authentication account 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

sub_uidintegerRequired

The id of the sub-user

Example: 123

uidintegerRequired

The id of the user

Example: 668

statusintegerRequired

Status:1=Normal，-5=disabled

Example: -5

use_upper_limitintegerOptional

Traffic usage cap for the account (Unit: GB). Optional field; if null/empty, there is no usage limit.

Example: 1

Responses

200Success

application/json

404Error

application/json

post

/v2/users/edit

HTTPcURLJavaScriptPython

POST /v2/users/edit HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 57

{
  "sub_uid": 123,
  "uid": 668,
  "status": -5,
  "use_upper_limit": 1
}

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

Get Users List

post

Supports retrieving added verified accounts 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,9=Mobile Proxies

Example: 1

sub_uidintegerOptional

The id of the sub-user

Example: 123

uidintegerOptional

The id of the user

Example: 668

pageintegerOptional

page

Example: 1

limitintegerOptional

page size

Example: 10

Responses

200Success

application/json

post

/v2/users/list

HTTPcURLJavaScriptPython

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

{
  "product": 1,
  "sub_uid": 123,
  "uid": 668,
  "page": 1,
  "limit": 10
}

200Success

{
  "code": 0,
  "data": {
    "list": [
      {
        "user_id": 2210,
        "sub_user_id": 2926,
        "user": "test_wfd_002_001",
        "password": "Testpassword1223",
        "status": 1,
        "flow_type": "resi",
        "account_type": "limit",
        "remark": "",
        "residential_traffic_usage": 0,
        "residential_upper_limit": 1000000000,
        "product": "1",
        "created_at": 1765952026,
        "updated_at": 1766544900,
        "sub_username": "test_wfd_002"
      }
    ],
    "total": 3
  },
  "msg": "success",
  "timestamp": 1766544982
}