API Documentation
Proxies API
Request URL:
https://ipbot.com/api/proxies
Request JSON object for retrieving proxies:
POST { action: "list", endpointAuthentication: { id: ORDER_ID password: "ENDPOINT_PASSWORD", table: "orders", username: "ENDPOINT_USERNAME" }, table: "proxies" }
Response JSON object:
{ data: { proxies: { count: 100, data: [ { asn: "AS88888 ISP Communications", automaticReplacementIntervalType: "month", automaticReplacementIntervalValue: 1, city: "Ventura", countryCode: "US", countryName: "United States", id: 886, ip: "10.3.3.7", isp: "ISP Communications", nextReplacementAvailable: 2021-02-03 11:48:21, node_id: 189, order_id: ORDER_ID, password: "PROXY_PASSWORD", previousReplacementDate: 2021-01-27 11:48:21, region: "California", replacementRemovalDate: null, status: "online", transferAuthentication: false, userId: 1, username: "PROXY_USERNAME", whitelistedIps: "127.0.0.1 127.0.0.2" }, // .. ] } } }
Request JSON object for configuring proxy authentication settings:
POST { action: "authenticate", data: { generateUnique: false, items: [ 100, 101, // List of proxy IDs ], password: "NEW_PROXY_PASSWORD", username: "NEW_PROXY_USERNAME", whitelistedIps: [ "127.0.0.1", // .. ] }, endpointAuthentication: { id: ORDER_ID password: "ENDPOINT_PASSWORD", table: "orders", username: "ENDPOINT_USERNAME" }, table: "proxies" }
Response JSON object:
{ data: { proxies: { count: 10, data: [ { asn: "AS88888 ISP Communications", city: "Ventura", countryCode: "US", countryName: "United States", id: 886, ip: "10.3.3.7", isp: "ISP Communications", orderId: ORDER_ID, password: "NEW_PROXY_PASSWORD", region: "California", status: "online", transferAuthentication: false, userId: 1, username: "NEW_PROXY_USERNAME", whitelistedIps: "127.0.0.1 127.0.0.2" }, // .. ] } } }
Request JSON object for configuring proxy replacement settings:
POST { action: "replace", data: { automaticReplacementIntervalType: "week", // week|month automaticReplacementIntervalValue: 1, enableAutomaticReplacements: false, instantReplacement: true, items: [ 100, 101, // List of proxy IDs ], replacementCity: "Ventura", replacementCountryCode: "US", replacementRegion: "California", replaceWithSpecificNodeLocations: true, transferAuthentication: true }, endpointAuthentication: { id: ORDER_ID password: "ENDPOINT_PASSWORD", table: "orders", username: "ENDPOINT_USERNAME" }, table: "proxies" }
Response JSON object:
{ data: { proxies: { count: 7, data: [ { asn: "AS88888 ISP Communications", city: "Ventura", countryCode: "US", countryName: "United States", id: 886, ip: "10.3.3.7", isp: "ISP Communications", orderId: ORDER_ID, password: "PROXY_PASSWORD", region: "California", status: "replaced", transferAuthentication: false, userId: 1, username: "PROXY_USERNAME", whitelisted_ips: "127.0.0.1 127.0.0.2" }, // .. ] } } }
Orders API
Documentation in progress.
Servers API
Documentation in progress.