Proxy Manager API

  • Get Proxy Manager version

    API endpoint: GET /api/version Sample Response: {"version":"1.280.385","argv":""}   Shell curl "http://127.0.0.1:22999/api/version" Node.js #!/usr/bin/env node require('request-promise')({ url: 'http://127.0.0.1:22999/api/version'...

  • Get latest Proxy Manager versions

    API endpoint: GET /api/last_version Sample Response: {"version": "1.280.385","newer": false,"versions": [{"ver": "1.280.385","type": "stable","changes": [{"type": "star","text": "Add render option for unblocker and serp zones"}]}]}...

  • Get currently running NodeJS version

    API endpoint: GET /api/node_version Sample Response: {"current":{"options":{"loose":false,"includePrerelease":false},"loose":false,"raw":"v12.16.1\n","major":12,"minor":16,"patch":1,"prerelease":[],"build":[],"version":"12.16.1"},"...

  • Generate token for token based authentication

    API endpoint: GET /api/gen_token Sample Response: {"token":"RZD9vaQQaL6En7"}   Shell curl "http://127.0.0.1:22999/api/gen_token" Node.js #!/usr/bin/env node require('request-promise')({ url: 'http://127.0.0.1:22999/api/gen_token' ...

  • Whitelist IPs

    API endpoint: POST /api/add_wip Authorization: TOKEN - Token should be generated using Generate token API POST body ip="1.2.1.2"   Shell curl "http://127.0.0.1:22999/api/add_wip" -H "Authorization: TOKEN" -H "Content-Type: app...

  • Whitelist IPs to access UI

    API endpoint: POST /api/add_whitelist_ip POST body ip="1.2.1.2"   Shell curl "http://127.0.0.1:22999/api/add_whitelist_ip" -H "Content-Type: application/json" -d "{\"ip\":\"1.2.1.2\"}" Node.js #!/usr/bin/env node require('requ...

  • Get explicit configuration of all or specified proxies

    API endpoint: GET /api/proxies/{PORT}*Note : PORT parameter is optional. You can skip it to fetch all the proxies Sample Response: [{"port":24000,"zone":"ZONE","proxy_type":"persist","customer":"CUSTOMER","password":"PASSWORD","whi...

  • Create a new proxy port

    API endpoint: POST /api/proxies POST body proxy [JSON object] port [integer] - Port for the HTTP proxy proxy_type=persist[string] - Set to "persist" to save proxy into the configuration file. multiply[integer] - Multiply the por...

  • Delete proxy ports

    API endpoint: POST /api/proxies/delete POST body ports=[24000,24001] [array]   Shell curl "http://127.0.0.1:22999/api/proxies/delete" -H "Content-Type: application/json" -d "{\"ports\":[24000,24001]}" Node.js #!/usr/bin/env no...

  • Delete a proxy port

    API endpoint: DELETE /api/proxies/{PORT}*PORT : existing proxy port number   Shell curl -X DELETE "http://127.0.0.1:22999/api/proxies/{PORT}" Node.js #!/usr/bin/env node require('request-promise')({ method: 'DELETE', url: 'http:/...

  • Update a proxy port

    API endpoint: PUT /api/proxies/{PORT}*PORT : existing proxy port number PUT Body: See params in Create a new proxy port API Sample Response: {"port":24000,"zone":"ZONE","proxy_type":"persist","customer":"CUSTOMER","password":"PASSW...

  • Get effective configuration for all running proxies

    API endpoint: GET /api/proxies_running Sample Response: [{"port":24000,"zone":"ZONE","proxy_type":"persist","customer":"CUSTOMER","password":"PASSWORD","whitelist_ips":[]}]   Shell curl "http://127.0.0.1:22999/api/proxies_running" ...

  • Get recent stats

    API endpoint: GET /api/recent_stats Sample Response: {"ports":{},"status_code":[],"hostname":[],"protocol":[],"total":0,"success":0,"ssl_enable":true}   Shell curl "http://127.0.0.1:22999/api/recent_stats" Node.js #!/usr/bin/env no...

  • Get proxy port status

    API endpoint: GET /api/proxy_status/{PORT}*PORT : existing proxy port number Sample Response: {"status":"ok","status_details":[]}   Shell curl "http://127.0.0.1:22999/api/proxy_status/{PORT}" Node.js #!/usr/bin/env node require('re...

  • Ban an IP (single)

    API endpoint: POST /api/proxies/{PORT}/banip*PORT : existing proxy port number POST body Required : ip="1.2.1.2" [string] - IP to ban Optional : domain="example.com" [string] - Ban the IP for sending requests to the specified do...

  • Ban IPs (array)

    API endpoint: POST /api/proxies/{PORT}/banips*PORT : existing proxy port number POST body Required : ips=["10.0.0.1","20.0.0.1"] [array] - IPs to ban Optional : domain="example.com" [string] - Ban the IP for sending requests to ...

  • Unban an IP

    API endpoint: POST /api/proxies/{PORT}/unbanip*PORT : existing proxy port number POST body Required : ip="1.2.1.2" [string] - IP to unban Optional : domain="example.com" [string] - Unban the IP for sending requests to the specif...

  • Unban IPs

    API endpoint: POST /api/proxies/{PORT}/unbanips*PORT : existing proxy port number   Shell curl "http://127.0.0.1:22999/api/proxies/{PORT}/unbanips" Node.js #!/usr/bin/env node require('request-promise')({ method: 'POST', url: 'ht...

  • Ban an IP for all ports

    API endpoint: POST /api/banip POST body Required : ip="1.2.1.2" [string] - IP to ban Optional : domain="example.com" [string] - Ban the IP for sending requests to the specified domain ms=60000 [number] - Ban the IP for specifie...

  • Refresh Proxy Manager port sessions

    API endpoint: GET /api/refresh_sessions/{PORT}*PORT : existing proxy port number   Shell curl "http://127.0.0.1:22999/api/refresh_sessions/{PORT}" Node.js #!/usr/bin/env node require('request-promise')({ url: 'http://127.0.0.1:22...

  • Get general settings

    API endpoint: GET /api/settings Sample Response: {"customer":"CUSTOMER","zone":"ZONE","password":"PASSWORD","www_whitelist_ips":[],"whitelist_ips":[],"fixed_whitelist_ips":[],"read_only":false,"config":"/home/user/proxy_manager/.lu...

  • Update general settings

    API endpoint: PUT /api/settings PUT Body: zone [string] - Default zone www_whitelist_ips [array] - Whitelist ip list for granting access to browser admin UI whitelist_ips [array] - Default for all proxies whitelist ip list for gra...

  • Get enabled zones configuration

    API endpoint: GET /api/zones Sample Response: {"name":"ZONE","perm":"country ip route_all route_dedicated","plan":{},"password":"PASSWORD"}   Shell curl "http://127.0.0.1:22999/api/zones" Node.js #!/usr/bin/env node require('reques...

  • Get allocated IPs in zone

    API endpoint: GET /api/allocated_ips Parameter: zone - Static (Datacenter/ISP) zone name Sample Response: {"ips":["10.0.0.1","20.0.0.1"]}   Shell curl "http://127.0.0.1:22999/api/allocated_ips?zone=ZONE" Node.js #!/usr/bin/env node...

  • Get allocated gIPs in zone

    API endpoint: GET /api/allocated_vips Parameter: zone - Residential/Mobile exclusive zone name Sample Response: {"ips":["gIP_1","gIP_2"]}   Shell curl "http://127.0.0.1:22999/api/allocated_vips?zone=ZONE" Node.js #!/usr/bin/env nod...

  • Refresh IPs or gIPs in zone

    API endpoint: POST /api/refresh_ips POST body zone="ZONE" [string] - Zone name IP/gIP to refresh : one of following ips=["ip1","ip2"] [array] - Static IPs vips=["gip1","gip2"] [array] - gIPs Sample Response: {"ips":[{"ip":"10...

  • Enable SSL analyzing on all proxy ports

    API endpoint: POST /api/enable_ssl   Shell curl -X POST "http://127.0.0.1:22999/api/enable_ssl" Node.js #!/usr/bin/env node require('request-promise')({ method: 'POST', url: 'http://127.0.0.1:22999/api/enable_ssl' }).then(functio...

  • Shutdown Proxy Manager

    API endpoint: POST /api/shutdown   Shell curl -X POST "http://127.0.0.1:22999/api/shutdown" Node.js #!/usr/bin/env node require('request-promise')({ method: 'POST', url: 'http://127.0.0.1:22999/api/shutdown' }).then(function(data...

  • Restart Proxy Manager

    API endpoint: POST /api/restart   Shell curl -X POST "http://127.0.0.1:22999/api/restart" Node.js #!/usr/bin/env node require('request-promise')({ method: 'POST', url: 'http://127.0.0.1:22999/api/restart' }).then(function(data){ ...

  • Upgrade Proxy Manager

    API endpoint: POST /api/upgrade   Shell curl -X POST "http://127.0.0.1:22999/api/upgrade" Node.js #!/usr/bin/env node require('request-promise')({ method: 'POST', url: 'http://127.0.0.1:22999/api/upgrade' }).then(function(data){ ...