Overview of Interface Usage

• When the interface request method is post, the parameter passing method is always body parameter passing, passing data in json format, not form-data, nor url parameter passing
• When the interface request method is get, the parameter passing is form-data
• The interface request method is put/patch/delete. For specific parameter passing, refer to the definition in the interface documentation.
• When the interface request returns 200 successfully, it returns a json object, with code 0 indicating success. If there is return data, it is appended to the data object.
• When the interface does not return 200, it is considered an exception. Refer to HTTP error codes for exception codes. When code is not 0, it indicates failure, and failure information will be appended to the msg field. Refer to the following table for the error code field.
• All requests need to include the request header:X-HTTP-KEY, whose value is the secret key copied from the [Open Api - Http API] interface of DICloak software.

GET Obtain Proxy List

GET /v1/api/request/proxy

Request Parameters

Name	Position	Type	Required	Instructions
page_no	query	integer	No	Page number, default 1
page_size	query	integer	No	Page size, default 10
all	query	boolean	No	Whether to obtain full data. When it is true, pageNo and pageSize are ignored.
detail	query	boolean	No	Do you need details?
serial_num	query	integer	No	Serial Number
id	query	string	No	id
type	query	string	No	Proxy Type (NON_USE: Do not use HTTP, HTTPS, SSH, SOCKS5, IPFLY)
host	query	string	No	Proxy Host
env	query	string	No	Usage Profile
remark	query	string	No	Remarks

Response Parameter

Name	Type	Instructions
list	HttpApiProxyVO
total	integer

HttpApiProxyVO

Name	Type	Instructions
id	string	id
create_time	string	Creation Time
update_time	string	Modification Time
serial_num	integer	Serial Number
type	string	Proxy Type (NON_USE: Do not use HTTP, HTTPS, SSH, SOCKS5, IPFLY)
host	string	Proxy Host
port	integer	Proxy Port
user_name	string	Agent Account
passwd	string	Proxy Password
ip_type	string	IP Query Channel (IP2LOCATION)
status	string	Status (WAIT to be detected, SUCCESS, FAIL)
remark	string	Remarks
proxy_ip_info	CheckProxyIpResultVO	Agent Information

CheckProxyIpResultVO

Name	Type	Instructions
ip	string	ip
connect	boolean	Whether it can be connected
country	string	Country
country_code	string	Country Code
region	string	Region (Province)
region_code	string	Region (Province) Code
city	string	City
timezone	string	Time Zone
latitude	string	Latitude
longitude	string	Longitude
zip_code	string	Postal Code
err_msg	string	Error Message
check_time	string	Monitoring Time
ip_type	string	IP Channel Type

{
  "code": 0,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": "string",
        "create_time": "string",
        "update_time": "string",
        "serial_num": 0,
        "type": "NON_USE",
        "host": "string",
        "port": 0,
        "user_name": "string",
        "passwd": "string",
        "ip_type": "IP2LOCATION",
        "status": "WAIT",
        "remark": "string",
        "proxy_ip_info": {
          "ip": "string",
          "connect": true,
          "country": "string",
          "country_code": "string",
          "region": "string",
          "region_code": "string",
          "city": "string",
          "timezone": "string",
          "latitude": "string",
          "longitude": "string",
          "zip_code": "string",
          "err_msg": "string",
          "check_time": "2025-12-01 12:00:00",
          "ip_type": "string"
        }
      }
    ],
    "total": 0,
    "page_token": "string"
  }
}

GET Obtain Proxy Details

GET /v1/api/request/proxy/{id}

Request Parameters

Name	Position	Type	Required	Description
id	path	string	Yes
X-HTTP-KEY	header	string	Yes

Return Result

Status Code	Meaning of Status Codes	Description	Data Model
200	OK	OK	Reference List Field

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": "string",
    "create_time": "string",
    "update_time": "string",
    "serial_num": 0,
    "type": "NON_USE",
    "host": "string",
    "port": 0,
    "user_name": "string",
    "passwd": "string",
    "ip_type": "IP2LOCATION",
    "status": "WAIT",
    "remark": "string",
    "proxy_ip_info": {
      "ip": "string",
      "connect": true,
      "country": "string",
      "country_code": "string",
      "region": "string",
      "region_code": "string",
      "city": "string",
      "timezone": "string",
      "latitude": "string",
      "longitude": "string",
      "zip_code": "string",
      "err_msg": "string",
      "check_time": "2019-08-24T14:15:22Z",
      "ip_type": "IP2LOCATION"
    }
  },
  "next": "string"
}

PUT Modify Agent

PUT /v1/api/request/proxy/{id}

Request Parameters

Name	Location	Type	Required	Description
id	path	string	Yes
X-HTTP-KEY	header	string	Yes
body	body	HttpApiProxyEditReq	No

{
  "type": "NON_USE",
  "host": "string",
  "port": 0,
  "user_name": "string",
  "passwd": "string",
  "ip_type": "IP2LOCATION",
  "status": "WAIT",
  "remark": "string",
  "out_ip": "string"
}

HttpApiProxyEditReq

Name	Location	Type	Required	Description
type	body	string	No	Proxy type (NON_USE: without HTTP HTTPS SSH SOCKS5 IPFLY)
host	body	string	No	Proxy host
port	body	integer	No	Proxy port
user_name	body	string	No	Agent Account
passwd	body	string	No	Proxy Password
ip_type	body	string	No	IP Query Channel (IP2LOCATION)
status	body	string	No	Status (WAIT to be detected, SUCCESS, FAIL)
remark	body	string	No	Remarks
out_ip	body	string	No	Export IP

Return the result

{
  "code": 0,
  "msg": "string",
  "data": {}
}

DELETE Delete Agent

DELETE /v1/api/request/proxy/{id}

Request Parameters

Name	Location	Type	Required	Description
id	path	string	Yes	Agent ID, the ID returned in the list
X-HTTP-KEY	header	string	Yes

Return Result

{
  "code": 0,
  "msg": "string",
  "data": {}
}

POST Save Agent

POST /v1/api/request/proxy

{
    "type": Type,
    "host": "string",
    "port": number,
    "user_name": "string",
    "passwd": "string",
    "remark": "string"
}

Request Parameters

Name	Location	Type	Required	Description
X-HTTP-KEY	header	string	Yes	none
body	body	object	No	none
type	body	string	Yes	Proxy Type (HTTP HTTPS SOCKS5 IPFLY)
host	body	string	Yes	host
port	body	number	Yes	Port
user_name	body	string	No	Username
passwd	body	string	No	Password
remark	body	string	No	Remarks
ip_type	body	string	Yes	IP Query Channel (IP2LOCATION IPAPI)
out_ip	body	string	No	Export IP

Return Result

{
    "code": 0,
    "msg": "success",
    "data": {
        "id": "string",
        "serial_num": "number",
        "type": "string",
        "host": "string",
        "port": "number",
        "user_name": "string",
        "passwd": "string",
        "ip_type": "string",
        "status": "string",
        "remark": "string",
        "proxy_ip_info": {
            "ip": "string",
            "connect": "boolean",
            "country": "string",
            "country_code": "string",
            "region": "string",
            "region_code": "string",
            "city": "string",
            "timezone": "string",
            "latitude": "string",
            "longitude": "string",
            "zip_code": "string",
            "err_msg": "string",
            "check_time": "2025-08-18 16:47:13",
            "ip_type": "string"
        }
    },
    "next": "string"
}

Name	Type	Required	Description
code	integer	No
msg	string	No
data	HttpApiProxyVO	No	Reference List
next	string	No