> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.flashid.app/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.flashid.app/_mcp/server. # Add proxies POST http://127.0.0.1:58931/api/proxies Content-Type: application/json Add one or more proxies. Duplicates already in your account are detected and skipped automatically. Each proxy object: `proxy_type` ∈ `http` `https` `socks5`; `proxy_host`, `proxy_port` (required); `proxy_user`, `proxy_pass`, `refresh_url`, `remark` optional; `ipchecker` ∈ `ip2location` `ipapi`. **Body parameters** | Field | Type | Required | Description | |---|---|---|---| | `proxies` | `array` | Yes | Non-empty array of proxy objects (see above). | Reference: https://docs.flashid.app/flash-id-local-api/proxies/add-proxies ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /api/proxies: post: operationId: add-proxies summary: Add proxies description: >- Add one or more proxies. Duplicates already in your account are detected and skipped automatically. Each proxy object: `proxy_type` ∈ `http` `https` `socks5`; `proxy_host`, `proxy_port` (required); `proxy_user`, `proxy_pass`, `refresh_url`, `remark` optional; `ipchecker` ∈ `ip2location` `ipapi`. **Body parameters** | Field | Type | Required | Description | |---|---|---|---| | `proxies` | `array` | Yes | Non-empty array of proxy objects (see above). | tags: - subpackage_proxies parameters: - name: X-API-Key in: header required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Proxies_Add proxies_Response_200' requestBody: content: application/json: schema: type: object properties: proxies: type: array items: $ref: >- #/components/schemas/ApiProxiesPostRequestBodyContentApplicationJsonSchemaProxiesItems required: - proxies servers: - url: http://127.0.0.1:58931 description: http://127.0.0.1:58931 components: schemas: ApiProxiesPostRequestBodyContentApplicationJsonSchemaProxiesItems: type: object properties: remark: type: string ipchecker: type: string proxy_host: type: string proxy_pass: type: string proxy_port: type: string proxy_type: type: string proxy_user: type: string refresh_url: type: string required: - remark - ipchecker - proxy_host - proxy_pass - proxy_port - proxy_type - proxy_user - refresh_url title: ApiProxiesPostRequestBodyContentApplicationJsonSchemaProxiesItems ApiProxiesPostResponsesContentApplicationJsonSchemaData: type: object properties: added: type: integer message: type: string skipped: type: integer required: - added - message - skipped title: ApiProxiesPostResponsesContentApplicationJsonSchemaData Proxies_Add proxies_Response_200: type: object properties: code: type: integer data: $ref: >- #/components/schemas/ApiProxiesPostResponsesContentApplicationJsonSchemaData success: type: boolean required: - code - data - success title: Proxies_Add proxies_Response_200 securitySchemes: apiKeyAuth: type: apiKey in: header name: X-API-Key ``` ## Examples **Request** ```json { "proxies": [ { "remark": "Office SOCKS5 proxy", "ipchecker": "ip2location", "proxy_host": "192.168.1.100", "proxy_pass": "securePass123", "proxy_port": "1080", "proxy_type": "socks5", "proxy_user": "officeUser", "refresh_url": "http://192.168.1.100:1080/refresh" }, { "remark": "Backup HTTP proxy", "ipchecker": "ipapi", "proxy_host": "203.0.113.45", "proxy_pass": "backupPass456", "proxy_port": "8080", "proxy_type": "http", "proxy_user": "backupUser", "refresh_url": "http://203.0.113.45:8080/refresh" }, { "remark": "Public HTTPS proxy", "ipchecker": "ip2location", "proxy_host": "198.51.100.22", "proxy_pass": "publicPass789", "proxy_port": "443", "proxy_type": "https", "proxy_user": "publicUser", "refresh_url": "https://198.51.100.22:443/refresh" }, { "remark": "Duplicate proxy entry", "ipchecker": "ipapi", "proxy_host": "192.168.1.100", "proxy_pass": "securePass123", "proxy_port": "1080", "proxy_type": "socks5", "proxy_user": "officeUser", "refresh_url": "http://192.168.1.100:1080/refresh" } ] } ``` **Response** ```json { "code": 0, "data": { "added": 3, "message": "Added 3 proxies, skipped 1 duplicates", "skipped": 1 }, "success": true } ``` **SDK Code** ```python Proxies_Add proxies_example import requests url = "http://127.0.0.1:58931/api/proxies" payload = { "proxies": [ { "remark": "Office SOCKS5 proxy", "ipchecker": "ip2location", "proxy_host": "192.168.1.100", "proxy_pass": "securePass123", "proxy_port": "1080", "proxy_type": "socks5", "proxy_user": "officeUser", "refresh_url": "http://192.168.1.100:1080/refresh" }, { "remark": "Backup HTTP proxy", "ipchecker": "ipapi", "proxy_host": "203.0.113.45", "proxy_pass": "backupPass456", "proxy_port": "8080", "proxy_type": "http", "proxy_user": "backupUser", "refresh_url": "http://203.0.113.45:8080/refresh" }, { "remark": "Public HTTPS proxy", "ipchecker": "ip2location", "proxy_host": "198.51.100.22", "proxy_pass": "publicPass789", "proxy_port": "443", "proxy_type": "https", "proxy_user": "publicUser", "refresh_url": "https://198.51.100.22:443/refresh" }, { "remark": "Duplicate proxy entry", "ipchecker": "ipapi", "proxy_host": "192.168.1.100", "proxy_pass": "securePass123", "proxy_port": "1080", "proxy_type": "socks5", "proxy_user": "officeUser", "refresh_url": "http://192.168.1.100:1080/refresh" } ] } headers = { "X-API-Key": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Proxies_Add proxies_example const url = 'http://127.0.0.1:58931/api/proxies'; const options = { method: 'POST', headers: {'X-API-Key': '', 'Content-Type': 'application/json'}, body: '{"proxies":[{"remark":"Office SOCKS5 proxy","ipchecker":"ip2location","proxy_host":"192.168.1.100","proxy_pass":"securePass123","proxy_port":"1080","proxy_type":"socks5","proxy_user":"officeUser","refresh_url":"http://192.168.1.100:1080/refresh"},{"remark":"Backup HTTP proxy","ipchecker":"ipapi","proxy_host":"203.0.113.45","proxy_pass":"backupPass456","proxy_port":"8080","proxy_type":"http","proxy_user":"backupUser","refresh_url":"http://203.0.113.45:8080/refresh"},{"remark":"Public HTTPS proxy","ipchecker":"ip2location","proxy_host":"198.51.100.22","proxy_pass":"publicPass789","proxy_port":"443","proxy_type":"https","proxy_user":"publicUser","refresh_url":"https://198.51.100.22:443/refresh"},{"remark":"Duplicate proxy entry","ipchecker":"ipapi","proxy_host":"192.168.1.100","proxy_pass":"securePass123","proxy_port":"1080","proxy_type":"socks5","proxy_user":"officeUser","refresh_url":"http://192.168.1.100:1080/refresh"}]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Proxies_Add proxies_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "http://127.0.0.1:58931/api/proxies" payload := strings.NewReader("{\n \"proxies\": [\n {\n \"remark\": \"Office SOCKS5 proxy\",\n \"ipchecker\": \"ip2location\",\n \"proxy_host\": \"192.168.1.100\",\n \"proxy_pass\": \"securePass123\",\n \"proxy_port\": \"1080\",\n \"proxy_type\": \"socks5\",\n \"proxy_user\": \"officeUser\",\n \"refresh_url\": \"http://192.168.1.100:1080/refresh\"\n },\n {\n \"remark\": \"Backup HTTP proxy\",\n \"ipchecker\": \"ipapi\",\n \"proxy_host\": \"203.0.113.45\",\n \"proxy_pass\": \"backupPass456\",\n \"proxy_port\": \"8080\",\n \"proxy_type\": \"http\",\n \"proxy_user\": \"backupUser\",\n \"refresh_url\": \"http://203.0.113.45:8080/refresh\"\n },\n {\n \"remark\": \"Public HTTPS proxy\",\n \"ipchecker\": \"ip2location\",\n \"proxy_host\": \"198.51.100.22\",\n \"proxy_pass\": \"publicPass789\",\n \"proxy_port\": \"443\",\n \"proxy_type\": \"https\",\n \"proxy_user\": \"publicUser\",\n \"refresh_url\": \"https://198.51.100.22:443/refresh\"\n },\n {\n \"remark\": \"Duplicate proxy entry\",\n \"ipchecker\": \"ipapi\",\n \"proxy_host\": \"192.168.1.100\",\n \"proxy_pass\": \"securePass123\",\n \"proxy_port\": \"1080\",\n \"proxy_type\": \"socks5\",\n \"proxy_user\": \"officeUser\",\n \"refresh_url\": \"http://192.168.1.100:1080/refresh\"\n }\n ]\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("X-API-Key", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Proxies_Add proxies_example require 'uri' require 'net/http' url = URI("http://127.0.0.1:58931/api/proxies") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Post.new(url) request["X-API-Key"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"proxies\": [\n {\n \"remark\": \"Office SOCKS5 proxy\",\n \"ipchecker\": \"ip2location\",\n \"proxy_host\": \"192.168.1.100\",\n \"proxy_pass\": \"securePass123\",\n \"proxy_port\": \"1080\",\n \"proxy_type\": \"socks5\",\n \"proxy_user\": \"officeUser\",\n \"refresh_url\": \"http://192.168.1.100:1080/refresh\"\n },\n {\n \"remark\": \"Backup HTTP proxy\",\n \"ipchecker\": \"ipapi\",\n \"proxy_host\": \"203.0.113.45\",\n \"proxy_pass\": \"backupPass456\",\n \"proxy_port\": \"8080\",\n \"proxy_type\": \"http\",\n \"proxy_user\": \"backupUser\",\n \"refresh_url\": \"http://203.0.113.45:8080/refresh\"\n },\n {\n \"remark\": \"Public HTTPS proxy\",\n \"ipchecker\": \"ip2location\",\n \"proxy_host\": \"198.51.100.22\",\n \"proxy_pass\": \"publicPass789\",\n \"proxy_port\": \"443\",\n \"proxy_type\": \"https\",\n \"proxy_user\": \"publicUser\",\n \"refresh_url\": \"https://198.51.100.22:443/refresh\"\n },\n {\n \"remark\": \"Duplicate proxy entry\",\n \"ipchecker\": \"ipapi\",\n \"proxy_host\": \"192.168.1.100\",\n \"proxy_pass\": \"securePass123\",\n \"proxy_port\": \"1080\",\n \"proxy_type\": \"socks5\",\n \"proxy_user\": \"officeUser\",\n \"refresh_url\": \"http://192.168.1.100:1080/refresh\"\n }\n ]\n}" response = http.request(request) puts response.read_body ``` ```java Proxies_Add proxies_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("http://127.0.0.1:58931/api/proxies") .header("X-API-Key", "") .header("Content-Type", "application/json") .body("{\n \"proxies\": [\n {\n \"remark\": \"Office SOCKS5 proxy\",\n \"ipchecker\": \"ip2location\",\n \"proxy_host\": \"192.168.1.100\",\n \"proxy_pass\": \"securePass123\",\n \"proxy_port\": \"1080\",\n \"proxy_type\": \"socks5\",\n \"proxy_user\": \"officeUser\",\n \"refresh_url\": \"http://192.168.1.100:1080/refresh\"\n },\n {\n \"remark\": \"Backup HTTP proxy\",\n \"ipchecker\": \"ipapi\",\n \"proxy_host\": \"203.0.113.45\",\n \"proxy_pass\": \"backupPass456\",\n \"proxy_port\": \"8080\",\n \"proxy_type\": \"http\",\n \"proxy_user\": \"backupUser\",\n \"refresh_url\": \"http://203.0.113.45:8080/refresh\"\n },\n {\n \"remark\": \"Public HTTPS proxy\",\n \"ipchecker\": \"ip2location\",\n \"proxy_host\": \"198.51.100.22\",\n \"proxy_pass\": \"publicPass789\",\n \"proxy_port\": \"443\",\n \"proxy_type\": \"https\",\n \"proxy_user\": \"publicUser\",\n \"refresh_url\": \"https://198.51.100.22:443/refresh\"\n },\n {\n \"remark\": \"Duplicate proxy entry\",\n \"ipchecker\": \"ipapi\",\n \"proxy_host\": \"192.168.1.100\",\n \"proxy_pass\": \"securePass123\",\n \"proxy_port\": \"1080\",\n \"proxy_type\": \"socks5\",\n \"proxy_user\": \"officeUser\",\n \"refresh_url\": \"http://192.168.1.100:1080/refresh\"\n }\n ]\n}") .asString(); ``` ```php Proxies_Add proxies_example request('POST', 'http://127.0.0.1:58931/api/proxies', [ 'body' => '{ "proxies": [ { "remark": "Office SOCKS5 proxy", "ipchecker": "ip2location", "proxy_host": "192.168.1.100", "proxy_pass": "securePass123", "proxy_port": "1080", "proxy_type": "socks5", "proxy_user": "officeUser", "refresh_url": "http://192.168.1.100:1080/refresh" }, { "remark": "Backup HTTP proxy", "ipchecker": "ipapi", "proxy_host": "203.0.113.45", "proxy_pass": "backupPass456", "proxy_port": "8080", "proxy_type": "http", "proxy_user": "backupUser", "refresh_url": "http://203.0.113.45:8080/refresh" }, { "remark": "Public HTTPS proxy", "ipchecker": "ip2location", "proxy_host": "198.51.100.22", "proxy_pass": "publicPass789", "proxy_port": "443", "proxy_type": "https", "proxy_user": "publicUser", "refresh_url": "https://198.51.100.22:443/refresh" }, { "remark": "Duplicate proxy entry", "ipchecker": "ipapi", "proxy_host": "192.168.1.100", "proxy_pass": "securePass123", "proxy_port": "1080", "proxy_type": "socks5", "proxy_user": "officeUser", "refresh_url": "http://192.168.1.100:1080/refresh" } ] }', 'headers' => [ 'Content-Type' => 'application/json', 'X-API-Key' => '', ], ]); echo $response->getBody(); ``` ```csharp Proxies_Add proxies_example using RestSharp; var client = new RestClient("http://127.0.0.1:58931/api/proxies"); var request = new RestRequest(Method.POST); request.AddHeader("X-API-Key", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"proxies\": [\n {\n \"remark\": \"Office SOCKS5 proxy\",\n \"ipchecker\": \"ip2location\",\n \"proxy_host\": \"192.168.1.100\",\n \"proxy_pass\": \"securePass123\",\n \"proxy_port\": \"1080\",\n \"proxy_type\": \"socks5\",\n \"proxy_user\": \"officeUser\",\n \"refresh_url\": \"http://192.168.1.100:1080/refresh\"\n },\n {\n \"remark\": \"Backup HTTP proxy\",\n \"ipchecker\": \"ipapi\",\n \"proxy_host\": \"203.0.113.45\",\n \"proxy_pass\": \"backupPass456\",\n \"proxy_port\": \"8080\",\n \"proxy_type\": \"http\",\n \"proxy_user\": \"backupUser\",\n \"refresh_url\": \"http://203.0.113.45:8080/refresh\"\n },\n {\n \"remark\": \"Public HTTPS proxy\",\n \"ipchecker\": \"ip2location\",\n \"proxy_host\": \"198.51.100.22\",\n \"proxy_pass\": \"publicPass789\",\n \"proxy_port\": \"443\",\n \"proxy_type\": \"https\",\n \"proxy_user\": \"publicUser\",\n \"refresh_url\": \"https://198.51.100.22:443/refresh\"\n },\n {\n \"remark\": \"Duplicate proxy entry\",\n \"ipchecker\": \"ipapi\",\n \"proxy_host\": \"192.168.1.100\",\n \"proxy_pass\": \"securePass123\",\n \"proxy_port\": \"1080\",\n \"proxy_type\": \"socks5\",\n \"proxy_user\": \"officeUser\",\n \"refresh_url\": \"http://192.168.1.100:1080/refresh\"\n }\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Proxies_Add proxies_example import Foundation let headers = [ "X-API-Key": "", "Content-Type": "application/json" ] let parameters = ["proxies": [ [ "remark": "Office SOCKS5 proxy", "ipchecker": "ip2location", "proxy_host": "192.168.1.100", "proxy_pass": "securePass123", "proxy_port": "1080", "proxy_type": "socks5", "proxy_user": "officeUser", "refresh_url": "http://192.168.1.100:1080/refresh" ], [ "remark": "Backup HTTP proxy", "ipchecker": "ipapi", "proxy_host": "203.0.113.45", "proxy_pass": "backupPass456", "proxy_port": "8080", "proxy_type": "http", "proxy_user": "backupUser", "refresh_url": "http://203.0.113.45:8080/refresh" ], [ "remark": "Public HTTPS proxy", "ipchecker": "ip2location", "proxy_host": "198.51.100.22", "proxy_pass": "publicPass789", "proxy_port": "443", "proxy_type": "https", "proxy_user": "publicUser", "refresh_url": "https://198.51.100.22:443/refresh" ], [ "remark": "Duplicate proxy entry", "ipchecker": "ipapi", "proxy_host": "192.168.1.100", "proxy_pass": "securePass123", "proxy_port": "1080", "proxy_type": "socks5", "proxy_user": "officeUser", "refresh_url": "http://192.168.1.100:1080/refresh" ] ]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "http://127.0.0.1:58931/api/proxies")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```