Whitelisting IPs (RESTful)

Learn about managing your Dedicated ISP Proxy IP whitelist via the RESTful API, including endpoints for viewing, adding, and removing IPs.

Whitelist IPs by sending queries directly to our endpoints.

Please note there is a 5-minute cooldown to confirm changes to your whitelisted IP list.

Getting Whitelisted IPs List

GET https://api.oxylabs.io/v1/whitelisted_ips

Response	Description
200	Success. Response body contains all currently whitelisted IPs and their ids.

Code example

cURL

curl -u username:password "https://api.oxylabs.io/v1/whitelisted_ips"

PHP

<?php
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://api.oxylabs.io/v1/whitelisted_ips");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_USERPWD, 'username:password');

$result = curl_exec($curl);
?>

Python

import requests
requests.get('https://api.oxylabs.io/v1/whitelisted_ips', auth=('username', 'password'))

Sample output

{
    "data": [
        {
            "id": 9765,
            "address": "127.0.0.1"
        },
        {
            "id": 9766,
            "address": "127.0.0.2"
        }
    ]
}

Adding a Whitelisted IP

POST https://api.oxylabs.io/v1/whitelisted_ips

Response	Description
201	Success. The IP address has been added to the list. Response body contains the newly added address and id.
422	Error. Request body contains an invalid IP address. Response body contains the error message

Code example

cURL

curl -X POST -u username:password "https://api.oxylabs.io/v1/whitelisted_ips"
--header "Content-Type: application/json" --data '{"address": "127.0.0.1"}'

PHP

<?php
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://api.oxylabs.io/v1/whitelisted_ips");
$payload = json_encode( array( "address"=> "127.0.0.1" ) );
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $payload);
curl_setopt( $curl, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_USERPWD, 'username:password');

$result = curl_exec($curl);
?>

Python

import requests
requests.post('https://api.oxylabs.io/v1/whitelisted_ips',
              json={"address": "127.0.0.1"},
              auth=('username', 'password'))

{
    "error": {
        "message": "This is not a valid IP address.",
        "code": 422
    }
}

Sample output

{
    "id": 9767,
    "address": "127.0.0.1"
}

Removing a Whitelisted IP

DELETE https://api.oxylabs.io/v1/whitelisted_ips/{id}

Parameter	Description
id	The id of the IP address you want to delete (you can get it from GET whitelisted IPs endpoint)

Response	Description
204	Success. The IP address has been removed from the list. Response body is empty.
403	Error. Request contains an invalid id. Response body contains the error message "Access Denied".

Code examples

cURL

curl -X DELETE -u username:password "https://api.oxylabs.io/v1/whitelisted_ips/{id}"

PHP

<?php
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://api.oxylabs.io/v1/whitelisted_ips/{id}');
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_USERPWD, 'username:password');
$result = curl_exec($curl);
?>

Python

import requests
requests.delete('https://api.oxylabs.io/v1/whitelisted_ips/{id}', auth=('username', 'password'))

Saving Changes (5min Cooldown)

POST https://api.oxylabs.io/v1/whitelisted_ips/upload_to_servers

Response	Description
202	Success. Changes to your whitelisted IP list have been confirmed. Response body is empty.
429	Error. Changes have not been confirmed, the endpoint is on a 5 minute cooldown. Response body contains the error message "You have exceeded the rate limit for the endpoint. Please try again later"

Code examples

cURL

curl -X POST -u username:password "https://api.oxylabs.io/v1/whitelisted_ips/upload_to_servers"

PHP

<?php
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://api.oxylabs.io/v1/whitelisted_ips/upload_to_servers");
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_USERPWD, 'username:password');

$result = curl_exec($curl);
?>

Python

import requests
requests.post("https://api.oxylabs.io/v1/whitelisted_ips/upload_to_servers", auth=('username', 'password'))