Lista de permissões de IP (RESTful)

Saiba mais sobre o gerenciamento da lista de permissões de IP do seu Dedicated ISP Proxy via API RESTful, incluindo endpoints para visualizar, adicionar e remover IPs.

Adicione IPs à lista de permissões enviando consultas diretamente para nossos endpoints.

Observe que há um tempo de espera de 5 minutos para confirmar alterações na sua lista de IPs permitidos.

Obtendo lista de IPs permitidos

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

Resposta	Descrição
200	Sucesso. O corpo da resposta contém todos os IPs atualmente na lista de permissões e seus IDs.

Exemplo de código

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

Saída de exemplo

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

Adicionando um IP permitidos

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

Resposta	Descrição
201	Sucesso. O endereço IP foi adicionado à lista. O corpo da resposta contém o novo endereço e id.
422	Erro. O corpo da requisição contém um endereço IP inválido. O corpo da resposta contém a mensagem de erro

Exemplo de código

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

Saída de exemplo

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

Removendo um IP permitido

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

Parâmetro	Descrição
id	A URL id do endereço IP que você deseja excluir (você pode obtê-lo no endpoint GET de IPs permitidos)

Resposta	Descrição
204	Sucesso. O endereço IP foi removido da lista. O corpo da resposta está vazio.
403	Erro. A solicitação contém um id. O corpo da resposta contém a mensagem de erro "Access Denied".

Exemplos de código

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

Salvando alterações (cooldown de 5 min)

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

Resposta	Descrição
202	Sucesso. As alterações na sua lista de IPs permitidos foram confirmadas. O corpo da resposta está vazio.
429	Erro. As alterações não foram confirmadas; o endpoint está em cooldown de 5 minutos. O corpo da resposta contém a mensagem de erro "You have exceeded the rate limit for the endpoint. Please try again later"

Exemplos de código

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