API - Documentation


API

AirProxy REST API

Data return is either plain text for success or JSON data when there is a data return. API consumer_key and consumer_secret is required as username and password as basic authentication in the header. Corresponding proxy id can be found in ID column of the Get Proxies API return. Alternatively id can be created as ip:port, base64 encoded.




GET /API/get_proxies
Returns a JSON array of your active proxies.
This request is authenticated and requires your consumer key and consumer secret


Response Examples

Success:


"id":"aXAub21ncHJveHkuY29tOjEyMzQ",
"ip":"ip.omgproxy.com",
"port":"1234",
"socks_port":"5678",
"username":"username",
"password":"password",
"local_proxy":"192.168.0.1:1234",
"whitelist_ip":"127.0.0.1",
"change_time":"20",
"remaining":3

Failed:

Access Denied



GET /API/get_status/{id}
Gets the current status of the proxy provided in URL.
Returns JSON array of the the proxy status


Request parameters:


  • Consumer Key (Basic Header Authentication) (required)
  • Consumer Secret (Basic Header Authentication)(required)
  • id (Base64 encoded ip:port) (required)

Response Examples

Success


"msg":"CONNECTED",
"status":true

Failed


Access Denied



GET /API/rotate_interval/{id}/{interval}
Change IP rotating interval for proxy.
Returns success or Access Denied


Request parameters:


  • Consumer Key (Basic Header Authentication) (required)
  • Consumer Secret (Basic Header Authentication)(required)
  • id (Base64 encoded ip:port) (required)
  • interval (Time in minutes) (required)

Response Examples

Success


success

Failed


Access Denied



GET /API/rotate_proxy/{id}
Reset proxy to force an IP change.
Returns success or Access Denied


Request parameters:


  • Consumer Key (Basic Header Authentication) (required)
  • Consumer Secret (Basic Header Authentication)(required)
  • id (Base64 encoded ip:port) (required)

Response Examples

Success


success

Failed


Access Denied



GET /API/reboot_proxy/{id}
Reboot Proxy Node
Returns success or Access Denied


Request parameters:


  • Consumer Key (Basic Header Authentication) (required)
  • Consumer Secret (Basic Header Authentication)(required)
  • id (Base64 encoded ip:port) (required)

Response Examples

Success


success

Failed


Access Denied