Proxy Account List
GET
/pub/whitelist-account/list
Response Example
200 Response
{
"code": 200,
"msg": "string",
"data": {
"list": [
{
"id": 0,
"username": "string",
"password": "string",
"created_at": "string",
"remark": "string",
"product_type": 9,
"usage_flow": 0,
"limit_flow": 102400,
"status": 0
}
]
}
}
Response Result
| Status Code | Status Code Meaning | Description | Data Model |
|---|---|---|---|
| 200 | OK | Request successful | Inline |
Response Data Structure
Status Code 200
| Name | Type | Required | Constraint | Chinese Name | Description |
|---|---|---|---|---|---|
| » code | responseCode | false | none | Status code: 200 success, 3 invalid app_key | |
| » msg | string | false | none | Status message | |
| » data | object | false | none | none | |
| »» list | [object] | false | none | none | |
| »»» id | integer | false | none | Account ID | |
| »»» username | string | false | none | Proxy account username | |
| »»» password | string | false | none | Proxy account password | |
| »»» created_at | string | false | none | Creation time | |
| »»» remark | string | false | none | Remark | |
| »»» product_type | productTypes | false | none | Package type: 9 Dynamic Residential Traffic Package, 11 Dynamic Residential IP, 14 Static Datacenter IP, 25 Static Residential IP | |
| »»» usage_flow | integer | false | none | Traffic used, unit: KB | |
| »»» limit_flow | integer | false | none | Custom traffic limit: unit GB, maximum 102400, 0 for unlimited | |
| »»» status | integer | false | none | Status: 1 enabled, 0 disabled |
Enumeration Values
| Property | Value |
|---|---|
| product_type | 9 |
| product_type | 11 |
| product_type | 14 |
| product_type | 25 |
Add Proxy Account
POST
/pub/whitelist-account/add
Body Request Parameters
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01:pass,user02:pass,user03:pass",
"remark": "",
"product_type": 9
}
Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | No | none |
| » app_key | body | string | No | Authorization key |
| » accounts | body | string | No | Account and password, please fill in the format username:password. Username and password only support numbers and letters, no special symbols or spaces allowed. Colon separates username and password. Supports batch addition, separated by commas (,). |
| » remark | body | string | No | Proxy account description |
| » product_type | body | productTypes | No | Package type: 9 Dynamic Residential Traffic Package, 11 Dynamic Residential IP, 14 Static Datacenter IP, 25 Static Residential IP |
Enumeration Values
| Property | Value |
|---|---|
| » product_type | 9 |
| » product_type | 11 |
| » product_type | 14 |
| » product_type | 25 |
Response Example
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Response Result
| Status Code | Status Code Meaning | Description | Data Model |
|---|---|---|---|
| 200 | OK | Request successful | Inline |
Response Data Structure
Status Code 200
| Name | Type | Required | Constraint | Chinese Name | Description |
|---|---|---|---|---|---|
| » code | integer | false | none | Status code: 200 success, 3 invalid app_key, 156 account not verified | |
| » msg | string | false | none | Status message | |
| » data | null | false | none | none |
Delete Proxy Account
POST
/pub/whitelist-account/delete
Please note that deletion is irreversible, and used traffic records cannot be queried. Deletion has a waiting time of about 5 minutes, during which charges may still occur.
Body Request Parameters
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | No | none |
| » app_key | body | string | No | Authorization key |
| » accounts | body | string | No | Proxy accounts, only supports numbers and letters. Supports batch operations, separated by commas (,) |
Response Example
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Response Result
| Status Code | Status Code Meaning | Description | Data Model |
|---|---|---|---|
| 200 | OK | Request successful | Inline |
Response Data Structure
Status Code 200
| Name | Type | Required | Constraint | Chinese Name | Description |
|---|---|---|---|---|---|
| » code | integer | false | none | Status code: 200 success, 3 invalid app_key, 156 account not verified | |
| » msg | string | false | none | Status message | |
| » data | null | false | none | none |
Disable Proxy Account
POST
/pub/whitelist-account/disable
Disabling has a waiting time of about 5 minutes, during which charges may still occur.
Body Request Parameters
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | No | none |
| » app_key | body | string | No | Authorization key |
| » accounts | body | string | No | Proxy accounts, only supports numbers and letters. Supports batch operations, separated by commas (,) |
Response Example
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Response Result
| Status Code | Status Code Meaning | Description | Data Model |
|---|---|---|---|
| 200 | OK | Request successful | Inline |
Response Data Structure
Status Code 200
| Name | Type | Required | Constraint | Chinese Name | Description |
|---|---|---|---|---|---|
| » code | integer | false | none | Status code: 200 success, 3 invalid app_key, 156 account not verified | |
| » msg | string | false | none | Status message | |
| » data | null | false | none | none |
Enable Proxy Account
POST
/pub/whitelist-account/enable
Body Request Parameters
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | No | none |
| » app_key | body | string | No | Authorization key |
| » accounts | body | string | No | Proxy accounts, only supports numbers and letters. Supports batch operations, separated by commas (,) |
Response Example
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Response Result
| Status Code | Status Code Meaning | Description | Data Model |
|---|---|---|---|
| 200 | OK | Request successful | Inline |
Response Data Structure
Status Code 200
| Name | Type | Required | Constraint | Chinese Name | Description |
|---|---|---|---|---|---|
| » code | integer | false | none | Status code: 200 success, 3 invalid app_key, 156 account not verified | |
| » msg | string | false | none | Status message | |
| » data | null | false | none | none |
Change Proxy Account Password
POST
/pub/whitelist-account/change-password
Please note that after changing the password, there is a waiting time of 5 minutes, during which the old password may still work.
Body Request Parameters
{
"app_key": "stringstringstringstringstringst",
"account": "user",
"password": "pass"
}
Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | No | none |
| » app_key | body | string | No | Authorization key |
| » account | body | string | No | Proxy account, only supports numbers and letters. |
| » password | body | string | No | New proxy account password, only supports numbers and letters. |
Response Example
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Response Result
| Status Code | Status Code Meaning | Description | Data Model |
|---|---|---|---|
| 200 | OK | Request successful | Inline |
Response Data Structure
Status Code 200
| Name | Type | Required | Constraint | Chinese Name | Description |
|---|---|---|---|---|---|
| » code | integer | false | none | Status code: 200 success, 3 invalid app_key, 156 account not verified | |
| » msg | string | false | none | Status message | |
| » data | null | false | none | none |
Change Proxy Account Remark
POST
/pub/whitelist-account/change-remark
Body Request Parameters
{
"app_key": "stringstringstringstringstringst",
"account": "user",
"remark": ""
}
Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | No | none |
| » app_key | body | string | No | Authorization key |
| » account | body | string | No | Proxy account, only supports numbers and letters. |
| » remark | body | string | No | New proxy account remark, within 32 Chinese characters or 64 English characters. |
Response Example
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Response Result
| Status Code | Status Code Meaning | Description | Data Model |
|---|---|---|---|
| 200 | OK | Request successful | Inline |
Response Data Structure
Status Code 200
| Name | Type | Required | Constraint | Chinese Name | Description |
|---|---|---|---|---|---|
| » code | integer | false | none | Status code: 200 success, 3 invalid app_key, 156 account not verified | |
| » msg | string | false | none | Status message | |
| » data | null | false | none | none |
Change Proxy Account Traffic Limit
POST
/pub/whitelist-account/change-limit
Please note that traffic statistics may have a delay within 5 minutes, meaning actual traffic consumed may exceed this limit.
Body Request Parameters
{
"app_key": "stringstringstringstringstringst",
"account": "user",
"limit": 0
}
Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | No | none |
| » app_key | body | string | No | Authorization key |
| » account | body | string | No | Proxy account, only supports numbers and letters. |
| » limit | body | integer | No | Traffic limit, unit: GB, 0 for no limit |
Response Example
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Response Result
| Status Code | Status Code Meaning | Description | Data Model |
|---|---|---|---|
| 200 | OK | Request successful | Inline |
Response Data Structure
Status Code 200
| Name | Type | Required | Constraint | Chinese Name | Description |
|---|---|---|---|---|---|
| » code | integer | false | none | Status code: 200 success, 3 invalid app_key, 156 account not verified | |
| » msg | string | false | none | Status message | |
| » data | null | false | none | none |