ProxyLite OpenAPI

Supports management of personal accounts, agent resources, and team billing via site OpenAPI prefix.

The authentication method is subject to the security definition of each operation:

apiKeyAuth: Pass in the personal or team API Key through the query parameter app_key; the backend is also compatible with key, appkey, openid parameters and POST request body parameters.
bearerAuth: Authorization: Bearer <JWT>, used for web login tokens. Don't think of API Keys as JWTs.
Team API Key is bound to a fixed team; interfaces that support team space can omit team_id, and the explicit input must be consistent with the Key binding team.
Interfaces that only support personal space will reject the team API Key; team operations still follow the resource permissions of the holding member.

JSON response contains code, msg, data, request_id. code=200 means the business is successful; HTTP 200 may also carry a business error code. msg changes with the request language, and the client should use code to determine the result. Some export interfaces also support text, CSV or XML, see the operation definition for details. The amount, flow, date and paging fields are subject to the Schema of each interface.

Base URLs:

https://api.proxylite.com

Authentication

HTTP Authentication, scheme: bearer

API Key (apiKeyAuth)
- Parameter Name: app_key, in: query. Personal or team API Key. Recommended query parameter app_key; also compatible with key/appkey/openid and POST request body. Team Keys can only access supported interfaces of the bound team.

Agency account management

Agent account list (GET /end-point/whitelist-account/list)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/list

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	Resource space identifier; omit personal space or pass an empty string; team Key can be omitted and must be consistent with the Key when passed in

Example responses

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
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	responseCode	false	none	Status code, 200 successful, 3 app_key invalid
» msg	string	false	none	status message
» data	object	false	none	none
»» list	[object]	false	none	none
»»» id	integer	false	none	Account number
»»» username	string	false	none	Agent account name
»»» password	string	false	none	Agent account password
»»» created_at	string	false	none	Add time
»»» remark	string	false	none	Remarks
»»» product_type	productTypes	false	none	Package type, 9 dynamic residential traffic package, 11 dynamic residential IP, 14 static data center IP, 25 static residential IP
»»» usage_flow	integer	false	none	Used traffic, unit: KB
»»» limit_flow	integer	false	none	Customized traffic limit: maximum unit GB is 102400, 0 is no limit
»»» status	integer	false	none	Enabled status: 1 enabled, 0 disabled

Enumerated Values

Property	Value
product_type	9
product_type	11
product_type	14
product_type	25

Detect traffic limits that can be set on proxy accounts

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/check

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» account	body	string	false	Pass in the account name when editing an existing agent account

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "isAgent": 0,
    "trendMax": 0,
    "staticMax": 0,
    "maxLimit": 0,
    "minLimit": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Enumerated Values

Property	Value
isAgent	0
isAgent	1

Obtain dynamic agent sub-account quota and used quantity

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/child-account \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/child-account

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	Resource space identifier; personal space omit or pass empty string

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "totalChildAccount": 0,
    "usedChildAccount": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Add agent account. (POST /end-point/whitelist-account/add)

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01:pass,user02:pass,user03:pass",
  "remark": "",
  "product_type": 9
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» app_key	body	string	false	Authorization key
» accounts	body	string	true	Account password, please fill it in the format username:password. Account and password only support numbers and letters. It is prohibited to enter any special symbols or spaces. A colon separates the account and password. Batch addition is supported, and agent accounts are separated by English commas (,).
» remark	body	string	false	Agent account description
» product_type	body	productTypes	false	Package type, 9 dynamic residential traffic package, 11 dynamic residential IP, 14 static data center IP, 25 static residential IP

Enumerated Values

Parameter	Value
» product_type	9
» product_type	11
» product_type	14
» product_type	25

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	status message
» data	null	false	none	none

Delete proxy account (POST /end-point/whitelist-account/delete)

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/delete

Please note that it cannot be restored after deletion, and the used traffic cannot be queried. There will be a waiting time of approximately 5 minutes for deletion, during which charges may still be incurred.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» app_key	body	string	false	Authorization key
» accounts	body	string	true	Agent account, only numbers and letters are supported. Support batch operations, English commas (,) separate agent accounts

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	status message
» data	null	false	none	none

Disable proxy account (POST /end-point/whitelist-account/disable)

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/disable

There will be a waiting time of approximately 5 minutes for disabling, during which time charges may still be incurred.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» app_key	body	string	false	Authorization key
» accounts	body	string	true	Agent account, only numbers and letters are supported. Support batch operations, English commas (,) separate agent accounts

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	status message
» data	null	false	none	none

Enable proxy account (POST /end-point/whitelist-account/enable)

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/enable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» app_key	body	string	false	Authorization key
» accounts	body	string	true	Agent account, only numbers and letters are supported. Support batch operations, English commas (,) separate agent accounts

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	status message
» data	null	false	none	none

Change agent account password

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-password \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-password

Please note that there is a 5-minute waiting period after modification, during which the old password may still be used normally.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "account": "user",
  "password": "pass"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» app_key	body	string	false	Authorization key
» account	body	string	true	Agent account, only numbers and letters are supported.
» password	body	string	true	The new password for the agent account, only supports numbers and letters.

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	status message
» data	null	false	none	none

Modify agent account remarks

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "account": "user",
  "remark": ""
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» app_key	body	string	false	Authorization key
» account	body	string	true	Agent account, only numbers and letters are supported.
» remark	body	string	true	New remarks for agency accounts, within 32 Chinese characters or 64 English characters.

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	status message
» data	null	false	none	none

Modify the proxy account traffic limit

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-limit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-limit

Please note that traffic statistics may be delayed within 5 minutes, that is, the actual traffic consumed may exceed this limit.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "account": "user",
  "limit": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» app_key	body	string	false	Authorization key
» account	body	string	true	Agent account, only numbers and letters are supported.
» limit	body	integer	false	Traffic limit, unit: GB, 0 means no upper limit

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	status message
» data	null	false	none	none

Quickly create an agent account

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/quick-add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/quick-add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» product_type	body	integer	true	none

Example responses

200 Response

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "username": "string",
    "password": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	A new account and password will be returned when the business is successful.	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	none
» msg	string	false	none	none
» request_id	string	false	none	none
» data	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» username	string	true	none	none
»»» password	string	true	none	none

xor

Name	Type	Required	Restrictions	Description
»» anonymous	null	false	none	none

Modify the daily traffic limit of the agent account

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-daily-limit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-daily-limit

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string",
  "daily_limit": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» account	body	string	true	none
» daily_limit	body	integer	false	Unit GB

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Modify agent account information (POST /end-point/whitelist-account/change)

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string",
  "password": "string",
  "remark": "string",
  "limit": 0,
  "daily_limit": 0,
  "status": 0,
  "udp": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» account	body	string	true	none
» password	body	string	false	none
» remark	body	string	false	none
» limit	body	integer	false	Total traffic limit in GB
» daily_limit	body	integer	false	Daily traffic limit in GB
» status	body	integer	false	none
» udp	body	integer	false	none

Enumerated Values

Parameter	Value
» status	0
» status	1
» udp	0
» udp	1

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Refresh the proxy account authentication cache of the current resource space

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/refresh \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/refresh

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Agency account quota for specified product types

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/quota?product_type=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/quota

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
product_type	query	integer	true	none

Example responses

200 Response

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "usage": 0,
    "limit": 0,
    "expand": 0
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	none
» msg	string	false	none	none
» request_id	string	false	none	none
» data	object	false	none	none
»» usage	integer	true	none	none
»» limit	integer	true	none	none
»» expand	integer	true	none	none

Agency account quotas for all product types

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/quotas \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/quotas

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none

Example responses

200 Response

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "product_type": 0,
        "limit": 0,
        "usage": 0
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	none
» msg	string	false	none	none
» request_id	string	false	none	none
» data	object	false	none	none
»» list	[object]	false	none	none
»»» product_type	integer	false	none	none
»»» limit	integer	false	none	none
»»» usage	integer	false	none	none

Agent account list (GET /end-point/proxy-account/list)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/proxy-account/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/proxy-account/list

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	Resource space identifier; omit personal space or pass an empty string; team Key can be omitted and must be consistent with the Key when passed in

Example responses

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
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	responseCode	false	none	Status code, 200 successful, 3 app_key invalid
» msg	string	false	none	status message
» data	object	false	none	none
»» list	[object]	false	none	none
»»» id	integer	false	none	Account number
»»» username	string	false	none	Agent account name
»»» password	string	false	none	Agent account password
»»» created_at	string	false	none	Add time
»»» remark	string	false	none	Remarks
»»» product_type	productTypes	false	none	Package type, 9 dynamic residential traffic package, 11 dynamic residential IP, 14 static data center IP, 25 static residential IP
»»» usage_flow	integer	false	none	Used traffic, unit: KB
»»» limit_flow	integer	false	none	Customized traffic limit: maximum unit GB is 102400, 0 is no limit
»»» status	integer	false	none	Enabled status: 1 enabled, 0 disabled

Enumerated Values

Property	Value
product_type	9
product_type	11
product_type	14
product_type	25

Add agent account. (POST /end-point/proxy-account/add)

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01:pass,user02:pass,user03:pass",
  "remark": "",
  "product_type": 9
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» app_key	body	string	false	Authorization key
» accounts	body	string	true	Account password, please fill it in the format username:password. Account and password only support numbers and letters. It is prohibited to enter any special symbols or spaces. A colon separates the account and password. Batch addition is supported, and agent accounts are separated by English commas (,).
» remark	body	string	false	Agent account description
» product_type	body	productTypes	false	Package type, 9 dynamic residential traffic package, 11 dynamic residential IP, 14 static data center IP, 25 static residential IP

Enumerated Values

Parameter	Value
» product_type	9
» product_type	11
» product_type	14
» product_type	25

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	status message
» data	null	false	none	none

Delete proxy account (POST /end-point/proxy-account/delete)

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» app_key	body	string	false	Authorization key
» accounts	body	string	true	Agent account, only numbers and letters are supported. Support batch operations, English commas (,) separate agent accounts

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	status message
» data	null	false	none	none

Enable proxy account (POST /end-point/proxy-account/enable)

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/enable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» app_key	body	string	false	Authorization key
» accounts	body	string	true	Agent account, only numbers and letters are supported. Support batch operations, English commas (,) separate agent accounts

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	status message
» data	null	false	none	none

Disable proxy account (POST /end-point/proxy-account/disable)

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/disable

There will be a waiting time of approximately 5 minutes for disabling, during which time charges may still be incurred.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» app_key	body	string	false	Authorization key
» accounts	body	string	true	Agent account, only numbers and letters are supported. Support batch operations, English commas (,) separate agent accounts

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	status message
» data	null	false	none	none

Modify agent account information (POST /end-point/proxy-account/change)

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/change

Modify the proxy account password, remarks, traffic limit, daily traffic limit, enabled status, or UDP switch.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "account": "string",
  "password": "string",
  "remark": "string",
  "limit": 0,
  "daily_limit": 0,
  "status": 0,
  "udp": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» app_key	body	string	false	Authorization key
» account	body	string	true	Agent account name
» password	body	string	false	New password, 6-16 digits or letters; if not passed, it will not be modified.
» remark	body	string	false	New note
» limit	body	integer	false	Traffic limit, unit GB, 0 means no limit
» daily_limit	body	integer	false	Daily traffic limit in GB, 0 means no limit
» status	body	integer	false	Enabled status
» udp	body	integer	false	UDP support switch, only effective for package types 14, 16, 21, and 25

Enumerated Values

Parameter	Value
» status	0
» status	1
» udp	0
» udp	1

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	status message
» data	null	false	none	none

Generate proxy connection information

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/format?ac=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/format

Supports personal and team API Keys. Only the agent accounts that have access to the current resource space are returned, and package types 9, 11, and 12 are supported. JSON/XML returns a structured account list; txt/csv returns a connection string spliced in f format.

Parameters

Name	In	Type	Required	Description
ac	query	integer,string	true	Agent account ID or user name; compatible parameter account
ae	query	string	false	none
st	query	string	false	none
ct	query	string	false	none
lf	query	integer	false	none
n	query	integer	false	none
f	query	integer	false	Only affects the connection string format of txt/csv
type	query	string	false	none
lb	query	string	false	none
ep	query	string	false	none
team_id	query	ResourceSpaceId	false	none

Enumerated Values

Parameter	Value
f	1
f	2
f	3
f	4
f	5
type	json
type	xml
type	txt
type	csv

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "password": "string",
        "server": "string",
        "port": 0
      }
    ]
  },
  "request_id": "string"
}

"string"

<?xml version="1.0" encoding="UTF-8" ?>
<WebV1SuccessResponse>
  <code>200</code>
  <msg>SUCCESS</msg>
  <data/>
  <request_id>string</request_id>
</WebV1SuccessResponse>

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	WebV1SuccessResponse

Order management

Order creation, inquiry, cancellation, etc.

order list

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/order/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/order/list

Team space orders additionally return the creator, indicating the actual order member; administrators and super administrators can see the complete contact information, and other roles return desensitized contact information.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	Order resource space identifier; personal space omit or pass empty string
page_no	query	integer	false	none
page_size	query	integer	false	none
trade_no	query	string	false	order number
start_time	query	string(date-time)	false	Start time (inclusive), such as 2024-01-01 00:00:00
end_time	query	string(date-time)	false	End time (not included)
status	query	integer	false	Order status
product_type	query	integer	false	product type
invoice	query	integer	false	Invoice status: 0 no limit 1 invoiced -1 uninvoiced (can be reissued)
pay_fee_status	query	integer	false	Long and short payment screening: 1 Overpayment 2 Short payment

Detailed descriptions

status: Order status

Status	Description
0	Pending payment
1	Paid
2	Canceled due to overtime and non-payment
3	Refunded

product_type: product type

Product Type	Description
3	Balance Recharge
9	Dynamic traffic package
11	Dynamic Global Time Package V2
12	Long-term IDC traffic package
13	Residential static IP traffic package
14	Data center static IP package
15	Long-term ISP traffic package
16	Static traffic package
17	Dynamic IP quantity package
18	web-scraper
19	Static IP Renewal
20	Static IP replacement quota
21	Static traffic package v2
24	Static traffic add-on package
25	Residential Static IP Package
26	Replacement order - Some payment channels require users to manually fill in the amount, such as virtual currency. If a short payment occurs, you need to contact customer service to make a repayment through this product
27	Serp
28	Video

Enumerated Values

Parameter	Value
status	0
status	1
status	2
status	3
product_type	3
product_type	9
product_type	11
product_type	12
product_type	14
product_type	16
product_type	17
product_type	18
product_type	19
product_type	21
product_type	24
product_type	25
product_type	26
product_type	27
product_type	28
invoice	-1
invoice	0
invoice	1
pay_fee_status	1
pay_fee_status	2

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "trade_no": "string",
        "out_trade_no": "string",
        "product_id": 0,
        "product_type": 0,
        "amount": 0,
        "unit_price": 0.1,
        "total_fee": 0.1,
        "goods_fee": 0.1,
        "pay_fee": 0.1,
        "discount_fee": 0.1,
        "handling_fee": 0.1,
        "refund_fee": 0.1,
        "pm_id": 0,
        "pm_title": "string",
        "pm_logo": "string",
        "status": 0,
        "title": "string",
        "detail": "string",
        "region_desc": "string",
        "pay_at": "2019-08-24T14:15:22Z",
        "pay_timestamp": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "pay_fee_status": 0,
        "invoice": {
          "name": "string",
          "org_name": "string",
          "first_name": "string",
          "last_name": "string",
          "phone": "string",
          "email": "[email protected]",
          "role_type": 0,
          "vat_id": "string",
          "address_country": "string",
          "address_city": "string",
          "address_line1": "string",
          "address_line2": "string",
          "address_postal_code": "string"
        }
      }
    ],
    "pagination": {
      "total": 0,
      "page_no": 0,
      "page_size": 0,
      "total_pages": 0
    }
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	success	Inline

Response Schema

Create order

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/order/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/create

Since there are many types of packages and each package has different configurations, please fill in the parameters according to the actual situation. Improperly filling in parameters may result in order creation failure.

examples:

Renew static IP

{
    "pid": package ID, // obtained from /openapi/product interface
    "upids": "1,2,3,4,5,6", // Get the corresponding id field from the /openapi/ip/get-static-ip interface
    "pm_id": 1 // Obtained from /openapi/payment/list or /openapi/payment/groups interface
  }

Static Residential IP Purchase

{
  "pid": package ID, // obtained from /openapi/product interface
  "pm_id": payment method ID, // obtained from /openapi/payment/list or /openapi/payment/groups interface
  "region_list": "JP,15,333|DE,10,444|US,5,555" // Format: region, quantity, ASN|region, quantity, ASN (ASN number optional)
}

Static data center IP purchase

{
  "pid": package ID, // obtained from /openapi/product interface
  "pm_id": payment method ID, // obtained from /openapi/payment/list or /openapi/payment/groups interface
  "region_list": "JP,15,333|DE,10,444|US,5,555" // Format: region, quantity, ASN|region, quantity, ASN (ASN number optional)
}

Dynamic residential traffic purchase

{
  "pid": package ID, // obtained from /openapi/product interface
  "pm_id": Payment method ID // Obtained from /openapi/payment/list or /openapi/payment/groups interface
}

Static rotation traffic purchase

{
  "pid": package ID, // obtained from /openapi/product interface
  "pm_id": Payment method ID // Obtained from /openapi/payment/list or /openapi/payment/groups interface
}

Dynamic unlimited traffic purchase

{
  "pid": package ID, // obtained from /openapi/product interface
  "pm_id": payment method ID, // obtained from /openapi/payment/list or /openapi/payment/groups interface
  "product_sku_bandwidth_id": bandwidth specification ID,
  "product_sku_concurrency_id": concurrency specification ID
}

Balance recharge

{
  "pid": package ID, // obtained from /openapi/product interface
  "pm_id": payment method ID, // obtained from /openapi/payment/list or /openapi/payment/groups interface
  "recharge_amount": recharge amount
}

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "pid": 0,
  "upids": "string",
  "amount": 0,
  "pm_id": 0,
  "region_list": "string",
  "coupon_sn": "string",
  "use_invitation_registration_discount": true,
  "renew_duration": 0,
  "product_sku_bandwidth_id": 0,
  "product_sku_concurrency_id": 0,
  "product_sku_duration_id": 0,
  "etd": 1,
  "recharge_amount": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» pid	body	integer	true	Package ID, from the id field returned by the /openapi/product interface
