将 IP 加入白名单（RESTful）

了解如何通过 RESTful API 管理独享 ISP 代理 IP 白名单，包括用于查看、添加和删除 IP 的端点。

通过直接向我们的端点发送查询来将 IP 加入白名单。

请注意，确认对白名单 IP 列表的更改需要 5 分钟冷却时间。

获取白名单 IP 列表

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

响应	描述
200	成功。响应体包含当前所有已加入白名单的 IP 及其 ids。

代码示例

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'))

示例输出

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

添加白名单 IP

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

响应	描述
201	成功。IP 地址已添加到列表中。响应体包含新添加的 地址 和 ID.
422	错误。请求体包含无效的 IP 地址。响应体包含错误消息

代码示例

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
    }
}

示例输出

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

移除白名单 IP

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

参数	描述
ID	该 ID 要删除的 IP 地址的（可从 GET 白名单 IP 接口获取）

响应	描述
204	成功。该 IP 地址已从列表中移除。响应体为空。
403	错误。请求包含无效的 ID。响应体包含错误消息 "Access Denied"。

代码示例

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'))

保存更改（5 分钟冷却）

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

响应	描述
202	成功。对您的白名单 IP 列表的更改已确认。响应体为空。
429	错误。更改未被确认，该接口处于 5 分钟冷却期。响应体包含错误消息 "You have exceeded the rate limit for the endpoint. Please try again later"

代码示例

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'))