Skip to content

Proxy CRUD Operations

Fresh

Add Proxy

URL: https://openapi.geelark.com/open/v1/proxy/addMethod: POST

Duplicate proxies will not be added.

ParameterRequiredTypeDescription
listYesarrayProxy items (max 100)
list[].schemeYesstringsocks5, http, or https
list[].serverYesstringProxy address
list[].portYesintegerProxy port
list[].usernameNostringUsername
list[].passwordNostringPassword

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

ParameterRequiredTypeDescription
listYesarrayProxy items (max 100)
list[].idYesstringProxy ID
list[].schemeYesstringProxy type
list[].serverYesstringProxy address
list[].portYesintegerProxy port
list[].usernameNostringUsername
list[].passwordNostringPassword

Delete Proxy

URL: https://openapi.geelark.com/open/v1/proxy/deleteMethod: POST

ParameterRequiredTypeDescription
idsYesarray[string]Proxy IDs (max 100)

Error Codes

CodeDescription
40005Proxy not found
40010Proxy binds to environment

List Proxies

URL: https://openapi.geelark.com/open/v1/proxy/listMethod: POST

ParameterRequiredTypeDescription
pageYesintegerPage number (min 1)
pageSizeYesintegerItems per page (1-100)
idsNoarray[string]Filter by proxy IDs

Response Fields

FieldTypeDescription
totalintegerTotal items
pageintegerCurrent page
pageSizeintegerItems per page
list[].idstringProxy ID
list[].serialNointegerProxy sequence number
list[].schemestringProxy type
list[].serverstringProxy address
list[].portintegerProxy port
list[].usernamestringUsername

Proxy Error Codes

CodeDescription
40005Proxy not found
45003Proxy not allowed
45004Proxy check failed
45007Proxy already exists
45008Proxy type not allowed

GEELark API Documentation - Built with VitePress