» upids	body	string	false	List of renewal package IDs (comma separated), from the id field returned by the /openapi/user-product/list or /openapi/ip/get-static-ip interface
» amount	body	number	false	Number of new packages purchased
» pm_id	body	integer	true	Payment method ID, from the id field returned by the /openapi/payment/list or /openapi/payment/groups interface
» region_list	body	string	false	When purchasing a static IP, specify the region + quantity + ASN number. The format is: region, quantity, ASN
» coupon_sn	body	string	false	Coupon number
» use_invitation_registration_discount	body	boolean	false	Whether to use invitation registration discount
» renew_duration	body	integer	false	Renewal time-static IP optional
» product_sku_bandwidth_id	body	integer	false	Package 11: Bandwidth Package ID
» product_sku_concurrency_id	body	integer	false	Package 11: Concurrent Package ID
» product_sku_duration_id	body	integer	false	Package type=11Required: Duration Specification ID
» etd	body	integer	false	Duration multiple, obtained from package extension_of_time_days, 2 represents the number of days × 2, the price will increase
» recharge_amount	body	integer	false	Package 3: Recharge amount

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Created successfully	Inline

Response Schema

Cancel order

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/order/close \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/close

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» trade_no	body	string	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Order details

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/order/info?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/order/info

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
trade_no	query	string	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Order details V2

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/order/info-v2?order_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/order/info-v2

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
order_id	query	string	true	Client-side encrypted order ID

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP success; when the order has been paid or canceled, the order data may be carried with a business error code	Inline

Response Schema

Reissue invoice for historical orders

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/order/reissue-invoice \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/reissue-invoice

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no_list": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» trade_no_list	body	[string]	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Order pre-check

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/order/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/check

Called before creating an order, it is used to preview prices, discounts, IP renewal details, etc. The order will not actually be created. The parameters are exactly the same as /openapi/order/create.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "pid": 0,
  "upids": "string",
  "amount": 1,
  "pm_id": 0,
  "region_list": "string",
  "coupon_sn": "string",
  "renew_duration": "1m",
  "product_sku_bandwidth_id": 0,
  "product_sku_concurrency_id": 0,
  "product_sku_duration_id": 0,
  "etd": 1,
  "recharge_amount": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» pid	body	integer	true	Package ID
» upids	body	string	false	IP renewal: list of user package IDs, separated by commas
» amount	body	integer	false	Purchase quantity
» pm_id	body	integer	true	Payment method ID
» region_list	body	string	false	Static IP purchase region + quantity, format: region ID, quantity
» coupon_sn	body	string	false	Coupon number
» renew_duration	body	string	false	IP renewal period: 1m=1 month, 2m=2 months, em=end of next month
» product_sku_bandwidth_id	body	integer	false	Package type=11Required: Bandwidth Specification ID
» product_sku_concurrency_id	body	integer	false	Package type=11Required: Concurrency specification ID
» product_sku_duration_id	body	integer	false	Package type=11Required: Duration Specification ID
» etd	body	integer	false	Duration multiple, obtained from package extension_of_time_days
» recharge_amount	body	number	false	Package type=3Required: recharge amount

Enumerated Values

