Proxy CRUD Operations
FreshAdd Proxy
URL: https://openapi.geelark.com/open/v1/proxy/addMethod: POST
Duplicate proxies will not be added.
| Parameter | Required | Type | Description |
|---|---|---|---|
| list | Yes | array | Proxy items (max 100) |
| list[].scheme | Yes | string | socks5, http, or https |
| list[].server | Yes | string | Proxy address |
| list[].port | Yes | integer | Proxy port |
| list[].username | No | string | Username |
| list[].password | No | string | Password |
Request Example
json
{
"list": [
{
"scheme": "socks5",
"server": "192.3.8.1",
"port": 8000,
"username": "admin",
"password": "admin"
}
]
}Response
json
{
"code": 40006,
"msg": "partial success",
"data": {
"totalAmount": 2,
"successAmount": 1,
"failAmount": 1,
"failDetails": [
{ "index": 0, "code": 45007, "msg": "proxy already exists" }
],
"successDetails": [
{ "index": 1, "id": "493188072704313353" }
]
}
}Update Proxy
URL: https://openapi.geelark.com/open/v1/proxy/updateMethod: POST
| Parameter | Required | Type | Description |
|---|---|---|---|
| list | Yes | array | Proxy items (max 100) |
| list[].id | Yes | string | Proxy ID |
| list[].scheme | Yes | string | Proxy type |
| list[].server | Yes | string | Proxy address |
| list[].port | Yes | integer | Proxy port |
| list[].username | No | string | Username |
| list[].password | No | string | Password |
Delete Proxy
URL: https://openapi.geelark.com/open/v1/proxy/deleteMethod: POST
| Parameter | Required | Type | Description |
|---|---|---|---|
| ids | Yes | array[string] | Proxy IDs (max 100) |
Error Codes
| Code | Description |
|---|---|
| 40005 | Proxy not found |
| 40010 | Proxy binds to environment |
List Proxies
URL: https://openapi.geelark.com/open/v1/proxy/listMethod: POST
| Parameter | Required | Type | Description |
|---|---|---|---|
| page | Yes | integer | Page number (min 1) |
| pageSize | Yes | integer | Items per page (1-100) |
| ids | No | array[string] | Filter by proxy IDs |
Response Fields
| Field | Type | Description |
|---|---|---|
| total | integer | Total items |
| page | integer | Current page |
| pageSize | integer | Items per page |
| list[].id | string | Proxy ID |
| list[].serialNo | integer | Proxy sequence number |
| list[].scheme | string | Proxy type |
| list[].server | string | Proxy address |
| list[].port | integer | Proxy port |
| list[].username | string | Username |
Proxy Error Codes
| Code | Description |
|---|---|
| 40005 | Proxy not found |
| 45003 | Proxy not allowed |
| 45004 | Proxy check failed |
| 45007 | Proxy already exists |
| 45008 | Proxy type not allowed |