Endpoint:GET /api/zone/bw
curl "https://luminati.io/api/zone/bw" -u "username:password"
curl "https://luminati.io/api/zone/bw?customer=CUSTOMER&zone=ZONE&details=1" -H "X-Hola-Auth: lum-customer-CUSTOMER-zone-ZONE-key-PASSWORD"
details=1
Endpoint:GET /api/customer/bw
curl "https://luminati.io/api/customer/bw" -u "username:password"
curl "https://luminati.io/api/customer/bw?customer=CUSTOMER&details=1" -H "X-Hola-Auth: lum-customer-CUSTOMER-zone-ZONE-key-PASSWORD"
Endpoint:GET /api/zone/cost
curl "https://luminati.io/api/zone/cost" -u "username:password"
curl "https://luminati.io/api/zone/cost?customer=CUSTOMER&zone=ZONE" -H "X-Hola-Auth: lum-customer-CUSTOMER-zone-ZONE-key-PASSWORD"
Endpoint:GET /api/customer/req_logs
page=1&page_size=100
zone=&status.code=&status.message=&tun.session=
ts.from=&ts.to=&ua=&dst.host=&dst.url=
curl "https://luminati.io/api/customer/req_logs?customer=CUSTOMER" -u "username:password"
["request obj 1","request obj2"]
Endpoint:GET /api/customer/req_logs/stats
status_breakdown=1
zone=&status.code=&status.message=&tun.session=
ts.from=&ts.to=&ua=&dst.host=&dst.url=
curl "https://luminati.io/api/customer/req_logs/stats?customer=CUSTOMER" -u "username:password"
{"total":100,"success_statuses":99,"status_breakdown":[]}
Endpoint:GET /api/zone/count_available_ips
curl "https://luminati.io/api/zone/count_available_ips?customer=CUSTOMER&zone=ZONE[&plan={...}]" -u "username:password"
customer=CUSTOMER
[string] - your account id which you can get from your control panel (required)zone=ZONE
[string] - name of the Zone (required)plan={...}
[JSON object] - abstract plan parametersips_type=shared|selective
[string] - type of the IPscountry=country_name
[string] - IPs location countrycountry_city=country_name-city_name
[string] - defines the city location of the IPscity=true
[boolean] - requred with [country_city] parameterexclusive_sec=1234
[string] - cooling period in secondsdomain_whitelist=d1.com d2.com d3...
[string] - space separated list of domains. Note that for [curl] the spaces should be urlencoded (d1.com%20d2.com)geo_db={...}
[JSON object] - turns on/off using of the IP`s location databasesmaxmind=true
[boolean] - use this IP location DBdbip=true
[boolean] - use this IP location DBgoogle=true
[boolean] - use this IP location DBip2location=true
[boolean] - use this IP location DB{count: 1234}
curl "https://luminati.io/api/count_available_ips?customer=CUSTOMER&zone=ZONE" -u "username:password"
curl "https://luminati.io/api/count_available_ips?customer=CUSTOMER&zone=ZONE&plan=\{\"ips_type\":\"selective\"\}" -u "username:password"
curl "https://luminati.io/api/count_available_ips?customer=CUSTOMER&zone=ZONE&plan=\{\"country\":\"us\",\"ips_type\":\"shared\"\}" -u "username:password"
curl "https://luminati.io/api/count_available_ips?customer=CUSTOMER&zone=ZONE&plan=\{\"country\":\"us\",\"ips_type\":\"selective\"\}" -u "username:password"
curl "https://luminati.io/api/count_available_ips?customer=CUSTOMER&zone=ZONE&plan=\{\"country\":\"us\",\"ips_type\":\"selective\",\"exclusive_sec\":864000\}" -u "username:password"
curl "https://luminati.io/api/count_available_ips?customer=CUSTOMER&zone=ZONE&plan=\{\"ips_type\":\"shared\",\"country_city\":\"us-denver\",\"city\":true\}" -u "username:password"
curl "https://luminati.io/api/count_available_ips?customer=CUSTOMER&zone=ZONE&plan=\{\"ips_type\":\"selective\",\"country\":\"us\",\"domain_whitelist\":\"amazon.com fb.com\"\}" -u "username:password"
curl "https://luminati.io/api/count_available_ips?customer=CUSTOMER&zone=ZONE&plan=\{\"ips_type\":\"shared\"\},\"country\":\"us\",\"geo_db\":\{\"maxmind\":true,\"dbip\":true\}" -u "username:password"
Endpoint:GET /api/zone/recent_ips
curl "https://luminati.io/api/zone/recent_ips?customer=CUSTOMER&zones=ZONE" -u "username:password"
curl "https://luminati.io/api/zone/recent_ips" -H "X-Hola-Auth: lum-customer-CUSTOMER-zone-ZONE-key-PASSWORD"
{"ZONE":["255.0.0.127","10.0.0.1"]}
Endpoint:GET /api/zone/recent_ips
curl "https://luminati.io/api/zone/recent_ips?customer=CUSTOMER&zones=*" -u "username:password"
{"ZONE_1":["255.0.0.127","10.0.0.1"],"ZONE_2":["255.0.0.127","10.0.0.1"]}
Endpoint:GET /api/zone/route_ips
curl "https://luminati.io/api/zone/route_ips?customer=CUSTOMER&zone=ZONE&country=COUNTRY" -u "username:password"
curl "https://luminati.io/api/zone/route_ips" -H "X-Hola-Auth: lum-customer-CUSTOMER-zone-ZONE-key-PASSWORD-country-COUNTRY"
10.0.0.0/24
Endpoint:GET /api/zone/route_ips
curl "https://luminati.io/api/zone/route_ips?customer=CUSTOMER&zone=ZONE" -u "username:password"
curl "https://luminati.io/api/zone/route_ips" -H "X-Hola-Auth: lum-customer-CUSTOMER-zone-ZONE-key-PASSWORD"
11.0.0.1-11.0.0.8
Endpoint:GET /api/zone/route_vips
curl "https://luminati.io/api/zone/route_vips?customer=CUSTOMER&zone=ZONE" -u "username:password"
curl "https://luminati.io/api/zone/route_vips" -H "X-Hola-Auth: lum-customer-CUSTOMER-zone-ZONE-key-PASSWORD"
["us_7922_fl_hollywood_0","ma_36903_01_tetouan_5","br_52894_mg_montesclaros_99","tr_9121_07_antalya_10"]
Endpoint:GET /api/customer/balance
curl "https://luminati.io/api/customer/balance?customer=CUSTOMER" -u "username:password"
{"balance":456,"pending_costs":123}
Endpoint:GET /api/zone
curl "https://luminati.io/api/zone?customer=CUSTOMER&zone=ZONE" -u "username:password"
curl "https://luminati.io/api/zone" -H "X-Hola-Auth: lum-customer-CUSTOMER-zone-ZONE-key-PASSWORD"
{"ips":"any","password":["PASSWORD"],"plans":[{"start":"2019-07-15T18:08:59.269Z","type":"static","ips_type":"shared","ip_alloc_preset":"shared_block","bandwidth":"payperusage"}]}
Endpoint:POST /api/zone
name
(required), ips
(whitelist) andpassword
(string or array for multiple passwords).curl -X POST "https://luminati.io/api/zone" -H "Content-Type: application/json" -d '{"zone":{"name":"zone291231237"},"customer":"test_user","plan":{"type":"static|resident","ips_type":"shared|dedicated|selective","ip_alloc_preset":"shared_block","bandwidth":"payperusage|unlimited","mobile":false,"city":false,"asn":false,"vip":false,"vips_type":"shared|vip|domain|domain_p","vips":0,"domain_whitelist":"test.com fb.com","not_country":null,"vip_country":"any","exclusive_sec":0,"exclusive_type":"days","exclusive_num":0,"ips":0}}' -u "username:password"
{"plan":{"start":"2019-07-15T18:08:59.269Z","type":"static","ips_type":"shared","ip_alloc_preset":"shared_block","bandwidth":"payperusage"},"zone":{"ips":"any","password":["PASSWORD"],"plans":[{"start":"2019-07-15T18:08:59.269Z","type":"static","ips_type":"shared","ip_alloc_preset":"shared_block","bandwidth":"payperusage"}]}}
Endpoint:DELETE /api/zone
curl -X DELETE "https://luminati.io/api/zone" -H "Content-Type: application/json" -d '{"customer":"CUSTOMER","zone":"ZONE"}' -u "username:password"
Endpoint:GET /api/zone/passwords
curl "https://luminati.io/api/zone/passwords?customer=CUSTOMER&zone=ZONE" -u "username:password"
curl "https://luminati.io/api/zone/passwords" -H "X-Hola-Auth: lum-customer-CUSTOMER-zone-ZONE-key-PASSWORD"
{"passwords":["psw1","psw2"]}
Endpoint:GET /api/zone/permissions
curl "https://luminati.io/api/zone/permissions?customer=CUSTOMER&zone=ZONE" -u "username:password"
curl "https://luminati.io/api/zone/permissions" -H "X-Hola-Auth: lum-customer-CUSTOMER-zone-ZONE-key-PASSWORD"
{"perms":["city","google"]}
Endpoint:GET /api/zone/status
curl "https://luminati.io/api/zone/status?customer=CUSTOMER&zone=ZONE" -u "username:password"
curl "https://luminati.io/api/zone/status" -H "X-Hola-Auth: lum-customer-CUSTOMER-zone-ZONE-key-PASSWORD"
{"status":"active"}
Endpoint:GET /api/zone/ips
curl "https://luminati.io/api/zone/ips?customer=CUSTOMER&zone=ZONE" -u "username:password"
curl "https://luminati.io/api/zone/ips" -H "X-Hola-Auth: lum-customer-CUSTOMER-zone-ZONE-key-PASSWORD"
{"ips":[{"ip":"1.1.1.1","maxmind":"au","ext":{"dbip":"au","ip2location":"au","google":"us"}},{"ip":"1.1.1.1","maxmind":"au","ext":{"dbip":"au","ip2location":"au","google":"us"}}]}
Endpoint:POST /api/zone/ips
us
)us-chicago
)curl -X POST "https://luminati.io/api/zone/ips" -H "Content-Type: application/json" -d '{"customer":"CUSTOMER","zone":"ZONE","count":2}' -u "username:password"
{"ips":["1.1.1.1","1.1.1.2"],"new_ips":["1.1.1.1"]}
Endpoint:DELETE /api/zone/ips
curl -X DELETE "https://luminati.io/api/zone/ips" -H "Content-Type: application/json" -d '{"customer":"CUSTOMER","zone":"ZONE","ips":["ip1","ip2"]}' -u "username:password"
{"ips":["ip1","ip2"]}
Endpoint:DELETE /api/zone/vips
curl -X DELETE "https://luminati.io/api/zone/vips" -H "Content-Type: application/json" -d '{"customer":"CUSTOMER","zone":"ZONE","vips":["vip1","vip2"]}' -u "username:password"
{"vips":["us_7922_fl_hollywood_0","ma_36903_01_tetouan_0"]}
Endpoint:POST /api/zone/ips/refresh
curl -X POST "https://luminati.io/api/zone/ips/refresh" -H "Content-Type: application/json" -d '{"customer":"CUSTOMER","zone":"ZONE","vips":["vip1","vip2"]}' -u "username:password"
{"vips":[{"vip":"tr_9121_07_antalya_10","country":"tr"},{"vip":"tr_9121_07_antalya_17","country":"tr"}]}
Endpoint:POST /api/zone/ips/refresh
us
)us-chicago
)curl -X POST "https://luminati.io/api/zone/ips/refresh" -H "Content-Type: application/json" -d '{"customer":"CUSTOMER","zone":"ZONE","ips":["ip1","ip2"]}' -u "username:password"
{"ips":["1.1.1.1","1.1.1.2"],"new_ips":["1.1.1.1"]}
Endpoint:GET /api/get_peers
curl "https://luminati.io/api/get_peers" -u "username:password"
Endpoint:POST /api/zone/domain_perm
TYPE
can bewhitelist
or blacklist
.curl -X POST "https://luminati.io/api/zone/domain_perm" -H "Content-Type: application/json" -d '{"customer":"CUSTOMER","zone":"ZONE","type":"TYPE","domain":"example.org"}' -u "username:password"
{"whitelist":["test.com","example.org"]}
Endpoint:DELETE /api/zone/domain_perm
TYPE
can bewhitelist
or blacklist
.curl -X DELETE "https://luminati.io/api/zone/domain_perm" -H "Content-Type: application/json" -d '{"customer":"CUSTOMER","zone":"ZONE","type":"TYPE","domain":"test.com"}' -u "username:password"
{"whitelist":["example.org"]}
Endpoint:POST /api/zone/change_disable
curl -X POST "https://luminati.io/api/zone/change_disable" -H "Content-Type: application/json" -d '{"customer":"CUSTOMER","zone":"ZONE","disable":1}' -u "username:password"
Endpoint:GET /api/status
curl "https://luminati.io/api/status?customer=CUSTOMER" -u "username:password"
curl "https://luminati.io/api/status" -H "X-Hola-Auth: lum-customer-CUSTOMER-zone-ZONE-key-PASSWORD"
{"status":"active"}
Endpoint:PUT /api/status
curl -X PUT "https://luminati.io/api/status" -H "Content-Type: application/json" -d '{"customer":"CUSTOMER","status":"STATUS"}' -u "username:password"
STATUS
can besuspend_manual
or active
.Endpoint:GET /api/zone/whitelist
curl "https://luminati.io/api/zone/whitelist?customer=CUSTOMER&zones=ZONE" -u "username:password"
curl "https://luminati.io/api/zone/whitelist" -H "X-Hola-Auth: lum-customer-CUSTOMER-zone-ZONE-key-PASSWORD"
{"ZONE":["any","127.0.0.1"]}
Endpoint:GET /api/zone/whitelist
curl "https://luminati.io/api/zone/whitelist?customer=CUSTOMER&zones=*" -u "username:password"
{"ZONE1":["any","127.0.0.1"],"ZONE2":["any"]}
Endpoint:POST /api/zone/whitelist
curl -X POST "https://luminati.io/api/zone/whitelist" -H "Content-Type: application/json" -d '{"customer":"CUSTOMER","zone":"ZONE","ip":"1.2.1.2"}' -u "username:password"
Endpoint:DELETE /api/zone/whitelist
curl -X DELETE "https://luminati.io/api/zone/whitelist" -H "Content-Type: application/json" -d '{"customer":"CUSTOMER","zone":"ZONE","ip":"1.2.1.2"}' -u "username:password"
Endpoint:GET /api/network_status/NETWORK_TYPE
curl "https://luminati.io/api/network_status/NETWORK_TYPE" -u "username:password"
NETWORK_TYPE
can be one of:all
res
dc
mobile
{"status":true}
Endpoint:GET /api/cities
curl "https://luminati.io/api/cities?country=US" -u "username:password"
All API examples for account management are presented using Shell but can be used in a variety of coding languages.
To find all available coding languages check out the Account management section of our API and examples page