Parameter	Value
» renew_duration	1m
» renew_duration	2m
» renew_duration	em

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "product_id": 0,
    "amount": 0,
    "discount_fee": 0.1,
    "total_fee": 0.1,
    "pay_fee": 0.1,
    "product_type": 0,
    "title": "string",
    "detail": "string",
    "ip_result": [
      {
        "ip": "string",
        "price": 0.1,
        "country_code": "string",
        "current_time": "2019-08-24T14:15:22Z",
        "renewal_time": "2019-08-24T14:15:22Z",
        "country": {
          "name_zh_cn": "string",
          "flag": "string",
          "square_flag": "string"
        }
      }
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Preflight successful	Inline

Response Schema

API key management

API Key management for personal and team resource spaces

API Key List

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/api-keys \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/api-keys

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	Resource space identifier; personal space omit or pass empty string
page	query	integer	false	none
pageSize	query	integer	false	none

Example responses

200 Response

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "id": 1,
        "api_key": "string",
        "team_user_id": 0,
        "remark": "string",
        "status": 0,
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "pageSize": 1
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	true	none	none
» msg	string	true	none	none
» request_id	string	true	none	none
» data	object	true	none	none
»» list	[UserApiKeyMetadata]	true	none	none
»»» id	integer	true	none	API Key ID
»»» api_key	string	true	none	The creation response is the complete Key; the team list is the masked value
»»» team_user_id	integer	true	none	The team key actually holds the member ID, and the personal key is 0
»»» remark	string	true	none	Remarks
»»» status	integer	true	none	0=disable, 1=enable
»»» created_at	string	true	none	creation time
»»» updated_at	string,null	false	none	Update time
»» total	integer	true	none	none
»» page	integer	true	none	none
»» pageSize	integer	true	none	none

Enumerated Values

Property	Value
status	0
status	1

Create API Key

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/api-keys/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/create

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "remark": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» remark	body	string	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "api_key": "string",
    "team_user_id": 0,
    "remark": "string",
    "status": 0,
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Return the complete API Key when the business is successful, only this time	Inline

Response Schema

Enumerated Values

Property	Value
status	0
status	1

Enable API Key

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/api-keys/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/enable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» id	body	integer	true	API Key ID

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Deactivate API Key

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/api-keys/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/disable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» id	body	integer	true	API Key ID

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Delete API Key

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/api-keys/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» id	body	integer	true	API Key ID

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Modify API Key remarks

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/api-keys/update-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/update-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "remark": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» id	body	integer	true	none
» remark	body	string	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Monthly renewal bill

Real-time billing, pre-check, order placement and history of monthly aggregated renewals

Current monthly summary renewal bill

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/monthly-renewal-bill \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/monthly-renewal-bill

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "batch": {
      "type": "current",
      "start_at": "string",
      "end_at": "string",
      "target_expired_at": "string",
      "timezone": "string"
    },
    "currency": "string",
    "total_fee": 0,
    "items": [
      {
        "id": 0,
        "user_product_id": 1,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "title": "string",
        "expired_at": "string",
        "target_expired_at": "string",
        "renew_days": 1,
        "unit_month_price": 0,
        "pay_fee": 0,
        "currency": "string",
        "bandwidth": 0,
        "bandwidth_mbsp": 0,
        "concurrency": 0,
        "ip": "string",
        "country_code": "string",
        "paid_at": "string",
        "refunded_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Enumerated Values

Property	Value
type	current
type	next

Check monthly summary renewal orders

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/monthly-renewal-bill/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/monthly-renewal-bill/check

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	MonthlyRenewalRequest	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "batch": {
      "type": "current",
      "start_at": "string",
      "end_at": "string",
      "target_expired_at": "string",
      "timezone": "string"
    },
    "currency": "string",
    "total_fee": 0,
    "discount_fee": 0,
    "pay_fee": 0,
    "items": [
      {
        "id": 0,
        "user_product_id": 1,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "title": "string",
        "expired_at": "string",
        "target_expired_at": "string",
        "renew_days": 1,
        "unit_month_price": 0,
        "pay_fee": 0,
        "currency": "string",
        "bandwidth": 0,
        "bandwidth_mbsp": 0,
        "concurrency": 0,
        "ip": "string",
        "country_code": "string",
        "paid_at": "string",
        "refunded_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "user_coupon_id": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Enumerated Values

Property	Value
type	current
type	next

Create a monthly summary renewal order

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/monthly-renewal-bill/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/monthly-renewal-bill/create

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	MonthlyRenewalRequest	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "trade_no": "string",
    "total_fee": 0,
    "discount_fee": 0,
    "pay_fee": 0,
    "currency": "string",
    "user_coupon_id": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Monthly summary of renewal history bills

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/monthly-renewal-bill/history \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/monthly-renewal-bill/history

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
trade_no	query	string	false	none
start_date	query	string(date)	false	none
end_date	query	string(date)	false	none
page	query	integer	false	none
size	query	integer	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "total": 0,
    "page": 1,
    "size": 1,
    "list": [
      {
        "id": 1,
        "trade_no": "string",
        "status": 0,
        "pay_fee": 0,
        "currency": "string",
        "pay_at": "string",
        "created_at": "string",
        "pay_method": 0,
        "pm_id": 0,
        "pay_channel": 0,
        "pm_title": "string",
        "pm_logo": "string",
        "items": [
          {
            "id": 0,
            "user_product_id": 1,
            "product_id": 1,
            "product_type": 0,
            "parent_product_type": 0,
            "title": "string",
            "expired_at": "string",
            "target_expired_at": "string",
            "renew_days": 1,
            "unit_month_price": 0,
            "pay_fee": 0,
            "currency": "string",
            "bandwidth": 0,
            "bandwidth_mbsp": 0,
            "concurrency": 0,
            "ip": "string",
            "country_code": "string",
            "paid_at": "string",
            "refunded_at": "string",
            "created_at": "string",
            "updated_at": "string"
          }
        ]
      }
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Invoice management

Invoice header, invoicing application and invoiceable orders

Invoice header details

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/info

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
invoice_code	query	string	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoice_code": "string",
    "name": "string",
    "org_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "email": "[email protected]",
    "role_type": 1,
    "invoice_type": 0,
    "vat_id": "string",
    "tax_no": "string",
    "address_country": "string",
    "address_city": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string",
    "bank_name": "string",
    "bank_account": "string",
    "is_def": true
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Enumerated Values

Property	Value
role_type	1
role_type	2
invoice_type	0
invoice_type	1
invoice_type	2

Create or modify invoice header

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/create

Body parameter

{
  "invoice_code": "string",
  "name": "string",
  "org_name": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "email": "[email protected]",
  "role_type": 1,
  "invoice_type": 0,
  "vat_id": "string",
  "tax_no": "string",
  "address_country": "string",
  "address_city": "string",
  "address_line1": "string",
  "address_line2": "string",
  "address_postal_code": "string",
  "bank_name": "string",
  "bank_account": "string",
  "is_def": true,
  "team_id": "A1b2C3d4E5f6",
  "new_invoice_code": false
}

Parameters

Name	In	Type	Required	Description
body	body	any	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The request is successful, data is null	Inline

Response Schema

Invoice header list

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/list

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "invoice_code": "string",
        "name": "string",
        "org_name": "string",
        "first_name": "string",
        "last_name": "string",
        "phone": "string",
        "email": "[email protected]",
        "role_type": 1,
        "invoice_type": 0,
        "vat_id": "string",
        "tax_no": "string",
        "address_country": "string",
        "address_city": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_postal_code": "string",
        "bank_name": "string",
        "bank_account": "string",
        "is_def": true,
        "created_at": 0
      }
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Enumerated Values

Property	Value
role_type	1
role_type	2
invoice_type	0
invoice_type	1
invoice_type	2

Delete invoice header

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_code": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» invoice_code	body	string	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The request is successful, data is null	Inline

Response Schema

Invoicing record list

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/record-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/record-list

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
status	query	integer	false	none

Enumerated Values

Parameter	Value
status	0
status	1
status	2
status	3
status	4

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "invoice_no": "string",
        "invoice_amount": 0,
        "invoice_download_url": "string",
        "status": 0,
        "remark": "string",
        "order_ids": [
          0
        ],
        "created_at": 0,
        "invoice_info": {
          "invoice_code": "string",
          "name": "string",
          "org_name": "string",
          "role_type": 1,
          "invoice_type": 0
        }
      }
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Enumerated Values

Property	Value
role_type	1
role_type	2
invoice_type	0
invoice_type	1
invoice_type	2

Submit billing application

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/submit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/submit

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_code": "string",
  "order_ids": [
    0
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» invoice_code	body	string	true	none
» order_ids	body	[integer]	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoice_id": 1
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Cancel billing application

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/cancel

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_id": 1,
  "reason": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» invoice_id	body	integer	true	none
» reason	body	string	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The request is successful, data is null	Inline

Response Schema

Invoice amount statistics

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/statistics \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/statistics

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoiceable_amount": 0,
    "invoiced_amount": 0,
    "processing_amount": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

List of orders that can be invoiced

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/invoiceable-orders \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/invoiceable-orders

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "order_no": "string",
        "pay_fee": 0,
        "created_at": 0
      }
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Team management

Team creation, query, name change and disbandment

Create a team

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/team/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/create

Body parameter

{
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» name	body	string	true	Team name

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Enumerated Values

Property	Value
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

List of teams accessible to the current user

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/team/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/list

Parameters

Name	In	Type	Required	Description
page	query	integer	false	none
page_size	query	integer	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": "A1b2C3d4E5f6",
        "name": "string",
        "super_admin_user_id": 1,
        "status": 0,
        "current_role": 1,
        "dissolving_at": "string",
        "dissolved_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Enumerated Values

Property	Value
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

Team details

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/team/detail?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/detail

Parameters

Name	In	Type	Required	Description
team_id	query	TeamPublicId	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Enumerated Values

Property	Value
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

Modify team name

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/team/update-name \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/update-name

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	TeamPublicId	true	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» name	body	string	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Enumerated Values

Property	Value
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

Disband the team

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/team/dissolve \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/dissolve

Only team super administrators can call this. The name in the request must exactly match the team's current name. This interface enforces two-step verification of operations: code=348 is returned when not in the 15-minute trust state, The caller should obtain the verification code according to the available methods in the response data, and then try again with verify_type and verify_code. Can be called repeatedly to continue the unfinished dissolution process.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "name": "华东研发团队",
  "verify_type": "email",
  "verify_code": "123456"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	TeamPublicId	true	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» name	body	string	true	Team name confirmation, must be exactly the same as the current name of the team
» verify_type	body	string	false	Secondary verification method; submit together with verify_code when verification is required
» verify_code	body	string	false	Two-step verification code; not required when in 15-minute trust state

Enumerated Values

Parameter	Value
» verify_type	phone
» verify_type	email
» verify_type	wechat
» verify_type	totp

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Enumerated Values

Property	Value
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

Query team disbandment status

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/team/dissolve-status?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/dissolve-status

Parameters

Name	In	Type	Required	Description
team_id	query	TeamPublicId	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Enumerated Values

Property	Value
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

team member

Team member lists, role adjustments, removals and exits

Team member list

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/team/members?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/members

Parameters

Name	In	Type	Required	Description
team_id	query	TeamPublicId	true	none
page	query	integer	false	none
page_size	query	integer	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "team_member_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 1,
        "role": 1,
        "status": 0,
        "joined_at": "string",
        "nickname": "string",
        "username": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Enumerated Values

Property	Value
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

Unified list of team members

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/team/people?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/people

Valid members are returned; super admins and admins also see pending invitations. Other invitation statuses remain only in the invitation history list.

Parameters

Name	In	Type	Required	Description
team_id	query	TeamPublicId	true	none
page	query	integer	false	none
page_size	query	integer	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "record_type": "member",
        "record_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 0,
        "inviter_user_id": 0,
        "invite_type": 0,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 0,
        "role": 1,
        "status": 0,
        "display_name": "string",
        "nickname": "string",
        "username": "string",
        "email": "string",
        "phone": "string",
        "joined_at": "string",
        "expired_at": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Enumerated Values

Property	Value
record_type	member
record_type	invitation
invite_type	0
invite_type	1
invite_type	2
invite_type	3
delivery_type	0
delivery_type	1
delivery_type	2
delivery_type	3
role	1
role	2
role	3
role	4
status	0
status	1

Adjust member roles

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/team/members/update-role \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/members/update-role

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "team_member_id": 1,
  "role": 2
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	TeamPublicId	true	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» team_member_id	body	integer	true	none
» role	body	integer	true	none

Enumerated Values

Parameter	Value
» role	2
» role	3

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Enumerated Values

Property	Value
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

Remove team member

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/team/members/remove \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/members/remove

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "team_member_id": 1
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	TeamPublicId	true	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» team_member_id	body	integer	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful data.status=3	Inline

Response Schema

Enumerated Values

Property	Value
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

Quit the team

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/team/members/leave \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/members/leave

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	TeamPublicId	true	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data.status=2	Inline

Response Schema

Enumerated Values

Property	Value
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

Team invitation

Creation, query and processing of team member invitations

Create a team invitation

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/create

Create invitations by registered user, email or mobile phone number. When the email or mobile phone number matches a user on this site, the response will be normalized to invite_type=1. The front end can submit the relative path template of this site's invitation URL, and the server only replaces in it with a one-time invitation token. After the unregistered target registers with the invited mobile phone number or completes the verification using the invited email, the server will bind the still valid invitation to the new user, rotate the token, and only resend an unread in-site message; the old token in the original email or text message will then become invalid. If the email invitation has not been automatically bound, the current account registered with the invited email address can be accepted directly without waiting for email_verify.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invite_type": 1,
  "role": 2,
  "user_id": 1,
  "email": "[email protected]",
  "country_code": 1,
  "phone": "string",
  "invitation_url_template": "/team/invitation/{{token}}"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	TeamPublicId	true	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» invite_type	body	integer	true	1=Registered user, 2=Email, 3=Mobile phone number
» role	body	integer	true	2=administrator, 3=ordinary member
» user_id	body	integer	false	Required when invite_type=1
» email	body	string(email)	false	Required when invite_type=2
» country_code	body	integer	false	Required when invite_type=3
» phone	body	string	false	Required when invite_type=3
» invitation_url_template	body	string	false	The relative path template defined by the front end of this website; must start with a single /, must not contain domain names or newlines, and must and can only contain one placeholder
» anonymous	body	object	false	none
»» invite_type	body	any	false	none
» anonymous	body	object	false	none
»» invite_type	body	any	false	none
» anonymous	body	object	false	none
»» invite_type	body	any	false	none

Enumerated Values

Parameter	Value
» invite_type	1
» invite_type	2
» invite_type	3
» role	2
» role	3

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code, 200 means business success	Inline

Response Schema

Enumerated Values

Property	Value
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4
email	queued
email	failed
email	skipped
sms	queued
sms	failed
sms	skipped
site_inner_message	created
site_inner_message	exists
site_inner_message	failed

Team invitation list

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/team/invitations?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/invitations

Accessible only to team super admins or admins; pending invitations that have expired will be updated to expired before returning.

Parameters

Name	In	Type	Required	Description
team_id	query	TeamPublicId	true	Team public identity
page	query	integer	false	Page number, starting from 1
page_size	query	integer	false	Quantity per page

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "inviter_user_id": 1,
        "invitee_user_id": 0,
        "invite_type": 1,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 1,
        "role": 2,
        "status": 0,
        "accepted_by_user_id": 0,
        "expired_at": "2026-07-17 10:00:00",
        "accepted_at": null,
        "rejected_at": null,
        "cancelled_at": null,
        "created_at": "2026-07-10 10:00:00"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Enumerated Values

Property	Value
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4

Preview team invitation

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/team/invitations/preview?invitation_token=string \
  -H 'Accept: application/json'

GET /end-point/team/invitations/preview

Preview invitations anonymously using a one-time invitation_token; no invitation numeric ID is used in the link.

Parameters

Name	In	Type	Required	Description
invitation_token	query	string	true	The non-empty plaintext one-time token carried by the invitation link

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_name": "string",
    "role": 2,
    "status": 0,
    "expired_at": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Enumerated Values

Property	Value
role	2
role	3
status	0
status	1
status	2
status	3
status	4

Resend team invitation notification

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/resend \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/resend

Re-invest in the original sending channel; registered users also send site messages. Resending the token will rotate the token and all previous invitation links will become invalid immediately.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invitation_id": 1
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	TeamPublicId	true	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» invitation_id	body	integer	true	Invitation ID

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Enumerated Values

Property	Value
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4
email	queued
email	failed
email	skipped
sms	queued
sms	failed
sms	skipped
site_inner_message	created
site_inner_message	exists
site_inner_message	failed

Accept team invitation

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/accept \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/accept

The currently logged-in user uses a one-time invitation_token to accept the invitation, which must match the invitation target and belong to the site to which the invitation belongs; there is no need to pass team_id.

Body parameter

{
  "invitation_token": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» invitation_token	body	string	true	Clear text one-time invitation token

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data is a member object	Inline

Response Schema

Enumerated Values

Property	Value
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

Decline team invitation

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/reject \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/reject

The currently logged-in user uses a one-time invitation_token to reject invitations that match the user; there is no need to pass team_id.

Body parameter

{
  "invitation_token": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» invitation_token	body	string	true	Clear text one-time invitation token

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data.status=2	Inline

Response Schema

Enumerated Values

Property	Value
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4

Cancel team invitation

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/cancel

To cancel a pending invitation within a specified team, the operator must have the authority to invite the target character.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invitation_id": 1
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	TeamPublicId	true	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» invitation_id	body	integer	true	Invitation ID

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful data.status=3	Inline

Response Schema

Enumerated Values

Property	Value
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4

Team assets

Team asset query and personal/team space transfer

Team package information

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/team/product-info?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/product-info

Returns the package summary of the specified team resource space. The fields are consistent with the package fields of /web_v1/user/info. Does not return the team super admin's profile, balance, or internal numeric team ID. Please use /web_v1/credit/info for credit package details.

Parameters

Name	In	Type	Required	Description
team_id	query	TeamPublicId	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "product_types": [
      0
    ],
    "product_residence_remain_count": 0,
    "product_residence_total_count": 0,
    "pdrue2_timestamp": 0,
    "remain": 0,
    "total_amount": 0,
    "scraping_remain": 0,
    "scraping_total_amount": 0,
    "scraping_timestamp": "string",
    "scraping_timestamp2": 0,
    "common_scraping_remain": 0,
    "common_scraping_total_amount": 0,
    "common_scraping_timestamp": "string",
    "common_scraping_timestamp2": 0,
    "pdidcr_count": 0,
    "pdidcr_total": 0,
    "pdidcr_traffic_remain": 0,
    "pdidcr_traffic_total": 0,
    "p_sitai_ip_count": 0,
    "p_sitai_ip": 0,
    "p_sitai_ip_total": 0,
    "p_sitai_remain": 0,
    "p_sitai_total": 0,
    "pdidc_count": 0,
    "pdidc_total": 0,
    "pdidc_ip_count": 0,
    "pdidc_ip_all_count": 0,
    "pdispr_count": 0,
    "pdispr_total": 0,
    "pdispr_traffic_remain": 0,
    "pdispr_traffic_total": 0,
    "product_datacenter_isp_traffic_ip_count": 0,
    "product_datacenter_isp_traffc_ip": 0,
    "product_datacenter_isp_traffc_ip_total": 0,
    "product_datacenter_isp_traffic_ip": 0,
    "product_datacenter_isp_traffic_ip_total": 0,
    "product_datacenter_isp_traffc_remain": 0,
    "product_datacenter_isp_traffc_total": 0,
    "product_datacenter_isp_traffic_remain": 0,
    "product_datacenter_isp_traffic_total": 0,
    "product_datacenter_isp_ip": 0,
    "product_datacenter_isp_ip_total": 0,
    "product_datacenter_isp_ip_count": 0,
    "product_datacenter_isp_ip_all_count": 0,
    "product_datacenter_isp_ip_traffic_remain": 0,
    "product_datacenter_isp_ip_traffic_total": 0,
    "product_agent_residence_remain_count": 0,
    "product_agent_residence_total_count": 0,
    "product_serp_remain": 0,
    "product_serp_total": 0,
    "product_serp_timestamp": "string",
    "product_serp_timestamp2": 0,
    "product_video_remain": 0,
    "product_video_total": 0,
    "product_video_timestamp": "string",
    "product_video_timestamp2": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Team Asset List

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/team/assets?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/assets

Parameters

Name	In	Type	Required	Description
team_id	query	TeamPublicId	true	none
page	query	integer	false	none
page_size	query	integer	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Personal assets that can be assigned to the team

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/team/assets/personal-candidates?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/assets/personal-candidates

Parameters

Name	In	Type	Required	Description
team_id	query	TeamPublicId	true	none
page	query	integer	false	none
page_size	query	integer	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Transfer personal assets to the team

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/team/assets/move-in \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/assets/move-in

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	TeamPublicId	true	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» user_product_id	body	integer	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Team assets moved back to individuals

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/team/assets/move-out \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/assets/move-out

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	TeamPublicId	true	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» user_product_id	body	integer	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Points management

Points package information, automatic replenishment, consumption records and statistics

Get points package information (GET /web_v1/credit/info)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/web_v1/credit/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/info

Query the points package summary of the current resource space. Team space requires USE_ASSETS permission; this interface supports login status, personal API Key and team API Key at the same time.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	Resource space identifier; personal space is omitted or an empty string is passed; team API Key can be omitted and must be consistent with the Key when passed in

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, the data is the points level, total amount, remaining amount, reset time and automatic replenishment status.	Inline

Response Schema

Set up balance to automatically replenish points

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/web_v1/credit/update-auto-supplement \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /web_v1/credit/update-auto-supplement

Set the automatic replenishment switch of the current resource space in the login state. Team space requires USE_OWNER_PAYMENT_CAPABILITIES permission, currently only team super administrators can operate; team space is closed by default.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "status": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» status	body	integer	true	0=off, 1=on

Enumerated Values

Parameter	Value
» status	0
» status	1

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data.status is the updated switch status.	Inline

Response Schema

Get points consumption record (GET /web_v1/credit/consumption-logs)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/web_v1/credit/consumption-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/consumption-logs

Query the points consumption record of the current resource space in the login state or API Key page. Team spaces require VIEW_BILLING permission.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
page	query	integer	false	none
page_size	query	integer	false	none
start_date	query	string(date)	false	Start date, interpreted by site time zone
end_date	query	string(date)	false	End date, interpreted by site time zone
consumption_type	query	string	false	Consumption type

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data includes list, page, page_size, total_count and total_page	Inline

Response Schema

Get points reset record (GET /web_v1/credit/reset-logs)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/web_v1/credit/reset-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/reset-logs

Query the points reset record of the current resource space in the login state or API Key page. Team spaces require VIEW_BILLING permission.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
page	query	integer	false	none
page_size	query	integer	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data contains points reset records and paging information.	Inline

Response Schema

Get points statistics (GET /web_v1/credit/stats)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/web_v1/credit/stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/stats

Log in or API Key to query the points statistics aggregated by consumption type of the current resource space. Team spaces require VIEW_BILLING permission.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
start_date	query	string(date)	false	Start date, interpreted by site time zone
end_date	query	string(date)	false	End date, interpreted by site time zone

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data contains by_type and total	Inline

Response Schema

Get daily point statistics (GET /web_v1/credit/daily-stats)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/web_v1/credit/daily-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/daily-stats

Log in or API Key to query the daily point consumption of the current resource space, which defaults to the last 7 days. Ordinary members of the team only return their actual consumption; administrators, super administrators and financial members with VIEW_BILLING permissions return the full data of the team. Team logs of unrecorded consuming members are only visible in the full view. API Key query can contain up to 31 natural days (inclusive), and the start date cannot be later than the end date.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
start_date	query	string(date)	false	Start date, default 6 days ago
end_date	query	string(date)	false	End date, default is today
consumption_type	query	string	false	Optional consumption types
fill_gaps	query	integer	false	Whether to fill in missing dates

Enumerated Values

Parameter	Value
fill_gaps	0
fill_gaps	1

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data contains daily_stats and summary	Inline

Response Schema

Get hourly point statistics (GET /web_v1/credit/hourly-stats)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/web_v1/credit/hourly-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/hourly-stats

Log in or API Key to query the hourly point consumption of the current resource space, which defaults to the last 7 days. Team spaces require VIEW_BILLING permission. API Key query can contain up to 31 natural days (inclusive), and the start date cannot be later than the end date.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
start_date	query	string(date)	false	Start date, default 6 days ago
end_date	query	string(date)	false	End date, default is today
consumption_type	query	string	false	Optional consumption types
fill_gaps	query	integer	false	Whether to fill in missing hours

Enumerated Values

Parameter	Value
fill_gaps	0
fill_gaps	1

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data contains hourly_stats and summary	Inline

Response Schema

Get points package information (GET /end-point/credit/info)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/credit/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/info

Query the points package summary of the current resource space. Team space requires USE_ASSETS permission; this interface supports login status, personal API Key and team API Key at the same time.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	Resource space identifier; personal space is omitted or an empty string is passed; team API Key can be omitted and must be consistent with the Key when passed in

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, the data is the points level, total amount, remaining amount, reset time and automatic replenishment status.	Inline

Response Schema

Get points consumption record (GET /end-point/credit/consumption-logs)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/credit/consumption-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/consumption-logs

Query the points consumption record of the current resource space in the login state or API Key page. Team spaces require VIEW_BILLING permission.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
page	query	integer	false	none
page_size	query	integer	false	none
start_date	query	string(date)	false	Start date, interpreted by site time zone
end_date	query	string(date)	false	End date, interpreted by site time zone
consumption_type	query	string	false	Consumption type

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data includes list, page, page_size, total_count and total_page	Inline

Response Schema

Get points reset record (GET /end-point/credit/reset-logs)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/credit/reset-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/reset-logs

Query the points reset record of the current resource space in the login state or API Key page. Team spaces require VIEW_BILLING permission.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
page	query	integer	false	none
page_size	query	integer	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data contains points reset records and paging information.	Inline

Response Schema

Get points statistics (GET /end-point/credit/stats)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/credit/stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/stats

Log in or API Key to query the points statistics aggregated by consumption type of the current resource space. Team spaces require VIEW_BILLING permission.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
start_date	query	string(date)	false	Start date, interpreted by site time zone
end_date	query	string(date)	false	End date, interpreted by site time zone

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data contains by_type and total	Inline

Response Schema

Get daily point statistics (GET /end-point/credit/daily-stats)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/credit/daily-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/daily-stats

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
start_date	query	string(date)	false	Start date, default 6 days ago
end_date	query	string(date)	false	End date, default is today
consumption_type	query	string	false	Optional consumption types
fill_gaps	query	integer	false	Whether to fill in missing dates

Enumerated Values

Parameter	Value
fill_gaps	0
fill_gaps	1

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data contains daily_stats and summary	Inline

Response Schema

Get hourly point statistics (GET /end-point/credit/hourly-stats)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/credit/hourly-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/hourly-stats

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
start_date	query	string(date)	false	Start date, default 6 days ago
end_date	query	string(date)	false	End date, default is today
consumption_type	query	string	false	Optional consumption types
fill_gaps	query	integer	false	Whether to fill in missing hours

Enumerated Values

Parameter	Value
fill_gaps	0
fill_gaps	1

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data contains hourly_stats and summary	Inline

Response Schema

Xcrawl Activity Log

Xcrawl single task and batch task records, details and summary query

Get a list of recent Xcrawl tasks

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/recent-runs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/recent-runs

Log in to query the single task list and summary of the current resource space. The team space requires USE_ASSETS; ordinary members can only view the tasks generated by their own credentials, and administrators and super administrators can view the tasks of the entire team.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
page	query	integer	false	none
page_size	query	integer	false	none
endpoint	query	string	false	endpoint type
status	query	string	false	none
start_time	query	string	false	User time zone time, format Y-m-d H:i:s
end_time	query	string	false	User time zone, including end boundary
url	query	string	false	Target URL or Data scraper ID
job_id	query	string	false	Task ID prefix

Enumerated Values

Parameter	Value
status	pending
status	crawling
status	completed
status	failed

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data contains paging list and metadata	Inline

Response Schema

Get Xcrawl Crawl Result

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/crawl-result?job_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/crawl-result

In the login state, query the Crawl Result of the specified task in the current resource space. The team space requires USE_ASSETS and verifies task ownership based on the member's visible credential range.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
job_id	query	string	true	Task ID

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data contains job_id and crawl_result	Inline

Response Schema

Get Xcrawl mission details and logs

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/activity-logs?job_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/activity-logs

In the login state, query the current resource space to specify a single task and its result details. The team space requires USE_ASSETS and verifies task ownership based on the member's visible credential range.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
job_id	query	string	true	Task ID
page	query	integer	false	crawl/data sub-result page number
page_size	query	integer	false	crawl/data number of sub-result pages

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data contains job and details changed by endpoint.	Inline

Response Schema

Get Data URL aggregate statistics

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/data-url-summary \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/data-url-summary

Data scraper tasks that aggregate the current resource space in login state. Team spaces require USE_ASSETS, and the results follow the member's visible credential scope.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
limit	query	integer	false	Return quantity; 0 returns an empty list

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data.list is the scraper aggregation result.	Inline

Response Schema

Get a list of recent batch crawling tasks

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/batch-recent-runs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/batch-recent-runs

Log in to query the batch task list and summary of the current resource space. The team space requires USE_ASSETS; ordinary members can only view the tasks generated by their own credentials, and administrators and super administrators can view the tasks of the entire team.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
page	query	integer	false	none
page_size	query	integer	false	none
endpoint	query	string	false	Endpoint type, usually batch_scrape
status	query	string	false	none
start_time	query	string	false	User time zone time, format Y-m-d H:i:s
end_time	query	string	false	User time zone, including end boundary
batch_id	query	string	false	Batch task ID prefix

Enumerated Values

Parameter	Value
status	pending
status	crawling
status	completed
status	failed

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data contains paging list and metadata	Inline

Response Schema

Get batch crawling task details and logs

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/batch-activity-logs?batch_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/batch-activity-logs

In the login state, query the specified batch tasks and their sub-item results in the current resource space. The team space requires USE_ASSETS and verifies task ownership based on the member's visible credential range.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
batch_id	query	string	true	Batch task ID
page	query	integer	false	Subitem page number
page_size	query	integer	false	Number of sub-pages

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP is successful; when the business is successful, data contains job and batch task details	Inline

Response Schema

Account management

Get an overview of your personal account

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/account/profile \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/account/profile

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "username": "string",
    "nickname": "string",
    "email": "string",
    "balance": "string",
    "gift_balance": "string",
    "currency": "string",
    "language": "string",
    "timezone": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Check personal balance statement

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/wallet/change-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/wallet/change-list

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Parameters

Name	In	Type	Required	Description
re_type	query	integer	false	none
transaction_type	query	integer	false	none
balance_type	query	integer	false	none
page	query	integer	false	none
page_size	query	integer	false	none

Enumerated Values

Parameter	Value
re_type	0
re_type	1

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "re_type": 0,
        "transaction_type": 0,
        "balance_type": 0,
        "fee": "string"
      }
    ],
    "page": 0,
    "page_size": 0,
    "total_count": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Log export

Create an agent log export task

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow-log-export/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow-log-export/create

Only the login status of personal space or personal API Key is supported; team API Key is not supported. The start time must be earlier than the end time, and the time span does not exceed 31 days; the same user is only allowed one waiting or processing export task, and the upper limit of logs is 5 million.

Body parameter

{
  "start_time": 0,
  "end_time": 0,
  "type": "dynamic"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» start_time	body	integer	true	Starting Unix timestamp, seconds
» end_time	body	integer	true	end Unix timestamp, seconds
» type	body	string	false	none

Enumerated Values

Parameter	Value
» type	dynamic
» type	host_pool

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "task_id": 0,
    "status": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Query log export task details

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow-log-export/detail?task_id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow-log-export/detail

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Parameters

Name	In	Type	Required	Description
task_id	query	integer	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "user_id": 0,
    "start_time": "string",
    "end_time": "string",
    "status": "pending",
    "file_size": 0,
    "record_count": 0,
    "created_at": "string",
    "completed_at": "string",
    "file_url": "string",
    "download_url": "string",
    "error_message": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Enumerated Values

Property	Value
status	pending
status	processing
status	completed
status	failed
status	canceled
status	no_data

Query log export task list

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow-log-export/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow-log-export/list

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	none
size	query	integer	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "user_id": 0,
        "start_time": "string",
        "end_time": "string",
        "status": "pending",
        "file_size": 0,
        "record_count": 0,
        "created_at": "string",
        "completed_at": "string",
        "file_url": "string",
        "download_url": "string",
        "error_message": "string"
      }
    ],
    "total": 0,
    "page": 0,
    "size": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Enumerated Values

Property	Value
status	pending
status	processing
status	completed
status	failed
status	canceled
status	no_data

Cancel the log export task that has not been executed yet

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow-log-export/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow-log-export/cancel

Only the login status of personal space or personal API Key is supported; team API Key is not supported. Only tasks in the waiting state in the queue can be canceled, and tasks that have already been executed cannot be canceled.

Body parameter

{
  "task_id": 1
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» task_id	body	integer	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Coupon

Query personal coupon list

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-coupon/list \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-coupon/list

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Body parameter

{
  "status": 0,
  "page": 1,
  "size": 20
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» status	body	integer	false	none
» page	body	integer	false	none
» size	body	integer	false	none

Enumerated Values

Parameter	Value
» status	0
» status	1
» status	2

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "coupon_id": 0,
        "type": 0,
        "status": 0,
        "source": 0,
        "title": "string",
        "title_en": "string",
        "description": "string",
        "description_en": "string",
        "start_amount": "string",
        "start_amount_usd": "string",
        "start_amount_hkd": "string",
        "deduction_amount": "string",
        "deduction_amount_usd": "string",
        "deduction_amount_hkd": "string",
        "discount_rate": "string",
        "discount_ceiling_amount": "string",
        "discount_ceiling_amount_usd": "string",
        "discount_ceiling_amount_hkd": "string",
        "created_at": "string",
        "effect_at": "string",
        "expired_at": "string",
        "used_at": "string",
        "product_types": "string",
        "created_timestamp": 0,
        "effect_timestamp": 0,
        "expired_timestamp": 0,
        "used_timestamp": 0,
        "is_expired": true
      }
    ],
    "page": 0,
    "page_size": 0,
    "page_count": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Check personal coupon details

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-coupon/info \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-coupon/info

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Body parameter

{
  "id": 1
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» id	body	integer	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "coupon_id": 0,
    "type": 0,
    "status": 0,
    "source": 0,
    "title": "string",
    "title_en": "string",
    "description": "string",
    "description_en": "string",
    "start_amount": "string",
    "start_amount_usd": "string",
    "start_amount_hkd": "string",
    "deduction_amount": "string",
    "deduction_amount_usd": "string",
    "deduction_amount_hkd": "string",
    "discount_rate": "string",
    "discount_ceiling_amount": "string",
    "discount_ceiling_amount_usd": "string",
    "discount_ceiling_amount_hkd": "string",
    "created_at": "string",
    "effect_at": "string",
    "expired_at": "string",
    "used_at": "string",
    "product_types": "string",
    "created_timestamp": 0,
    "effect_timestamp": 0,
    "expired_timestamp": 0,
    "used_timestamp": 0,
    "is_expired": true
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Notification management

Check site notifications

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/notify/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/notify/list

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	none
size	query	integer	false	none
read	query	integer	false	none
type	query	integer	false	none

Enumerated Values

Parameter	Value
read	0
read	1

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "title": "string",
        "content": "string",
        "type": 0,
        "read_status": 0,
        "created_at": "string",
        "created_timestamp": 0
      }
    ],
    "page": 0,
    "size": 0,
    "total": 0,
    "total_unread_count": 0,
    "unread_count_by_type": {}
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Enumerated Values

Property	Value
read_status	0
read_status	1

Check site notification details

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/notify/detail?id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/notify/detail

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Parameters

Name	In	Type	Required	Description
id	query	integer	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "title": "string",
    "content": "string",
    "type": 0,
    "read_status": 0,
    "created_at": "string",
    "created_timestamp": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Enumerated Values

Property	Value
read_status	0
read_status	1

Mark site notifications as read

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/notify/read \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/notify/read

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Body parameter

{
  "id": 1
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» id	body	integer	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Mark site notifications as read in batches

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/notify/batch-read \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/notify/batch-read

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Body parameter

{
  "ids": [
    1
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» ids	body	[integer]	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Query notification channel configuration

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-notify \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notify

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "scene": 0,
        "email_notify": true,
        "phone_notify": true,
        "browser_notify": true,
        "site_inner_message_notify": true,
        "webhook_notify": true,
        "telegram_notify": true
      }
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Query notification email

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-notification-email/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notification-email/list

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "email": "string",
        "created_at": 0
      }
    ],
    "max_count": 0,
    "current_count": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Query notification scenario

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-notification-email/scenes \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notification-email/scenes

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "name": "string",
        "description": "string"
      }
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Query email subscription scenario

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-notification-email/email-scenes?id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notification-email/email-scenes

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Parameters

Name	In	Type	Required	Description
id	query	integer	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "scenes": [
      0
    ],
    "subscribe_all": true
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Agent configuration

Query personal agent cache switch

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/proxy-cache/status \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/proxy-cache/status

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "status": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Enumerated Values

Property	Value
status	0
status	1

Set personal proxy caching switch

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/proxy-cache/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-cache/change

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Body parameter

{
  "status": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» status	body	integer	true	none

Enumerated Values

Parameter	Value
» status	0
» status	1

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Query personal agent UDP switch

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-proxy-config/udp \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-proxy-config/udp

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "enabled": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Enumerated Values

Property	Value
enabled	0
enabled	1

Set personal agent UDP switch

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-proxy-config/udp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-proxy-config/udp

Only the login status of personal space or personal API Key is supported; team API Key is not supported.

Body parameter

{
  "udp": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» udp	body	integer	true	none

Enumerated Values

Parameter	Value
» udp	0
» udp	1

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "enabled": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please check the business code, 200 means success.	Inline

Response Schema

Enumerated Values

Property	Value
enabled	0
enabled	1

Team wallet

Query team wallet

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/team/wallet/detail?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/wallet/detail

Requires VIEW_BILLING permission. The team wallet is independent of super administrators and members’ personal balances.

Parameters

Name	In	Type	Required	Description
team_id	query	TeamPublicId	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Check team wallet flow

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/team/wallet/records?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/wallet/records

Requires VIEW_BILLING permission. The turnover amount is always a positive number, and the increase or decrease in funds is represented by the direction field.

Parameters

Name	In	Type	Required	Description
team_id	query	TeamPublicId	true	none
page	query	integer	false	none
page_size	query	integer	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "operator_user_id": 0,
        "creator": {
          "user_id": 0,
          "display_name": "string",
          "nickname": "string",
          "username": "string",
          "email": "string",
          "phone": "string"
        },
        "direction": 0,
        "transaction_type": 1,
        "amount": 0.1,
        "after_balance": 0.1,
        "link_id": 0,
        "request_id": "string",
        "remark": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Enumerated Values

Property	Value
direction	0
direction	1
transaction_type	1
transaction_type	2
transaction_type	3
transaction_type	4
transaction_type	5

Transfer personal balance to team wallet

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/team/wallet/transfer-in \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/wallet/transfer-in

Only team super admins have TRANSFER_BALANCE permissions. The team wallet is added after atomically deducting the personal recharge balance; the transferred amount is not included in total_recharge_fee, and transfer back to personal balance is not supported.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "amount": 9999999999.9999
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	TeamPublicId	true	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» amount	body	number(double)	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

Transfer team balance back to personal account

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/team/wallet/transfer-out \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/wallet/transfer-out

It can only be called when the super administrator is logged in. Atomic deductions from the team's wallet and increase their personal recharge balance; do not change the cumulative recharge amount of the team or individual. The disbanded team can be used to recover the balance, but the disbanded team cannot be called.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "amount": 9999999999.9999
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	TeamPublicId	true	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» amount	body	number(double)	true	Must not exceed the team's current available balance

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	HTTP successful; please continue to judge the response body code	Inline

Response Schema

IP extraction

Extract IP (GET /end-point/ip/get-ip)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/get-ip?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/get-ip

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	The team Key can be omitted; when passed in, it must be consistent with the team to which the Key is bound.
app_key	query	string(password)	true	access key
cc	query	string	false	Country or region
state	query	string	false	province or state
city	query	string	false	city
format	query	string	false	Get format
lb	query	string	false	Separator, only valid in text format
num	query	number	false	Extract quantity
life	query	number	false	Hold period - minutes
ep	query	string	false	proxy network

Enumerated Values

Parameter	Value
ep	us
ep	hk
ep	de

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      [
        "150.109.114.72:1140",
        "150.109.114.72:1141",
        "150.109.114.72:1142",
        "150.109.114.72:1143",
        "150.109.114.72:1144",
        "150.109.114.72:1145",
        "150.109.114.72:1146",
        "150.109.114.72:1147",
        "150.109.114.72:1148",
        "150.109.114.72:1149"
      ]
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	true	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	true	none	status message
» data	object	false	none	none
»» list	[any]	false	none	none

City list (GET /end-point/ip/dynamic-area-city-list)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-area-city-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-area-city-list

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "name_zh_cn": "美国",
        "name_en": "United States",
        "continent_code": "NA",
        "country_code": "US",
        "items": [
          {
            "city": "Arlington",
            "state": "alabama",
            "continent_code": "NA",
            "country_code": "US"
          }
        ]
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	true	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	true	none	status message
» data	object	false	none	none
»» list	[object]	false	none	list
»»» name_zh_cn	string	false	none	Country or region name
»»» name_en	string	false	none	Country or region name
»»» continent_code	string	false	none	continent code
»»» country_code	string	false	none	Country or region code
»»» items	[any]	false	none	province or state
»»»» city	string	false	none	city name
»»»» state	string	false	none	Province or state name code
»»»» continent_code	string	false	none	continent code
»»»» country_code	string	false	none	Country or region code

IP extraction quantity statistics by day

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-extract-ip/days \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-extract-ip/days

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
start_date	query	string(date)	false	Default 6 days ago
end_date	query	string(date)	false	Default today
product_type	query	integer	false	none

Enumerated Values

Parameter	Value
product_type	9
product_type	17
product_type	22

Example responses

200 Response

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "count": 0,
        "date": "2019-08-24"
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	none
» msg	string	false	none	none
» request_id	string	false	none	none
» data	object	false	none	none
»» list	[object]	false	none	none
»»» count	integer	true	none	none
»»» date	string(date)	true	none	none

Extract IP (GET /end-point/ip/v3)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/v3?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/v3

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	The team Key can be omitted; when passed in, it must be consistent with the team to which the Key is bound.
app_key	query	string(password)	true	access key
cc	query	string	false	Country or region
state	query	string	false	province or state
city	query	string	false	city
format	query	string	false	Get format
lb	query	string	false	Separator, only valid in text format
num	query	number	false	Extract quantity
life	query	number	false	Hold period - minutes
ep	query	string	false	proxy network

Enumerated Values

Parameter	Value
ep	us
ep	hk
ep	de

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      [
        "150.109.114.72:1140",
        "150.109.114.72:1141",
        "150.109.114.72:1142",
        "150.109.114.72:1143",
        "150.109.114.72:1144",
        "150.109.114.72:1145",
        "150.109.114.72:1146",
        "150.109.114.72:1147",
        "150.109.114.72:1148",
        "150.109.114.72:1149"
      ]
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	true	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	true	none	status message
» data	object	false	none	none
»» list	[any]	false	none	none

Dynamic regional city list V4

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dcl4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dcl4

Get the city list by user name, login authentication is required, and the account must belong to the current user

Parameters

Name	In	Type	Required	Description
username	query	string	true	Agent account username

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "City": "Los Angeles",
        "Area": "US",
        "State": "California"
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	status message
» data	object	false	none	none
»» cache	boolean	false	none	Whether it comes from cache
»» list	[object]	false	none	none
»»» City	string	false	none	city
»»» Area	string	false	none	area
»»» State	string	false	none	State/Province

Dynamic regional state/province list V4

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dsl4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dsl4

Get the state/province list by user name, login authentication is required, and the account must belong to the current user

Parameters

Name	In	Type	Required	Description
username	query	string	true	Agent account username

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "City": "Los Angeles",
        "Area": "US",
        "State": "California"
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	status message
» data	object	false	none	none
»» cache	boolean	false	none	Whether it comes from cache
»» list	[object]	false	none	none
»»» City	string	false	none	city
»»» Area	string	false	none	area
»»» State	string	false	none	State/Province

Dynamic regional state/province city fusion list V4

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dal4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dal4

Get a merged list of states/provinces and cities by username, grouped by region. Login authentication is required, and the account must belong to the current user

Parameters

Name	In	Type	Required	Description
username	query	string	true	Agent account username

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "Area": "US",
        "states": [
          {
            "State": "California",
            "cities": [
              "Los Angeles"
            ]
          }
        ]
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	status message
» data	object	false	none	none
»» cache	boolean	false	none	Whether it comes from cache
»» list	[object]	false	none	Area list
»»» Area	string	false	none	area code
»»» states	[object]	false	none	State/Province List
»»»» State	string	false	none	State/province name
»»»» cities	[string]	false	none	City list

City list (GET /end-point/ip/dynamic-citys)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-citys \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-citys

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "name_zh_cn": "美国",
        "name_en": "United States",
        "continent_code": "NA",
        "country_code": "US",
        "items": [
          {
            "city": "Arlington",
            "state": "alabama",
            "continent_code": "NA",
            "country_code": "US"
          }
        ]
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	true	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	true	none	status message
» data	object	false	none	none
»» list	[object]	false	none	list
»»» name_zh_cn	string	false	none	Country or region name
»»» name_en	string	false	none	Country or region name
»»» continent_code	string	false	none	continent code
»»» country_code	string	false	none	Country or region code
»»» items	[any]	false	none	province or state
»»»» city	string	false	none	city name
»»»» state	string	false	none	Province or state name code
»»»» continent_code	string	false	none	continent code
»»»» country_code	string	false	none	Country or region code

City search

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-citys/search?country_code=string&state=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-citys/search

Parameters

Name	In	Type	Required	Description
country_code	query	string	true	Country or region code
state	query	string	true	State or province code

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	true	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	true	none	status message
» data	object	false	none	none
»» list	[string]	false	none	list

State List

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-states \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-states

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "name_zh_cn": "美国",
        "name_en": "United States",
        "continent_code": "NA",
        "country_code": "US",
        "items": [
          {
            "state": "alabama",
            "continent_code": "NA",
            "country_code": "US"
          }
        ]
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	true	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	true	none	status message
» data	object	false	none	none
»» list	[object]	false	none	list
»»» name_zh_cn	string	false	none	Country or region name
»»» name_en	string	false	none	Country or region name
»»» continent_code	string	false	none	continent code
»»» country_code	string	false	none	Country or region code
»»» items	[any]	false	none	province or state
»»»» state	string	false	none	Province or state name code
»»»» continent_code	string	false	none	continent code
»»»» country_code	string	false	none	Country or region code

State/Province Search

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-states/search?country_code=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-states/search

Parameters

Name	In	Type	Required	Description
country_code	query	string	true	Country or region code

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	true	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	true	none	status message
» data	object	false	none	none
»» list	[string]	false	none	list

Get a list of assigned datacenter static IPs

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/ip/get-datacenter-assign-ip-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/ip/get-datacenter-assign-ip-list

Deprecated, it is recommended to use /openapi/user-product/datacenter-isp-ip-list. To be compatible with old clients, this interface uses the POST method, but the filtering parameters are all read from query.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	Resource space identifier; omit personal space or pass an empty string; team Key can be omitted and must be consistent with the Key when passed in
area	query	string	false	Country code
status	query	integer	false	0=all, 1=valid, 2=expired
trade_no	query	string	false	Order number
created_at	query	array[string]	false	To create a time range, the start and end time must be passed at the same time.

Enumerated Values

Parameter	Value
status	0
status	1
status	2

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "total": 0,
    "list": [
      {
        "id": 1,
        "ip": "string",
        "country_code": "string",
        "up_id": 1,
        "expired_at": "string",
        "created_at": "string",
        "country_name_zh_cn": "string",
        "country_name_en": "string",
        "country_continent_code": "string",
        "port": 1
      }
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Extract purchased static IP list

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/get-static-ip \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/get-static-ip

Parameters

Name	In	Type	Required	Description
country_code	query	string	false	Country or region code
product_type	query	number	false	Product Type, 25: Static Residential IP, 14: Data Center IP
trade_no	query	string	false	Filter IP by order number
page	query	number	false	Page number
size	query	number	false	Quantity per page
status	query	number	false	Status, 1: valid, 2: invalid, 3: about to expire, 4: under maintenance

Enumerated Values

Parameter	Value
product_type	14
product_type	25
status	1 - 2 - 3 - 4

Responses

Status	Meaning	Description	Schema

Get the number of static IPs for sale in the region

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/static-ip-region \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/static-ip-region

Parameters

Name	In	Type	Required	Description
isp	query	integer	false	ISP filtering, no filtering if not transmitted (default is 1 except site 1/4/5)
asn	query	integer	false	Whether to return ASN packet data
exclusive	query	integer	false	Whether to count according to exclusive inventory

Detailed descriptions

isp: ISP filtering, no filtering if not transmitted (default is 1 except site 1/4/5)

value	description
0	Data Center Static IP (IDC)
1	Home Static IP (ISP)

asn: Whether to return ASN packet data

value	description
0	Do not return ASN packet data (default)
1	Return ASN packet data

exclusive: Whether to count according to exclusive inventory

value	description
0	Statistics based on current user/sharing group caliber (default)
1	Exclude all assigned IPs and only count available inventory

Enumerated Values

Parameter	Value
isp	0
isp	1
asn	0
asn	1
exclusive	0
exclusive	1

Example responses

200 Response

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "list": [
      {
        "code": "US",
        "number": 55
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	true	none	Status code, 200 success
» msg	string	true	none	status message
» data	object	false	none	none
»» list	[any]	false	none	none
»»» code	string	true	none	Country or region code
»»» number	integer	true	none	Quantity

Get host_pool supported countries/regions

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/host-pool/regions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/host-pool/regions

Query the list of countries/regions supported by the current site of the host_pool service.

This interface is oriented to the random extraction scenario of data center IP based on traffic points, and only counts countries/regions based on the data center IP inventory available at the current site.

Example responses

200 Response

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "list": [
      {
        "code": "US",
        "number": 55,
        "name_zh_cn": "美国",
        "name_en": "United States",
        "square_flag": "https://example.com/static/flags/us.png"
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	true	none	Status code, 200 success
» msg	string	true	none	status message
» data	object	false	none	none
»» list	[object]	false	none	none
»»» code	string	true	none	Country or region code, ISO 3166-1 alpha-2
»»» number	integer	true	none	Number of data center IPs available at the current site
»»» name_zh_cn	string	false	none	Country or region Chinese name
»»» name_en	string	false	none	English name of country or region
»»» square_flag	string	false	none	Square Flag Image URL

IP whitelist

IP whitelist list (GET /end-point/proxy-ip/list)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/proxy-ip/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/proxy-ip/list

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	Resource space identifier; personal space omit or pass empty string
product_type	query	integer	false	Package type number

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "ip": "1.1.1.1",
        "remark": "string",
        "product_type": 0,
        "created_at": "string"
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	status message
» data	object	false	none	none
»» list	[object]	false	none	none
»»» ip	string	false	none	Whitelist IP
»»» remark	string	false	none	Remarks
»»» product_type	integer	false	none	Package type
»»» created_at	string	false	none	creation time

Add IP whitelist (POST /end-point/proxy-ip/add)

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/proxy-ip/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-ip/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "remark": "string",
  "product_type": 0,
  "user_product_id": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» app_key	body	string	false	Authorization key
» ips	body	string	true	Whitelist IPs that need to be added, separate multiple ones with commas or newlines.
» remark	body	string	false	Remarks
» product_type	body	integer	false	Package type number
» user_product_id	body	integer	false	User package ID, required when package type is 11

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	status message
» data	null	false	none	none

Delete IP whitelist (POST /end-point/proxy-ip/delete)

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/proxy-ip/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-ip/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "verify_type": "string",
  "verify_code": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» app_key	body	string	false	Authorization key
» ips	body	string	true	Whitelist IPs that need to be deleted, multiple ones separated by commas
» verify_type	body	string	false	Verification type: phone, email, wechat, totp
» verify_code	body	string	false	Verification code

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	status message
» data	null	false	none	none

IP whitelist list (GET /end-point/white-ip/list)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/white-ip/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/white-ip/list

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	Resource space identifier; personal space omit or pass empty string
product_type	query	integer	false	Package type number

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "ip": "1.1.1.1",
        "remark": "string",
        "product_type": 0,
        "created_at": "string"
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	status message
» data	object	false	none	none
»» list	[object]	false	none	none
»»» ip	string	false	none	Whitelist IP
»»» remark	string	false	none	Remarks
»»» product_type	integer	false	none	Package type
»»» created_at	string	false	none	creation time

Add IP whitelist (POST /end-point/white-ip/add)

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/white-ip/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "remark": "string",
  "product_type": 0,
  "user_product_id": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» app_key	body	string	false	Authorization key
» ips	body	string	true	Whitelist IPs that need to be added, separate multiple ones with commas or newlines.
» remark	body	string	false	Remarks
» product_type	body	integer	false	Package type number
» user_product_id	body	integer	false	User package ID, required when package type is 11

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	status message
» data	null	false	none	none

Delete IP whitelist (POST /end-point/white-ip/delete)

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/white-ip/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "verify_type": "string",
  "verify_code": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» app_key	body	string	false	Authorization key
» ips	body	string	true	Whitelist IPs that need to be deleted, multiple ones separated by commas
» verify_type	body	string	false	Verification type: phone, email, wechat, totp
» verify_code	body	string	false	Verification code

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	status message
» data	null	false	none	none

Modify IP whitelist remarks

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/white-ip/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/change-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ip": "192.168.0.1",
  "remark": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» ip	body	string(ipv4)	true	none
» remark	body	string	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Refresh the current resource space IP whitelist authentication cache

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/white-ip/refresh \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/refresh

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

IP whitelist quota for specified product types

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/white-ip/quota?product_type=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/white-ip/quota

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
product_type	query	integer	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

IP whitelist quotas for all product types

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/white-ip/quotas \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/white-ip/quotas

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Traffic log query

Recently used traffic is summarized by day

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow/days \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow/days

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "days": 7,
  "product_type": 0,
  "username": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» days	body	integer	false	none
» product_type	body	integer	false	none
» username	body	string	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "days": "2019-08-24",
        "flow": 0
      }
    ],
    "days": 1
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Agent account historical traffic usage

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow/username-total \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow/username-total

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "flow": 0
      }
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Export the monthly traffic usage of the agency account

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow/export-csv \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/csv' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow/export-csv

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	GBK encoded CSV file	string

Total amount and remaining amount of package traffic

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/flow-total \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/flow-total

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
unit	query	string	false	none

Enumerated Values

Parameter	Value
unit	KB
unit	MB
unit	GB
unit	TB
unit	PB

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "limit": 0,
    "total": 0,
    "remain": 0,
    "unit": "KB",
    "timestamp": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Enumerated Values

Property	Value
unit	KB
unit	MB
unit	GB
unit	TB
unit	PB

daily rate graph

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/rate-graph \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/rate-graph

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
start	query	string(date)	false	none
end	query	string(date)	false	none
username	query	string	false	none
user_product_id	query	integer	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "date": "2019-08-24",
        "rate": 0,
        "corrent": 0
      }
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Daily cache traffic statistics

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/cache-total \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/cache-total

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
start_time	query	string	false	none
end_time	query	string	false	none
product_type	query	integer	false	none
username	query	string	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "day": "2019-08-24",
        "cache_flow": 0,
        "cache_reduce_flow": 0
      }
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Traffic usage is summarized by day

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/total?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/total

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	Resource space identifier; personal space omit or pass empty string
app_key	query	string(password)	true	Authentication key
start_time	query	string(Y-m-d H:i:s)	false	Starting time, accurate to seconds. Please note that logging is delayed within 5 minutes. Default is within 7 days.
end_time	query	string(Y-m-d H:i:s)	false	Deadline, accurate to seconds. Please note that logging is delayed within 5 minutes. Default current time.
username	query	string	false	Sub-account name, query all accounts by default, sub-account can be specified. Please note that if you add a sub-account with the same name, this query will return all usage records for the agent account with the same name.
product_type	query	number	false	Package type

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "day": "2022-08-01",
        "flow": 0
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	true	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	true	none	status message
» data	object	false	none	none
»» list	[object]	false	none	none
»»» day	string	false	none	Date
»»» flow	integer	false	none	Consumption traffic, unit KB

Agent log

Client IP proxy access statistics

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/http-t-dom/list-v2 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/http-t-dom/list-v2

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
start_time	query	string(date)	false	none
end_time	query	string(date)	false	none
export	query	string	false	none

Enumerated Values

Parameter	Value
export	csv

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "visit_count": 0,
        "client_ip": "string",
        "time": "2019-08-24",
        "country_code": "string",
        "country": "string"
      }
    ],
    "cache": true,
    "ttl": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	JSON statistical results; CSV file is returned when `export=csv`	string

Proportion of client IP visits

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/http-t-dom/client-ip-proportion \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/http-t-dom/client-ip-proportion

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
start_time	query	string(date)	false	none
end_time	query	string(date)	false	none
export	query	string	false	none

Enumerated Values

Parameter	Value
export	csv

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "client_ip": "string",
        "visit_count": 0,
        "visit_percentage": "string",
        "country": "string",
        "country_code": "string"
      }
    ],
    "cache": true,
    "ttl": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	JSON proportion result; CSV file is returned when `export=csv`	string

