DICloak API – Proxy Interface

by DICloak
2024-12-112025-8-19

1.. Proxy Interface

GET to Obtain the Proxy List

GET /v1/proxys

Request Parameters

Name	Location	Type	Required	Description
page_no	query	integer	No	Page number. The default value is 1.
page_size	query	integer	No	Pagination size. The default value is 10.
all	query	boolean	No	Whether to obtain the full amount of data. When it is set to true, page_no and page_size will be ignored.
detail	query	boolean	No	Whether details are required.
serial_num	query	integer	No	Serial number.
id	query	string	No	ID.
type	query	string	No	Proxy type (NON_USE: Not in use, HTTP, HTTPS, SSH, SOCKS5, IPFLY).
host	query	string	No	Proxy host.
env	query	string	No	Using browser profile.
remark	query	string	No	Remarks.

Response Parameters

Name	Type	Description
list	OpenApiProxyVO
total	integer

OpenApiProxyVO

Name	Type	Description
id	string	ID.
create_time	string	Creation time.
update_time	string	Update time.
serial_num	integer	Serial number.
type	string	Proxy type (NON_USE: Not in use, HTTP, HTTPS, SSH, SOCKS5, IPFLY).
host	string	Proxy host.
port	integer	Proxy port.
user_name	string	Proxy account.
passwd	string	Proxy password.
ip_type	string	IP query channel (IP2LOCATION).
status	string	Status (WAIT to be detected, SUCCESS for success, FAIL for failure).
remark	string	Remarks.
proxy_ip_info	CheckProxyIpResultVO	Proxy information.

CheckProxyIpResultVO

Name	Type	Description
ip	string	IP address.
connect	boolean	Whether it can be connected or not.
country	string	Country.
country_code	string	Country code.
region	string	Region (province).
city	string	City.
timezone	string	Time zone.
latitude	string	Latitude.
longitude	string	Longitude.
zip_code	string	Zip 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",
          "city": "string",
          "timezone": "string",
          "latitude": "string",
          "longitude": "string",
          "zip_code": "string",
          "err_msg": "string",
          "check_time": "2019-08-24T14:15:22Z",
          "ip_type": "["
        }
      }
    ],
    "total": 0,
    "page_token": "string"
  }
}

GET to Obtain the Proxy Details

GET /v1/proxy/{id}

Request Parameters

Name	Location	Type	Required	Description
id	path	string	Yes
X-API-KEY	header	string	Yes

Return Results

Status Code	Meaning of Status Code	Description	Data Model
200	OK	The request was successful.	Refer to the list fields.

{
  "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",
      "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"
}

POST : Create the Proxy

POST /v1/proxy

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

Request Parameters

Name	Location	Type	Required	Instructions
X-API-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	No	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"
}

Description of return result parameters:

Name	Type	Required	Instructions
code	integer	No
msg	string	No
data	OpenApiProxyVO	No	Reference List
next	string	No

PUT to Modify the Proxy

PUT /v1/proxy/{id}

Request Parameters

Name	Location	Type	Required
id	path	string	Yes
X-API-KEY	header	string	Yes
body	body	OpenProxyEditReq	No

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

OpenProxyEditReq

Name	Location	Type	Required	Description
type	body	string	No	Proxy type (NON_USE: Not in use, HTTP, HTTPS, SSH, SOCKS5, IPFLY).
host	body	string	No	Proxy host.
port	body	integer	No	Proxy port.
user_name	body	string	No	Proxy 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 for success, FAIL for failure).
remark	body	string	No	Remarks.
out_ip	body	string	No	Outbound IP.

Return Results

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

DELETE : Delete the Proxy

DELETE /v1/proxy/{id}

Request Parameters

Name	Location	Type	Required	Description
id	path	string	Yes	Proxy ID, which is the ID returned in the list.
X-API-KEY	header	string	Yes

Return Results

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

DICloak Help Center