Package inquiry

List of purchased packages

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-product/list?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/list

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	Resource space identifier; personal space omit or pass empty string
app_key	query	string(password)	true	Authentication key
trade_no	query	string	false	Order number, please enter the complete order number. Fuzzy search is not supported.
page	query	number	false	Pagination, default: 1
size	query	number	false	Number of pages displayed, default: 20
product_type	query	number	false	Package type

Example responses

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "created_at": "2022-05-13 12:14:15",
        "expired_at": "2022-05-13 12:14:15",
        "product_type": 9,
        "trade_no": "2022051312134339861461465434",
        "order": {
          "created_at": "2022-05-13 12:13:43",
          "pay_at": "2022-05-13 12:13:43",
          "title": "入门级"
        }
      }
    ],
    "page": 1,
    "page_size": 20,
    "total_count": 0,
    "total_page": 0
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	true	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	true	none	status message
» data	object	false	none	none
»» list	[object]	false	none	none
»»» id	integer	false	none	Package number
»»» created_at	string	false	none	Package effective time
»»» expired_at	string	false	none	The expiration time of the package. After expiration, the traffic cannot be used.
»»» product_type	productTypes	false	none	Package type, 9 dynamic residential traffic package, 11 dynamic residential IP, 14 static data center IP, 25 static residential IP
»»» trade_no	string	false	none	Order transaction number
»»» order	object	false	none	none
»»»» created_at	string	false	none	Order creation time
»»»» pay_at	string	false	none	Order payment time
»»»» title	string	false	none	Order description
»» page	integer	true	none	Current page
»» page_size	integer	false	none	paging size
»» total_count	integer	false	none	Total number of records
»» total_page	integer	false	none	Total number of pages

Enumerated Values

Property	Value
product_type	9
product_type	11
product_type	14
product_type	25

Summary of user package data

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-product/summary?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/summary

Obtain statistical summary information of user packages, including total amount, effective amount, upcoming amount, expired amount, etc.

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	Resource space identifier; personal space omit or pass empty string
app_key	query	string(password)	true	Authentication key
product_type	query	integer	false	Product type, only supports 9 (dynamic traffic package), 12 (long-term IDC traffic package)

Enumerated Values

Parameter	Value
product_type	9
product_type	12

Example responses

200 Response

{
  "code": 200,
  "msg": "成功",
  "data": {
    "total": 1048576,
    "total_count": 5,
    "effective": 524288,
    "effective_count": 3,
    "effective_total": 786432,
    "effective_used": 262144,
    "temporary": 102400,
    "temporary_count": 1,
    "expired": 51200,
    "expired_count": 1,
    "used": 473088
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	status message
» data	object	false	none	none
»» total	integer	false	none	Traffic/Total IP volume (unit: KB)
»» total_count	integer	false	none	Total number of packages
»» effective	integer	false	none	Effective remaining amount (unit: KB)
»» effective_count	integer	false	none	Number of valid packages
»» effective_total	integer	false	none	Effective total amount (unit: KB)
»» effective_used	integer	false	none	Effective amount used (unit: KB)
»» temporary	integer	false	none	Total amount due (due within 7 days, unit: KB)
»» temporary_count	integer	false	none	Number of expiring packages (expiry within 7 days)
»» expired	integer	false	none	Expired remaining amount (unit: KB)
»» expired_count	integer	false	none	Number of expired packages
»» used	integer	false	none	Total amount used (unit: KB)

Static IP list

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-product/datacenter-isp-ip-list \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/datacenter-isp-ip-list

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "status": 0,
  "page": 1,
  "size": 20,
  "user_product_id": 1,
  "country_code": "string",
  "product_type": 0,
  "ip": "192.168.0.1",
  "auto_renewal": 0,
  "support_renewal": 0,
  "remaining_days": 0,
  "limit_days": 0,
  "sort": "exp_asc",
  "remark": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» status	body	integer	false	none
» page	body	integer	false	none
» size	body	integer	false	none
» user_product_id	body	integer	false	none
» country_code	body	string	false	none
» product_type	body	integer	false	none
» ip	body	string(ipv4)	false	none
» auto_renewal	body	integer	false	none
» support_renewal	body	integer	false	none
» remaining_days	body	integer	false	none
» limit_days	body	integer	false	none
» sort	body	string	false	none
» remark	body	string	false	none

Enumerated Values

Parameter	Value
» auto_renewal	0
» auto_renewal	1
» support_renewal	0
» support_renewal	1
» sort	exp_asc
» sort	exp_desc

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Delete expired packages

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-product/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» id	body	integer	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Delete expired packages in batches

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-product/batch-delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/batch-delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ids": [
    1
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» ids	body	[integer]	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Modify package remarks

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-product/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/change-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "remark": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» id	body	integer	true	none
» remark	body	string	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Set static IP UDP switches in batches

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-product/set-ip-udp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/set-ip-udp

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ids": [
    1
  ],
  "udp": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» ids	body	[integer]	true	none
» udp	body	integer	true	none

Enumerated Values

Parameter	Value
» udp	0
» udp	1

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Package management

Change data center ISP static IP

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-product/change-datacenter-isp-ip \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/change-datacenter-isp-ip

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "country_code": "string",
  "ip": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» id	body	integer	true	User plan ID
» country_code	body	string	false	Target country/region code; if not passed, the current IP country/region will be used first.
» ip	body	string	false	Destination IP prefix filtering

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "ip_id": 1,
    "ip": "string",
    "country_code": "string"
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Get static IP replacement records

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-product/ip-change-log \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/ip-change-log

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	Resource space identifier; personal space omit or pass empty string
page	query	integer	false	none
page_size	query	integer	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "old": "string",
        "new": "string",
        "created_at": "string",
        "created_timestamp": 0
      }
    ],
    "page": 1,
    "page_size": 1,
    "total_count": 0,
    "page_count": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Set the automatic renewal switch for a single package

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-product/set-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/set-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1,
  "status": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» user_product_id	body	integer	true	none
» status	body	integer	false	0=disable, 1=enable

Enumerated Values

Parameter	Value
» status	0
» status	1

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Set automatic renewal switch for packages in batches

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-product/batch-set-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/batch-set-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "status": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» user_product_ids	body	[integer]	true	none
» status	body	integer	false	0=disable, 1=enable

Enumerated Values

Parameter	Value
» status	0
» status	1

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "results": [
      {
        "user_product_id": 1,
        "success": true,
        "id": 1
      }
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The request is successful; each package returns the processing results independently.	Inline

Response Schema

Set default auto-renewal parameters for product types

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-product/set-auto-renewal-default-config \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/set-auto-renewal-default-config

Pass at least one of days_before_expire, traffic_threshold, renewal_cycle_days; a value of 0 means resetting the corresponding configuration.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 9,
  "days_before_expire": 30,
  "traffic_threshold": 100,
  "renewal_cycle_days": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» product_type	body	integer	true	none
» days_before_expire	body	integer	false	none
» traffic_threshold	body	integer	false	Units GB, only supported on 9/12/24
» renewal_cycle_days	body	integer	false	Only supported on 11/14/16/25, and must be the current product cycle on sale
» anonymous	body	object	false	none
» anonymous	body	object	false	none
» anonymous	body	object	false	none

Enumerated Values

Parameter	Value
» product_type	9
» product_type	11
» product_type	12
» product_type	14
» product_type	16
» product_type	24
» product_type	25

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The request is successful, data is null	Inline

Response Schema

Get the default automatic renewal parameters of the product type

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-product/get-auto-renewal-default-config \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/get-auto-renewal-default-config

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 9
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» product_type	body	integer	false	If not passed, all supported types will be returned.

Enumerated Values

Parameter	Value
» product_type	9
» product_type	11
» product_type	12
» product_type	14
» product_type	16
» product_type	24
» product_type	25

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "configs": [
      {
        "product_type": 9,
        "days_before_expire": 0,
        "source": "user",
        "renewal_cycle": {
          "days": 1,
          "unit": "day",
          "source": "user"
        },
        "traffic_threshold": 0,
        "traffic_source": "user"
      }
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Enumerated Values

Property	Value
product_type	9
product_type	11
product_type	12
product_type	14
product_type	16
product_type	24
product_type	25
source	user
source	system
source	user
source	system
traffic_source	user
traffic_source	system

Get the automatic renewal configuration and renewal preview of a single package

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-product/get-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/get-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» user_product_id	body	integer	true	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "expired_at": "string",
    "time_days": 0,
    "time_unit": "day",
    "next_expired_at": "string",
    "agreed_price": 0,
    "currency": "string",
    "config": {
      "id": 1,
      "user_id": 1,
      "team_id": "A1b2C3d4E5f6",
      "team_user_id": 0,
      "product_type": 0,
      "left_traffic": 0,
      "left_days": 0,
      "user_product_id": 1,
      "product_id": 0,
      "status": 0,
      "currency": "string",
      "agreed_price": 0,
      "agreed_bandwidth_price": 0,
      "agreed_concurrency_price": 0,
      "bandwidth_id": 0,
      "concurrency_id": 0,
      "duration": 0,
      "renew_product_id": 0,
      "days_before_expire": 0,
      "traffic_threshold": 0,
      "parent_product_type": 0,
      "created_at": "string",
      "updated_at": "string"
    },
    "traffic_threshold": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Enumerated Values

Property	Value
time_unit	day
time_unit	hour
status	0
status	1

Get automatic renewal execution records

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/user-product/auto-renewal-logs \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/auto-renewal-logs

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1,
  "page": 1,
  "size": 20
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» user_product_id	body	integer	false	If not passed, all records in the current space will be queried.
» page	body	integer	false	none
» size	body	integer	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "config_id": 0,
        "user_product_id": 1,
        "product_type": 0,
        "renew_product_id": 0,
        "order_id": 0,
        "fee": 0,
        "currency": "string",
        "before_expired_at": "string",
        "after_expired_at": "string",
        "before_remain": 0,
        "after_remain": 0,
        "trigger_type": 0,
        "status": 1,
        "revoke_at": "string",
        "revoke_remark": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "page": 1,
    "page_size": 1,
    "total_page": 0,
    "total_count": 0
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Enumerated Values

Property	Value
trigger_type	0
trigger_type	1
status	1
status	2
status	3

Payment management

Pull up order payment

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/pay?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/pay

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
trade_no	query	string	true	none
pm_id	query	integer	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Initiate payment for unpaid orders issued in the background

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/pay/index-choose \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/pay/index-choose

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no": "string",
  "pay_method": 0,
  "pm_id": 0,
  "trade_type": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» team_id	body	any	false	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
»» anonymous	body	string	false	none
»» anonymous	body	TeamPublicId	false	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
» trade_no	body	string	true	none
» pay_method	body	integer	false	none
» pm_id	body	integer	false	none
» trade_type	body	string	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	WebV1SuccessResponse

Pay checksum fee preview

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/pay/pay-check?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/pay/pay-check

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
trade_no	query	string	true	none
pm_id	query	integer	false	none

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "trade_no": "string",
    "pm_id": 0,
    "pay_method": 0,
    "trade_type": "string",
    "country_code": "string",
    "currency": "string",
    "goods_fee": 0,
    "discount_fee": 0,
    "handling_fee": 0,
    "pay_fee": 0,
    "total_fee": 0,
    "pay_method_info": {
      "id": 0,
      "type": 0,
      "title": "string",
      "group": "string",
      "handling_rate": 0,
      "handling_fee": 0,
      "handling_fee_currency": "usd",
      "handling_fee_converted": 0
    },
    "origin": {
      "pm_id": 0,
      "pay_method": 0,
      "goods_fee": 0,
      "discount_fee": 0,
      "handling_fee": 0,
      "pay_fee": 0,
      "total_fee": 0
    }
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Directly render the web payment page

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/pay/web-direct-pay?trade_no=string \
  -H 'Accept: text/html' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/pay/web-direct-pay

Parameters

Name	In	Type	Required	Description
team_id	query	ResourceSpaceId	false	none
trade_no	query	string	true	none
pm_id	query	integer	false	none

Example responses

200 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	HTML payment page	string

Get a list of payment methods (GET /end-point/payment/list)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/payment/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/payment/list

Parameters

Name	In	Type	Required	Description
trade_no	query	string	false	Order number - can be passed in when some orders require a specific payment method
currency	query	string	false	currency unit

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "title": "string",
        "logo": "string",
        "group": "string",
        "handling_rate": 0,
        "handling_fee": 0,
        "disabled": false,
        "min": 0,
        "max": 0
      }
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	get success	Inline

Response Schema

Get a list of payment methods (GET /end-point/payment/groups)

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/payment/groups \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/payment/groups

Parameters

Name	In	Type	Required	Description
trade_no	query	string	false	Order number - can be passed in when some orders require a specific payment method

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "name": "string",
        "logos": [
          "string"
        ],
        "items": [
          {
            "id": 0,
            "title": "string",
            "logo": "string",
            "group": "string",
            "disabled": false,
            "min": 0,
            "max": 0
          }
        ]
      }
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	get success	Inline

Response Schema

Marketing

Recharge bonus ratio

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/activity/balance-recharge-gift-ratio \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/activity/balance-recharge-gift-ratio

Recharge bonus ratio

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      null
    ]
  },
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Products

Product list

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/product \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/product

Get the list of packages available for purchase on the current site, and support filtering by type, validity period, and other conditions.

Parameters

Name	In	Type	Required	Description
type	query	integer	false	Package type, see Product.type enumeration description. If not passed, all types will be returned.
parent_product_type	query	integer	false	Parent package type, only valid when type=19 (IP renewal), used to filter product lines: 14=data center 25=residential
time_days	query	any	false	Validity period filtering, supports single value or array, such as 30 / [30,90,365]
show_type	query	any	false	Display type filtering, supports single value or array

Enumerated Values

Parameter	Value
parent_product_type	14
parent_product_type	25

Example responses

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": [
    {
      "id": 0,
      "title": "string",
      "type": 0,
      "show_type": 0,
      "status": 0,
      "price": 0.1,
      "usd_price": 0.1,
      "price_hkd": 0.1,
      "original_price": 0.1,
      "original_usd_price": 0.1,
      "original_price_hkd": 0.1,
      "local_price": 0.1,
      "local_original_price": 0.1,
      "preferred_currency": "string",
      "support_currencies": "string",
      "flow_value": 0.1,
      "flow_give": 0.1,
      "balance_give": 0.1,
      "balance_value": 0.1,
      "time_validity": 0.1,
      "time_price": 0.1,
      "time_days": 0,
      "tip1": "string",
      "tip2": "string",
      "introduce": [
        "string"
      ],
      "region_list_id": 0,
      "renew_product_list": "string",
      "parent_product_type": 0,
      "total_count": 0,
      "remain_count": 0,
      "extension_of_time_days": [
        0
      ],
      "time_days_price_rate": 0.1,
      "desc": {
        "subtitle": "string",
        "flow_value": 0.1,
        "flow_give": 0.1,
        "balance_give": 0.1,
        "time_validity": 0.1,
        "time_price": 0.1,
        "tip1": "string",
        "tip2": "string",
        "introduce": [
          "string"
        ]
      },
      "sku": {
        "bandwidth_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ],
        "duration_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ],
        "concurrency_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ]
      }
    }
  ],
  "request_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Schemas

OpenApiAccountProfile

{
  "id": 0,
  "username": "string",
  "nickname": "string",
  "email": "string",
  "balance": "string",
  "gift_balance": "string",
  "currency": "string",
  "language": "string",
  "timezone": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	true	none	User ID
username	string	true	none	Username
nickname	string	true	none	Nickname
email	string	true	none	Bind email
balance	string	true	none	Recharge balance, decimal string
gift_balance	string	true	none	Current bonus balance, decimal string
currency	string	true	none	Site currency
language	string	true	none	User language, site language is used if not configured
timezone	string	true	none	User time zone, use site time zone if not configured

OpenApiBalanceRecord

{
  "id": 0,
  "re_type": 0,
  "transaction_type": 0,
  "balance_type": 0,
  "fee": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer,string	false	none	Database values may be serialized as strings
re_type	integer,string	false	none	0 expenses, 1 income
transaction_type	integer,string	false	none	transaction type
balance_type	integer,string	false	none	Balance type
fee	string,number	false	none	Change amount, site currency

OpenApiLogExportTask

{
  "id": 0,
  "user_id": 0,
  "start_time": "string",
  "end_time": "string",
  "status": "pending",
  "file_size": 0,
  "record_count": 0,
  "created_at": "string",
  "completed_at": "string",
  "file_url": "string",
  "download_url": "string",
  "error_message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer,string	false	none	Database values may be serialized as strings
user_id	integer,string	false	none	Details interface returns
start_time	string	false	none	Y-m-d H:i:s; non-RFC 3339 date
end_time	string	false	none	Y-m-d H:i:s; non-RFC 3339 date
status	string	false	none	none
file_size	integer,string,null	false	none	none
record_count	integer,string,null	false	none	none
created_at	string	false	none	Y-m-d H:i:s; non-RFC 3339 date
completed_at	string	false	none	Y-m-d H:i:s; non-RFC 3339 date
file_url	string	false	none	After completion, the details interface returns
download_url	string	false	none	Return after completion, signature download address valid for 24 hours
error_message	string	false	none	On failure, the details interface may return

Enumerated Values

Property	Value
status	pending
status	processing
status	completed
status	failed
status	canceled
status	no_data

OpenApiCoupon

{
  "id": 0,
  "coupon_id": 0,
  "type": 0,
  "status": 0,
  "source": 0,
  "title": "string",
  "title_en": "string",
  "description": "string",
  "description_en": "string",
  "start_amount": "string",
  "start_amount_usd": "string",
  "start_amount_hkd": "string",
  "deduction_amount": "string",
  "deduction_amount_usd": "string",
  "deduction_amount_hkd": "string",
  "discount_rate": "string",
  "discount_ceiling_amount": "string",
  "discount_ceiling_amount_usd": "string",
  "discount_ceiling_amount_hkd": "string",
  "created_at": "string",
  "effect_at": "string",
  "expired_at": "string",
  "used_at": "string",
  "product_types": "string",
  "created_timestamp": 0,
  "effect_timestamp": 0,
  "expired_timestamp": 0,
  "used_timestamp": 0,
  "is_expired": true
}

Properties

Name	Type	Required	Restrictions	Description
id	integer,string	false	none	Database values may be serialized as strings
coupon_id	integer,string	false	none	Database values may be serialized as strings
type	integer,string	false	none	Database values may be serialized as strings
status	integer,string	false	none	Database values may be serialized as strings
source	integer,string	false	none	Database values may be serialized as strings
title	string	false	none	none
title_en	string	false	none	none
description	string	false	none	none
description_en	string	false	none	none
start_amount	string,number,null	false	none	none
start_amount_usd	string,number,null	false	none	none
start_amount_hkd	string,number,null	false	none	none
deduction_amount	string,number,null	false	none	none
deduction_amount_usd	string,number,null	false	none	none
deduction_amount_hkd	string,number,null	false	none	none
discount_rate	string,number,null	false	none	none
discount_ceiling_amount	string,number,null	false	none	none
discount_ceiling_amount_usd	string,number,null	false	none	none
discount_ceiling_amount_hkd	string,number,null	false	none	none
created_at	string,null	false	none	Y-m-d H:i:s
effect_at	string,null	false	none	Y-m-d H:i:s
expired_at	string,null	false	none	Y-m-d H:i:s
used_at	string,null	false	none	Y-m-d H:i:s
product_types	string,null	false	none	Applicable package types
created_timestamp	integer,null	false	none	none
effect_timestamp	integer,null	false	none	none
expired_timestamp	integer,null	false	none	none
used_timestamp	integer,null	false	none	none
is_expired	boolean	false	none	List interface returns

OpenApiNotification

{
  "id": 0,
  "title": "string",
  "content": "string",
  "type": 0,
  "read_status": 0,
  "created_at": "string",
  "created_timestamp": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer,string	false	none	Database values may be serialized as strings
title	string	false	none	none
content	string	false	none	Content rendered in requested language
type	integer,string	false	none	Database values may be serialized as strings
read_status	integer	false	none	none
created_at	string	false	none	Y-m-d H:i:s; non-RFC 3339 date
created_timestamp	integer	false	none	none

Enumerated Values

Property	Value
read_status	0
read_status	1

productTypes

Package type, 9 dynamic residential traffic package, 11 dynamic residential IP, 14 static data center IP, 25 static residential IP

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer	false	none	Package type, 9 dynamic residential traffic package, 11 dynamic residential IP, 14 static data center IP, 25 static residential IP

Enumerated Values

Property	Value
anonymous	9
anonymous	11
anonymous	14
anonymous	25

apiKey

"pa$$word"

API Key; passed using apiKeyAuth or the request parameter declared by the operation

Properties

Name	Type	Required	Restrictions	Description
anonymous	string(password)	false	none	API Key; passed using apiKeyAuth or the request parameter declared by the operation

responseCode

Status code, 200 successful, 3 app_key invalid

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer	false	none	Status code, 200 successful, 3 app_key invalid

responseMsg

"success"

response message

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	response message

SuccessResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Properties

None

ErrorResponse

{
  "code": 2,
  "msg": "parameter error",
  "data": {},
  "request_id": "string"
}

Properties

None

WebV1SuccessResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Properties

Name	Type	Required	Restrictions	Description
code	integer	true	none	none
msg	string	true	none	none
data	object,array,string,number,boolean,null	true	none	Business data, the specific type is defined by the interface
request_id	string	true	none	Request link tracking ID

WebV1ErrorResponse

{
  "code": 2,
  "msg": "parameter error",
  "data": {},
  "request_id": "string"
}

Properties

Name	Type	Required	Restrictions	Description
code	integer	true	none	Business error code

not

Name	Type	Required	Restrictions	Description
» anonymous	any	false	none	none

continued

Name	Type	Required	Restrictions	Description
msg	string	true	none	Error description
data	object,array,null	true	none	Error additional data, null if there is no additional data
request_id	string	true	none	Request link tracking ID

TeamPublicId

"A1b2C3d4E5f6"

The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued

ResourceSpaceId

"A1b2C3d4E5f6"

Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	TeamPublicId	false	none	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued

Team

{
  "id": "A1b2C3d4E5f6",
  "name": "string",
  "super_admin_user_id": 1,
  "status": 0,
  "current_role": 1,
  "dissolving_at": "string",
  "dissolved_at": "string",
  "created_at": "string",
  "updated_at": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	TeamPublicId	true	none	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
name	string	true	none	Team name
super_admin_user_id	integer	true	none	Super administrator user ID
status	integer	true	none	Team status: 0=disabled, 1=valid, 2=disbanding, 3=disbanded
current_role	integer,null	true	none	The current user's role in the team; null if cannot be determined
dissolving_at	string,null	true	none	Start dissolution time
dissolved_at	string,null	true	none	Dissolution completion time
created_at	string	true	none	creation time
updated_at	string	true	none	Update time

Enumerated Values

Property	Value
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

TeamAsset

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "product_id": 1,
  "product_type": 0,
  "parent_product_type": 0,
  "status": 0,
  "total_amount": 0,
  "remain": 0,
  "bandwidth": 0,
  "concurrency": 0,
  "expired_at": "string",
  "created_at": "string",
  "ip": "string",
  "country_code": "string",
  "country_name": "string",
  "asn": "string",
  "port": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	true	none	User plan ID
user_id	integer	true	none	Resource owner user ID
team_id	ResourceSpaceId	true	none	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
team_user_id	integer	true	none	Actual creation of member user IDs
product_id	integer	true	none	Product ID
product_type	integer	true	none	product type
parent_product_type	integer	true	none	Parent product type
status	integer	true	none	Package status
total_amount	integer(int64)	true	none	total amount
remain	integer(int64)	true	none	Remaining amount
bandwidth	integer	false	none	Bandwidth (Mbps); only returned by product_type=19 or 11
concurrency	integer	false	none	Number of concurrencies; only product_type=11 is returned
expired_at	string,null	true	none	Expiration time
created_at	string	true	none	creation time
ip	string	false	none	Static IP address; only product_type=19 returns
country_code	string	false	none	Static IP country code; only product_type=19 returns
country_name	string	false	none	Static IP country name; only returned by product_type=19
asn	string	false	none	Static IP ASN; only product_type=19 is returned
port	integer	false	none	Static IP proxy port; only returned by product_type=19

TeamProductInfo

{
  "team_id": "A1b2C3d4E5f6",
  "product_types": [
    0
  ],
  "product_residence_remain_count": 0,
  "product_residence_total_count": 0,
  "pdrue2_timestamp": 0,
  "remain": 0,
  "total_amount": 0,
  "scraping_remain": 0,
  "scraping_total_amount": 0,
  "scraping_timestamp": "string",
  "scraping_timestamp2": 0,
  "common_scraping_remain": 0,
  "common_scraping_total_amount": 0,
  "common_scraping_timestamp": "string",
  "common_scraping_timestamp2": 0,
  "pdidcr_count": 0,
  "pdidcr_total": 0,
  "pdidcr_traffic_remain": 0,
  "pdidcr_traffic_total": 0,
  "p_sitai_ip_count": 0,
  "p_sitai_ip": 0,
  "p_sitai_ip_total": 0,
  "p_sitai_remain": 0,
  "p_sitai_total": 0,
  "pdidc_count": 0,
  "pdidc_total": 0,
  "pdidc_ip_count": 0,
  "pdidc_ip_all_count": 0,
  "pdispr_count": 0,
  "pdispr_total": 0,
  "pdispr_traffic_remain": 0,
  "pdispr_traffic_total": 0,
  "product_datacenter_isp_traffic_ip_count": 0,
  "product_datacenter_isp_traffc_ip": 0,
  "product_datacenter_isp_traffc_ip_total": 0,
  "product_datacenter_isp_traffic_ip": 0,
  "product_datacenter_isp_traffic_ip_total": 0,
  "product_datacenter_isp_traffc_remain": 0,
  "product_datacenter_isp_traffc_total": 0,
  "product_datacenter_isp_traffic_remain": 0,
  "product_datacenter_isp_traffic_total": 0,
  "product_datacenter_isp_ip": 0,
  "product_datacenter_isp_ip_total": 0,
  "product_datacenter_isp_ip_count": 0,
  "product_datacenter_isp_ip_all_count": 0,
  "product_datacenter_isp_ip_traffic_remain": 0,
  "product_datacenter_isp_ip_traffic_total": 0,
  "product_agent_residence_remain_count": 0,
  "product_agent_residence_total_count": 0,
  "product_serp_remain": 0,
  "product_serp_total": 0,
  "product_serp_timestamp": "string",
  "product_serp_timestamp2": 0,
  "product_video_remain": 0,
  "product_video_total": 0,
  "product_video_timestamp": "string",
  "product_video_timestamp2": 0
}

Package statistical fields are consistent with /web_v1/user/info; cancellation, refund or soft deletion records are not included in the summary; except team_id and product_types, only fields corresponding to the product types supported by the current site are returned

Properties

Name	Type	Required	Restrictions	Description
team_id	TeamPublicId	true	none	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
product_types	[integer]	true	none	The team resource space has not been canceled or soft deleted and the package type supported by the current site
product_residence_remain_count	integer(int64)	false	none	Type 9 residual flow
product_residence_total_count	integer(int64)	false	none	Type 9 Total Traffic
pdrue2_timestamp	integer(int64)	false	none	Type 11 latest expiration timestamp; 0 when there is no team package
remain	integer,string	false	none	Type 17 Remaining Quantity
total_amount	integer,string	false	none	Type 17 Total quantity
scraping_remain	integer(int64)	false	none	Type 18 remaining times
scraping_total_amount	integer(int64)	false	none	Type 18 total times
scraping_timestamp	string	false	none	Type 18 latest expiration time; "-" when there is no package
scraping_timestamp2	integer(int64)	false	none	Type 18 latest expiration timestamp
common_scraping_remain	integer(int64)	false	none	Type 29 remaining times
common_scraping_total_amount	integer(int64)	false	none	Type 29 Total Times
common_scraping_timestamp	string	false	none	Type 29 latest expiration time; "-" when there is no package
common_scraping_timestamp2	integer(int64)	false	none	Type 29 latest expiration timestamp
pdidcr_count	integer	false	none	Type 12 Valid Package Quantity
pdidcr_total	integer	false	none	Total number of type 12 packages
pdidcr_traffic_remain	integer(int64)	false	none	Type 12 Residual Flow
pdidcr_traffic_total	integer(int64)	false	none	Type 12 Total Traffic
p_sitai_ip_count	integer	false	none	Type 13 Valid IP Number
p_sitai_ip	integer	false	none	Type 13 Valid Package Quantity
p_sitai_ip_total	integer	false	none	Total number of type 13 packages
p_sitai_remain	integer(int64)	false	none	Type 13/24 residual flow
p_sitai_total	integer(int64)	false	none	Type 13/24 Total Flow
pdidc_count	integer	false	none	Type 14 Valid Package Quantity
pdidc_total	integer	false	none	Total number of type 14 packages
pdidc_ip_count	integer	false	none	Type 14 Valid IP Number
pdidc_ip_all_count	integer	false	none	Type 14 IP Total
pdispr_count	integer	false	none	Type 15 Valid Package Quantity
pdispr_total	integer	false	none	Total number of type 15 packages
pdispr_traffic_remain	integer(int64)	false	none	Type 15 residual flow
pdispr_traffic_total	integer(int64)	false	none	Type 15 Total Traffic
product_datacenter_isp_traffic_ip_count	integer	false	none	Type 16 Valid IP Number
product_datacenter_isp_traffc_ip	integer	false	none	Type 16 Valid Package Quantity; Historically Compatible Spelling
product_datacenter_isp_traffc_ip_total	integer	false	none	Total Type 16 Packages; Historically Compatible Spellings
product_datacenter_isp_traffic_ip	integer	false	none	Type 16 Valid Package Quantity
product_datacenter_isp_traffic_ip_total	integer	false	none	Total number of type 16 packages
product_datacenter_isp_traffc_remain	integer(int64)	false	none	Type 16/24 residual traffic; historically compatible spelling
product_datacenter_isp_traffc_total	integer(int64)	false	none	Type 16/24 total flow; historically compatible spelling
product_datacenter_isp_traffic_remain	integer(int64)	false	none	Type 16/24 residual flow
product_datacenter_isp_traffic_total	integer(int64)	false	none	Type 16/24 Total Flow
product_datacenter_isp_ip	integer	false	none	Type 21 or 25 valid package quantity
product_datacenter_isp_ip_total	integer	false	none	Type 21 or 25 total packages
product_datacenter_isp_ip_count	integer	false	none	Type 21 or 25 Valid IP Number
product_datacenter_isp_ip_all_count	integer	false	none	Total Type 21 or 25 IP
product_datacenter_isp_ip_traffic_remain	integer(int64)	false	none	Type 21 corresponds to type 24 remaining flow
product_datacenter_isp_ip_traffic_total	integer(int64)	false	none	Type 21 corresponds to type 24 total flow
product_agent_residence_remain_count	integer(int64)	false	none	Type 22 Residual Flow
product_agent_residence_total_count	integer(int64)	false	none	Type 22 Total Traffic
product_serp_remain	integer(int64)	false	none	Type 27 remaining times
product_serp_total	integer(int64)	false	none	Type 27 Total Times
product_serp_timestamp	string	false	none	Type 27 latest expiration time; "-" when there is no package
product_serp_timestamp2	integer(int64)	false	none	Type 27 latest expiration timestamp
product_video_remain	integer(int64)	false	none	Type 28 Residual Flow
product_video_total	integer(int64)	false	none	Type 28 Total Flow
product_video_timestamp	string	false	none	Type 28 latest expiration time; "-" when there is no package
product_video_timestamp2	integer(int64)	false	none	Type 28 latest expiration timestamp

TeamWallet

{
  "team_id": "A1b2C3d4E5f6",
  "balance": 0.1,
  "total_recharge_fee": 0.1,
  "updated_at": "string"
}

Team wallet, isolated from the super administrator's personal balance; the amount uses the current site's default currency, with up to 4 decimal places.

Properties

Name	Type	Required	Restrictions	Description
team_id	TeamPublicId	true	none	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
balance	number(double)	true	none	Current available team balance
total_recharge_fee	number(double)	true	none	The current unspent team recharge principal, excluding the personal balance transfer amount
updated_at	string	true	none	Wallet last changed time

TeamWalletRecord

{
  "id": 1,
  "team_id": "A1b2C3d4E5f6",
  "operator_user_id": 0,
  "creator": {
    "user_id": 0,
    "display_name": "string",
    "nickname": "string",
    "username": "string",
    "email": "string",
    "phone": "string"
  },
  "direction": 0,
  "transaction_type": 1,
  "amount": 0.1,
  "after_balance": 0.1,
  "link_id": 0,
  "request_id": "string",
  "remark": "string",
  "created_at": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	true	none	none
team_id	TeamPublicId	true	none	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
operator_user_id	integer	true	none	Operator, the system refund is 0
creator	TeamCreator	false	none	none
direction	integer	true	none	0=expense, 1=income
transaction_type	integer	true	none	1=Recharge into account, 2=Transfer from personal balance, 3=Consumption of balance, 4=Refund or recharge refund, 5=Transfer back to personal balance
amount	number(double)	true	none	The amount of this change, the direction is represented by direction
after_balance	number(double)	true	none	Team wallet balance after change
link_id	integer	true	none	Associated order ID; when personal balance is transferred, it is the operating user ID
request_id	string	true	none	none
remark	string	true	none	none
created_at	string	true	none	none

Enumerated Values

Property	Value
direction	0
direction	1
transaction_type	1
transaction_type	2
transaction_type	3
transaction_type	4
transaction_type	5

TeamCreator

{
  "user_id": 0,
  "display_name": "string",
  "nickname": "string",
  "username": "string",
  "email": "string",
  "phone": "string"
}

Properties

Name	Type	Required	Restrictions	Description
user_id	integer	true	none	Operator user ID; system operation is 0
display_name	string	true	none	Display name, take nickname, username, email, and mobile phone number in order
nickname	string	true	none	none
username	string	true	none	none
email	string	true	none	Non-administrator perspective is desensitization value
phone	string	true	none	Non-administrator perspective is desensitization value

TeamResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	WebV1SuccessResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	Team	false	none	none

TeamListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": "A1b2C3d4E5f6",
        "name": "string",
        "super_admin_user_id": 1,
        "status": 0,
        "current_role": 1,
        "dissolving_at": "string",
        "dissolved_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	WebV1SuccessResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	object	false	none	none
»» list	[Team]	true	none	none
»» total	integer	true	none	none
»» page	integer	true	none	none
»» page_size	integer	true	none	none

TeamMemberListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "team_member_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 1,
        "role": 1,
        "status": 0,
        "joined_at": "string",
        "nickname": "string",
        "username": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	WebV1SuccessResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	object	false	none	none
»» list	[TeamMember]	true	none	none
»» total	integer	true	none	none
»» page	integer	true	none	none
»» page_size	integer	true	none	none

TeamPersonListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "record_type": "member",
        "record_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 0,
        "inviter_user_id": 0,
        "invite_type": 0,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 0,
        "role": 1,
        "status": 0,
        "display_name": "string",
        "nickname": "string",
        "username": "string",
        "email": "string",
        "phone": "string",
        "joined_at": "string",
        "expired_at": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	WebV1SuccessResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	object	false	none	none
»» list	[TeamPerson]	true	none	none
»» total	integer	true	none	none
»» page	integer	true	none	none
»» page_size	integer	true	none	none

TeamAssetResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	WebV1SuccessResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	TeamAsset	false	none	none

TeamProductInfoResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "product_types": [
      0
    ],
    "product_residence_remain_count": 0,
    "product_residence_total_count": 0,
    "pdrue2_timestamp": 0,
    "remain": 0,
    "total_amount": 0,
    "scraping_remain": 0,
    "scraping_total_amount": 0,
    "scraping_timestamp": "string",
    "scraping_timestamp2": 0,
    "common_scraping_remain": 0,
    "common_scraping_total_amount": 0,
    "common_scraping_timestamp": "string",
    "common_scraping_timestamp2": 0,
    "pdidcr_count": 0,
    "pdidcr_total": 0,
    "pdidcr_traffic_remain": 0,
    "pdidcr_traffic_total": 0,
    "p_sitai_ip_count": 0,
    "p_sitai_ip": 0,
    "p_sitai_ip_total": 0,
    "p_sitai_remain": 0,
    "p_sitai_total": 0,
    "pdidc_count": 0,
    "pdidc_total": 0,
    "pdidc_ip_count": 0,
    "pdidc_ip_all_count": 0,
    "pdispr_count": 0,
    "pdispr_total": 0,
    "pdispr_traffic_remain": 0,
    "pdispr_traffic_total": 0,
    "product_datacenter_isp_traffic_ip_count": 0,
    "product_datacenter_isp_traffc_ip": 0,
    "product_datacenter_isp_traffc_ip_total": 0,
    "product_datacenter_isp_traffic_ip": 0,
    "product_datacenter_isp_traffic_ip_total": 0,
    "product_datacenter_isp_traffc_remain": 0,
    "product_datacenter_isp_traffc_total": 0,
    "product_datacenter_isp_traffic_remain": 0,
    "product_datacenter_isp_traffic_total": 0,
    "product_datacenter_isp_ip": 0,
    "product_datacenter_isp_ip_total": 0,
    "product_datacenter_isp_ip_count": 0,
    "product_datacenter_isp_ip_all_count": 0,
    "product_datacenter_isp_ip_traffic_remain": 0,
    "product_datacenter_isp_ip_traffic_total": 0,
    "product_agent_residence_remain_count": 0,
    "product_agent_residence_total_count": 0,
    "product_serp_remain": 0,
    "product_serp_total": 0,
    "product_serp_timestamp": "string",
    "product_serp_timestamp2": 0,
    "product_video_remain": 0,
    "product_video_total": 0,
    "product_video_timestamp": "string",
    "product_video_timestamp2": 0
  },
  "request_id": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	WebV1SuccessResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	TeamProductInfo	false	none	Package statistical fields are consistent with /web_v1/user/info; cancellation, refund or soft deletion records are not included in the summary; except team_id and product_types, only fields corresponding to the product types supported by the current site are returned

TeamWalletResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	WebV1SuccessResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	TeamWallet	false	none	Team wallet, isolated from the super administrator's personal balance; the amount uses the current site's default currency, with up to 4 decimal places.

TeamWalletRecordListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "operator_user_id": 0,
        "creator": {
          "user_id": 0,
          "display_name": "string",
          "nickname": "string",
          "username": "string",
          "email": "string",
          "phone": "string"
        },
        "direction": 0,
        "transaction_type": 1,
        "amount": 0.1,
        "after_balance": 0.1,
        "link_id": 0,
        "request_id": "string",
        "remark": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	WebV1SuccessResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	object	false	none	none
»» list	[TeamWalletRecord]	true	none	none
»» total	integer	true	none	none
»» page	integer	true	none	none
»» page_size	integer	true	none	none

TeamAssetListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	WebV1SuccessResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	object	false	none	none
»» list	[TeamAsset]	true	none	none
»» total	integer	true	none	none
»» page	integer	true	none	none
»» page_size	integer	true	none	none

UserApiKeyMetadata

{
  "id": 1,
  "api_key": "string",
  "team_user_id": 0,
  "remark": "string",
  "status": 0,
  "created_at": "string",
  "updated_at": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	true	none	API Key ID
api_key	string	true	none	The creation response is the complete Key; the team list is the masked value
team_user_id	integer	true	none	The team key actually holds the member ID, and the personal key is 0
remark	string	true	none	Remarks
status	integer	true	none	0=disable, 1=enable
created_at	string	true	none	creation time
updated_at	string,null	false	none	Update time

Enumerated Values

Property	Value
status	0
status	1

InvoiceInfo

{
  "invoice_code": "string",
  "name": "string",
  "org_name": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "email": "[email protected]",
  "role_type": 1,
  "invoice_type": 0,
  "vat_id": "string",
  "tax_no": "string",
  "address_country": "string",
  "address_city": "string",
  "address_line1": "string",
  "address_line2": "string",
  "address_postal_code": "string",
  "bank_name": "string",
  "bank_account": "string",
  "is_def": true
}

Properties

Name	Type	Required	Restrictions	Description
invoice_code	string	false	none	none
name	string	false	none	none
org_name	string	false	none	none
first_name	string	false	none	none
last_name	string	false	none	none
phone	string	false	none	none
email	string(email)	false	none	none
role_type	integer	false	none	none
invoice_type	integer	false	none	none
vat_id	string	false	none	none
tax_no	string	false	none	none
address_country	string	false	none	none
address_city	string	false	none	none
address_line1	string	false	none	none
address_line2	string	false	none	none
address_postal_code	string	false	none	none
bank_name	string	false	none	none
bank_account	string	false	none	none
is_def	boolean	false	none	none

Enumerated Values

Property	Value
role_type	1
role_type	2
invoice_type	0
invoice_type	1
invoice_type	2

MonthlyRenewalRequest

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

Properties

Name	Type	Required	Restrictions	Description
team_id	ResourceSpaceId	false	none	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
user_product_ids	any	true	none	User plan ID array, also compatible with English comma separated strings

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	[integer]	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

continued

Name	Type	Required	Restrictions	Description
user_coupon_id	integer	false	none	none
coupon_sn	string	false	none	none

TeamInvitation

{
  "id": 1,
  "team_id": "A1b2C3d4E5f6",
  "inviter_user_id": 1,
  "invitee_user_id": 0,
  "invite_type": 1,
  "invite_country_code": 999,
  "invite_target": "string",
  "delivery_type": 1,
  "role": 2,
  "status": 0,
  "accepted_by_user_id": 0,
  "expired_at": "2026-07-17 10:00:00",
  "accepted_at": null,
  "rejected_at": null,
  "cancelled_at": null,
  "created_at": "2026-07-10 10:00:00"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	true	none	Invitation ID
team_id	TeamPublicId	true	none	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
inviter_user_id	integer	true	none	Inviter user ID
invitee_user_id	integer	true	none	Invited user ID, 0 if no registered user has been matched yet
invite_type	integer	true	none	Invitation type: 1=registered user, 2=email, 3=mobile phone number
invite_country_code	integer	true	none	Country or area code of mobile phone number, 0 for non-mobile phone number invitations
invite_target	string	true	none	Standardized invitation target; the registered user is user:{user_id}
delivery_type	integer	true	none	Original delivery channel: 1=registered user, 2=email, 3=mobile phone number; the original channel will be retained when the email or mobile phone number matches a registered user
role	integer	true	none	Target role: 2=administrator, 3=ordinary member
status	integer	true	none	Invitation status: 0=pending, 1=accepted, 2=rejected, 3=cancelled, 4=expired
accepted_by_user_id	integer	true	none	Acceptor user ID, 0 if not accepted
expired_at	string	true	none	Expiration time, format YYYY-MM-DD HH:mm:ss
accepted_at	string,null	true	none	Acceptance time
rejected_at	string,null	true	none	rejection time
cancelled_at	string,null	true	none	Cancellation time
created_at	string	true	none	Creation time, format YYYY-MM-DD HH:mm:ss

Enumerated Values

Property	Value
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4

TeamMember

{
  "team_member_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "user_id": 1,
  "role": 1,
  "status": 0,
  "joined_at": "string",
  "nickname": "string",
  "username": "string"
}

Properties

Name	Type	Required	Restrictions	Description
team_member_id	integer	true	none	Membership ID
team_id	TeamPublicId	true	none	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
user_id	integer	true	none	Member user ID
role	integer	true	none	Role: 1=super administrator, 2=administrator, 3=ordinary member, 4=finance member
status	integer	true	none	Member status: 0=disabled, 1=valid, 2=exited, 3=removed
joined_at	string,null	true	none	Join time, format YYYY-MM-DD HH:mm:ss
nickname	string	true	none	Member nickname
username	string	true	none	Member username

Enumerated Values

Property	Value
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

TeamPerson

{
  "record_type": "member",
  "record_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "user_id": 0,
  "inviter_user_id": 0,
  "invite_type": 0,
  "invite_country_code": 999,
  "invite_target": "string",
  "delivery_type": 0,
  "role": 1,
  "status": 0,
  "display_name": "string",
  "nickname": "string",
  "username": "string",
  "email": "string",
  "phone": "string",
  "joined_at": "string",
  "expired_at": "string",
  "created_at": "string"
}

Properties

Name	Type	Required	Restrictions	Description
record_type	string	true	none	Record type; member is a valid member, invitation is a pending invitation
record_id	integer	true	none	Membership ID or invitation ID
team_id	TeamPublicId	true	none	The team's public logo, the first character is an ASCII letter, and the remaining characters only contain ASCII letters and numbers; the database numeric primary key is not issued
user_id	integer	true	none	User ID, unregistered invited users are 0
inviter_user_id	integer	true	none	Inviter user ID, member record is 0
invite_type	integer	true	none	Invitation type, member record is 0
invite_country_code	integer	true	none	Mobile phone number country or area code, member record is 0
invite_target	string	true	none	Invitation target, member record is an empty string
delivery_type	integer	true	none	Original delivery channel, member record is 0
role	integer	true	none	Role: 1=super administrator, 2=administrator, 3=ordinary member, 4=finance member
status	integer	true	none	member is fixed to 1, invitation is fixed to 0
display_name	string	true	none	Display the name uniformly, taking the nickname, username, email, and mobile phone number in order; use desensitized values for contact information from the perspective of ordinary members
nickname	string	true	none	Nickname of member or registered invited user
username	string	true	none	Member or registered invited username
email	string	true	none	Email; super administrators and administrators return complete values, ordinary members return desensitization values with asterisks
phone	string	true	none	Mobile phone number; super administrators and administrators return the complete value, and ordinary members return the desensitized value with an asterisk.
joined_at	string,null	true	none	Member joining time, invitation record is null
expired_at	string,null	true	none	Invitation expiration time, member record is null
created_at	string	true	none	Record creation time, format YYYY-MM-DD HH:mm:ss

Enumerated Values

Property	Value
record_type	member
record_type	invitation
invite_type	0
invite_type	1
invite_type	2
invite_type	3
delivery_type	0
delivery_type	1
delivery_type	2
delivery_type	3
role	1
role	2
role	3
role	4
status	0
status	1

TeamInvitationResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	WebV1SuccessResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	TeamInvitation	false	none	none

TeamMemberResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	WebV1SuccessResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	TeamMember	false	none	none

TeamInvitationCreateResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	WebV1SuccessResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	object	false	none	none
»» invitation	TeamInvitation	true	none	none
»» invitation_token	string	true	none	Clear text invitation token, reserved only for compatible existing clients; new clients use invitation_url directly
»» invitation_url	string(uri)	true	none	Front-end processing link containing invitation token
»» notification_channels	TeamInvitationNotificationChannels	true	none	none

TeamInvitationNotificationChannels

{
  "email": "queued",
  "sms": "queued",
  "site_inner_message": "created"
}

Properties

Name	Type	Required	Restrictions	Description
email	string	false	none	Email channel results
sms	string	false	none	SMS channel results
site_inner_message	string	false	none	Site message channel results

Enumerated Values

Property	Value
email	queued
email	failed
email	skipped
sms	queued
sms	failed
sms	skipped
site_inner_message	created
site_inner_message	exists
site_inner_message	failed

TeamInvitationPreviewResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_name": "string",
    "role": 2,
    "status": 0,
    "expired_at": "string"
  },
  "request_id": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	WebV1SuccessResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	object	false	none	none
»» team_name	string	true	none	Team name
»» role	integer	true	none	target role
»» status	integer	true	none	invitation status
»» expired_at	string	true	none	Expiration time, format YYYY-MM-DD HH:mm:ss

Enumerated Values

Property	Value
role	2
role	3
status	0
status	1
status	2
status	3
status	4

TeamInvitationResendResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	WebV1SuccessResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	object	false	none	none
»» invitation	TeamInvitation	true	none	none
»» invitation_url	string(uri)	true	none	New invitation processing link; old link no longer works
»» notification_channels	TeamInvitationNotificationChannels	true	none	none

TeamInvitationListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "inviter_user_id": 1,
        "invitee_user_id": 0,
        "invite_type": 1,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 1,
        "role": 2,
        "status": 0,
        "accepted_by_user_id": 0,
        "expired_at": "2026-07-17 10:00:00",
        "accepted_at": null,
        "rejected_at": null,
        "cancelled_at": null,
        "created_at": "2026-07-10 10:00:00"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	WebV1SuccessResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	object	false	none	none
»» list	[TeamInvitation]	true	none	none
»» total	integer	true	none	total number of invitations
»» page	integer	true	none	Current page number
»» page_size	integer	true	none	actual number per page

User

{
  "id": 0,
  "email": "[email protected]",
  "phone": "string",
  "balance": 0.1,
  "status": 0,
  "is_real_name": true,
  "created_at": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
email	string(email)	false	none	none
phone	string	false	none	none
balance	number(float)	false	none	none
status	integer	false	none	none
is_real_name	boolean	false	none	none
created_at	string(date-time)	false	none	none

Order

{
  "id": 0,
  "trade_no": "string",
  "out_trade_no": "string",
  "product_id": 0,
  "product_type": 0,
  "amount": 0,
  "unit_price": 0.1,
  "total_fee": 0.1,
  "goods_fee": 0.1,
  "pay_fee": 0.1,
  "discount_fee": 0.1,
  "handling_fee": 0.1,
  "refund_fee": 0.1,
  "pm_id": 0,
  "pm_title": "string",
  "pm_logo": "string",
  "status": 0,
  "title": "string",
  "detail": "string",
  "region_desc": "string",
  "pay_at": "2019-08-24T14:15:22Z",
  "pay_timestamp": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "pay_fee_status": 0,
  "invoice": {
    "name": "string",
    "org_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "email": "[email protected]",
    "role_type": 0,
    "vat_id": "string",
    "address_country": "string",
    "address_city": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	Order ID
trade_no	string	false	none	Internal order number
out_trade_no	string	false	none	External order number
product_id	integer	false	none	Package ID
product_type	integer	false	none	Package type, see product type enumeration
amount	integer	false	none	Purchase quantity
unit_price	number(float)	false	none	unit price
total_fee	number(float)	false	none	Total order price (excluding discounts and handling fees)
goods_fee	number(float)	false	none	Product price (including discounts, excluding handling fees)
pay_fee	number(float)	false	none	Actual amount paid (including discounts and handling fees)
discount_fee	number(float)	false	none	Discount amount
handling_fee	number(float)	false	none	handling fee
refund_fee	number(float)	false	none	Refund amount
pm_id	integer	false	none	Payment method ID (from /openapi/payment/list)
pm_title	string	false	none	Payment method name
pm_logo	string	false	none	Payment method Logo URL
status	integer	false	none	Order status
title	string	false	none	Package title
detail	string	false	none	Package description
region_desc	string	false	none	Region specification description
pay_at	string(date-time)	false	none	payment time
pay_timestamp	integer	false	none	Payment timestamp
created_at	string(date-time)	false	none	creation time
pay_fee_status	integer	false	none	Long and short payment status: 0 normal 1 long payment (overpayment) 2 short payment
invoice	object	false	none	Invoice information (only valuable for online payment orders)
» name	string	false	none	full name
» org_name	string	false	none	Company name
» first_name	string	false	none	none
» last_name	string	false	none	none
» phone	string	false	none	none
» email	string(email)	false	none	none
» role_type	integer	false	none	1 person 2 companies
» vat_id	string	false	none	Tax ID number
» address_country	string	false	none	none
» address_city	string	false	none	none
» address_line1	string	false	none	none
» address_line2	string	false	none	none
» address_postal_code	string	false	none	none

OrderCheckResult

{
  "product_id": 0,
  "amount": 0,
  "discount_fee": 0.1,
  "total_fee": 0.1,
  "pay_fee": 0.1,
  "product_type": 0,
  "title": "string",
  "detail": "string",
  "ip_result": [
    {
      "ip": "string",
      "price": 0.1,
      "country_code": "string",
      "current_time": "2019-08-24T14:15:22Z",
      "renewal_time": "2019-08-24T14:15:22Z",
      "country": {
        "name_zh_cn": "string",
        "flag": "string",
        "square_flag": "string"
      }
    }
  ]
}

Order pre-check results

Properties

Name	Type	Required	Restrictions	Description
product_id	integer	false	none	Package ID
amount	integer	false	none	Quantity
discount_fee	number(float)	false	none	Discount amount
total_fee	number(float)	false	none	Order total
pay_fee	number(float)	false	none	Actual amount paid
product_type	integer	false	none	Package type
title	string	false	none	Package title
detail	string	false	none	Package description
ip_result	[object]	false	none	IP batch renewal results (returned only during IP renewal)
» ip	string	false	none	none
» price	number(float)	false	none	none
» country_code	string	false	none	none
» current_time	string(date-time)	false	none	none
» renewal_time	string(date-time)	false	none	none
» country	object	false	none	none
»» name_zh_cn	string	false	none	none
»» flag	string	false	none	Circle Flag URL
»» square_flag	string	false	none	Square Flag URL

Product

{
  "id": 0,
  "title": "string",
  "type": 0,
  "show_type": 0,
  "status": 0,
  "price": 0.1,
  "usd_price": 0.1,
  "price_hkd": 0.1,
  "original_price": 0.1,
  "original_usd_price": 0.1,
  "original_price_hkd": 0.1,
  "local_price": 0.1,
  "local_original_price": 0.1,
  "preferred_currency": "string",
  "support_currencies": "string",
  "flow_value": 0.1,
  "flow_give": 0.1,
  "balance_give": 0.1,
  "balance_value": 0.1,
  "time_validity": 0.1,
  "time_price": 0.1,
  "time_days": 0,
  "tip1": "string",
  "tip2": "string",
  "introduce": [
    "string"
  ],
  "region_list_id": 0,
  "renew_product_list": "string",
  "parent_product_type": 0,
  "total_count": 0,
  "remain_count": 0,
  "extension_of_time_days": [
    0
  ],
  "time_days_price_rate": 0.1,
  "desc": {
    "subtitle": "string",
    "flow_value": 0.1,
    "flow_give": 0.1,
    "balance_give": 0.1,
    "time_validity": 0.1,
    "time_price": 0.1,
    "tip1": "string",
    "tip2": "string",
    "introduce": [
      "string"
    ]
  },
  "sku": {
    "bandwidth_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ],
    "duration_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ],
    "concurrency_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	Package ID
title	string	false	none	Package main title
type	integer	false	none	Package type
show_type	integer	false	none	Display type: 1 Normal 2 Large recommendation 3 Not available for purchase (needs customization) 4 Trial
status	integer	false	none	Status: 1 on the shelves 0 off the shelves
price	number(float)	false	none	RMB price
usd_price	number(float)	false	none	dollar price
price_hkd	number(float)	false	none	Hong Kong dollar price
original_price	number(float)	false	none	Original price (CNY)
original_usd_price	number(float)	false	none	Original price (USD)
original_price_hkd	number(float)	false	none	Original price (HKD)
local_price	number(float)	false	none	Localized price (depends on preferred_currency)
local_original_price	number(float)	false	none	Localized original price (depends on preferred_currency)
preferred_currency	string	false	none	It is recommended to display the currency, such as usd / cny / hkd
support_currencies	string	false	none	List of supported currencies, separated by commas, such as usd,cny
flow_value	number(float)	false	none	Default traffic of data plan (GB)
flow_give	number(float)	false	none	Free traffic (GB)
balance_give	number(float)	false	none	Balance recharge bonus
balance_value	number(float)	false	none	Recharge amount
time_validity	number(float)	false	none	The default validity period of standard plans
time_price	number(float)	false	none	Standard package price per IP
time_days	integer	false	none	Number of days of validity, such as 30/90/180/365
tip1	string	false	none	Label description 1
tip2	string	false	none	Label description 2
introduce	[string]	false	none	Text introduction list
region_list_id	integer	false	none	Region ID
renew_product_list	string	false	none	List of renewable package IDs (comma separated)
parent_product_type	integer	false	none	Parent package type (valid when type=19): 14 or 25
total_count	integer	false	none	Total inventory, 0 means no limit
remain_count	integer	false	none	remaining stock
extension_of_time_days	[integer]	false	none	List of duration multiples. If it is empty or contains only 1, it means it is not supported.
time_days_price_rate	number(float)	false	none	Duration price coefficient, price × (1 + (multiple-1) × rate)
desc	object	false	none	Package description information
» subtitle	string	false	none	subtitle
» flow_value	number(float)	false	none	none
» flow_give	number(float)	false	none	none
» balance_give	number(float)	false	none	none
» time_validity	number(float)	false	none	none
» time_price	number(float)	false	none	none
» tip1	string	false	none	none
» tip2	string	false	none	none
» introduce	[string]	false	none	none
sku	object	false	none	Specification parameters (returned when type=11)
» bandwidth_list	[object]	false	none	Bandwidth specification list
»» id	integer	false	none	none
»» value	integer	false	none	Bandwidth value (Mbps)
»» price	number(float)	false	none	none
»» price_usd	number(float)	false	none	none
»» price_hkd	number(float)	false	none	none
» duration_list	[object]	false	none	Duration specification list
»» id	integer	false	none	none
»» value	integer	false	none	Duration (days)
»» price	number(float)	false	none	none
»» price_usd	number(float)	false	none	none
»» price_hkd	number(float)	false	none	none
» concurrency_list	[object]	false	none	Concurrency specification list
»» id	integer	false	none	none
»» value	integer	false	none	Number of concurrencies
»» price	number(float)	false	none	none
»» price_usd	number(float)	false	none	none
»» price_hkd	number(float)	false	none	none

WhiteIp

{
  "id": 0,
  "ip": "string",
  "remark": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
ip	string	false	none	none
remark	string	false	none	none
created_at	string(date-time)	false	none	none

WhitelistAccount

{
  "id": 0,
  "username": "string",
  "limit": 0,
  "used": 0,
  "status": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
username	string	false	none	none
limit	integer	false	none	none
used	integer	false	none	none
status	integer	false	none	none

Coupon

{
  "id": 0,
  "name": "string",
  "code": "string",
  "discount": 0.1,
  "expire_time": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none
code	string	false	none	none
discount	number(float)	false	none	none
expire_time	string(date-time)	false	none	none

Article

{
  "id": 0,
  "title": "string",
  "content": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
title	string	false	none	none
content	string	false	none	none
created_at	string(date-time)	false	none	none

Pagination

{
  "total": 0,
  "page_no": 0,
  "page_size": 0,
  "total_pages": 0
}

Properties

Name	Type	Required	Restrictions	Description
total	integer	false	none	none
page_no	integer	false	none	none
page_size	integer	false	none	none
total_pages	integer	false	none	none

AutoRenewalConfig

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "product_type": 0,
  "left_traffic": 0,
  "left_days": 0,
  "user_product_id": 1,
  "product_id": 0,
  "status": 0,
  "currency": "string",
  "agreed_price": 0,
  "agreed_bandwidth_price": 0,
  "agreed_concurrency_price": 0,
  "bandwidth_id": 0,
  "concurrency_id": 0,
  "duration": 0,
  "renew_product_id": 0,
  "days_before_expire": 0,
  "traffic_threshold": 0,
  "parent_product_type": 0,
  "created_at": "string",
  "updated_at": "string"
}

Auto-renewal configuration snapshot of a single package

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
user_id	integer	false	none	none
team_id	ResourceSpaceId	false	none	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
team_user_id	integer	false	none	none
product_type	integer	false	none	none
left_traffic	integer	false	none	Deprecated field
left_days	integer	false	none	Deprecated field
user_product_id	integer	false	none	none
product_id	integer	false	none	Deprecated field
status	integer	false	none	0=disable, 1=enable
currency	string	false	none	none
agreed_price	number	false	none	Agreed total price
agreed_bandwidth_price	number	false	none	Agreed bandwidth unit price for Package 11
agreed_concurrency_price	number	false	none	Agreed concurrent unit price for Package 11
bandwidth_id	integer	false	none	none
concurrency_id	integer	false	none	none
duration	integer	false	none	Renewal time, unit day
renew_product_id	integer	false	none	none
days_before_expire	integer	false	none	none
traffic_threshold	integer	false	none	Traffic threshold, database value unit KB
parent_product_type	integer	false	none	none
created_at	string	false	none	none
updated_at	string	false	none	none

Enumerated Values

Property	Value
status	0
status	1

AutoRenewalLog

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "config_id": 0,
  "user_product_id": 1,
  "product_type": 0,
  "renew_product_id": 0,
  "order_id": 0,
  "fee": 0,
  "currency": "string",
  "before_expired_at": "string",
  "after_expired_at": "string",
  "before_remain": 0,
  "after_remain": 0,
  "trigger_type": 0,
  "status": 1,
  "revoke_at": "string",
  "revoke_remark": "string",
  "created_at": "string",
  "updated_at": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	true	none	none
user_id	integer	true	none	none
team_id	ResourceSpaceId	true	none	Public resource space identification; omit team_id or pass an empty string when requesting a personal space, and an empty string when responding to a personal space; both the number 0 and the string "0" are illegal, and the team space uses a 6-12-digit team public identification
team_user_id	integer	true	none	none
config_id	integer	true	none	none
user_product_id	integer	true	none	none
product_type	integer	true	none	none
renew_product_id	integer	true	none	none
order_id	integer	true	none	none
fee	number	true	none	none
currency	string	true	none	none
before_expired_at	string,null	false	none	none
after_expired_at	string,null	false	none	none
before_remain	integer(int64)	true	none	none
after_remain	integer(int64)	true	none	none
trigger_type	integer	true	none	0=Before expiration, 1=Insufficient traffic
status	integer	true	none	1=success, 2=revoked, 3=failed
revoke_at	string,null	false	none	none
revoke_remark	string	true	none	none
created_at	string	true	none	none
updated_at	string	true	none	none

Enumerated Values

Property	Value
trigger_type	0
trigger_type	1
status	1
status	2
status	3

MonthlyRenewalBatch

{
  "type": "current",
  "start_at": "string",
  "end_at": "string",
  "target_expired_at": "string",
  "timezone": "string"
}

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	none
start_at	string	true	none	none
end_at	string	true	none	none
target_expired_at	string	true	none	none
timezone	string	true	none	none

Enumerated Values

Property	Value
type	current
type	next

MonthlyRenewalItem

{
  "id": 0,
  "user_product_id": 1,
  "product_id": 1,
  "product_type": 0,
  "parent_product_type": 0,
  "title": "string",
  "expired_at": "string",
  "target_expired_at": "string",
  "renew_days": 1,
  "unit_month_price": 0,
  "pay_fee": 0,
  "currency": "string",
  "bandwidth": 0,
  "bandwidth_mbsp": 0,
  "concurrency": 0,
  "ip": "string",
  "country_code": "string",
  "paid_at": "string",
  "refunded_at": "string",
  "created_at": "string",
  "updated_at": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	Historical billing detail ID
user_product_id	integer	true	none	none
product_id	integer	true	none	none
product_type	integer	true	none	none
parent_product_type	integer	true	none	none
title	string	true	none	none
expired_at	string	true	none	none
target_expired_at	string	true	none	none
renew_days	integer	true	none	none
unit_month_price	number	false	none	none
pay_fee	number	true	none	none
currency	string	true	none	none
bandwidth	integer	false	none	none
bandwidth_mbsp	number	false	none	Bandwidth conversion value
concurrency	integer	false	none	none
ip	string	false	none	Static IP package returns
country_code	string	false	none	Static IP package returns
paid_at	string,null	false	none	none
refunded_at	string,null	false	none	none
created_at	string	false	none	none
updated_at	string	false	none	none

InvoiceRecord

{
  "id": 1,
  "invoice_no": "string",
  "invoice_amount": 0,
  "invoice_download_url": "string",
  "status": 0,
  "remark": "string",
  "order_ids": [
    0
  ],
  "created_at": 0,
  "invoice_info": {
    "invoice_code": "string",
    "name": "string",
    "org_name": "string",
    "role_type": 1,
    "invoice_type": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	true	none	none
invoice_no	string	true	none	none
invoice_amount	number	true	none	none
invoice_download_url	string	true	none	none
status	integer	true	none	none
remark	string	true	none	none
order_ids	[integer]	true	none	none
created_at	integer	true	none	Unix timestamp
invoice_info	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» invoice_code	string	true	none	none
»» name	string	true	none	none
»» org_name	string	true	none	none
»» role_type	integer	true	none	none
»» invoice_type	integer	true	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

Enumerated Values

Property	Value
role_type	1
role_type	2
invoice_type	0
invoice_type	1
invoice_type	2

PayCheckData

{
  "trade_no": "string",
  "pm_id": 0,
  "pay_method": 0,
  "trade_type": "string",
  "country_code": "string",
  "currency": "string",
  "goods_fee": 0,
  "discount_fee": 0,
  "handling_fee": 0,
  "pay_fee": 0,
  "total_fee": 0,
  "pay_method_info": {
    "id": 0,
    "type": 0,
    "title": "string",
    "group": "string",
    "handling_rate": 0,
    "handling_fee": 0,
    "handling_fee_currency": "usd",
    "handling_fee_converted": 0
  },
  "origin": {
    "pm_id": 0,
    "pay_method": 0,
    "goods_fee": 0,
    "discount_fee": 0,
    "handling_fee": 0,
    "pay_fee": 0,
    "total_fee": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
trade_no	string	true	none	none
pm_id	integer	true	none	none
pay_method	integer	true	none	none
trade_type	string	true	none	none
country_code	string	true	none	none
currency	string	true	none	none
goods_fee	number	true	none	none
discount_fee	number	true	none	none
handling_fee	number	true	none	none
pay_fee	number	true	none	none
total_fee	number	true	none	none
pay_method_info	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» id	integer	true	none	none
»» type	integer	true	none	none
»» title	string	true	none	none
»» group	string	true	none	none
»» handling_rate	number	true	none	none
»» handling_fee	number	true	none	none
»» handling_fee_currency	string	true	none	none
»» handling_fee_converted	number	true	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
origin	object	true	none	none
» pm_id	integer	true	none	none
» pay_method	integer	true	none	none
» goods_fee	number	true	none	none
» discount_fee	number	true	none	none
» handling_fee	number	true	none	none
» pay_fee	number	true	none	none
» total_fee	number	true	none	none