IP Skipping
The link provided below directs to a detailed page that elaborates on the concept of IP skipping within our system.
It's important to note that almost every endpoint related to IP skipping, with the notable exceptions of the index
and delete
endpoints, will return an IP skipping resource upon a successful call.
{
"hash": "01HQ5K3P97DY8EX9Y90YT1K6XA",
"title": "192.0.2.1",
"items": [
{
"hash": "01HQJ5GS1NXBP562CCQFQB6XN7",
"ip_range": "24.52.81.2/32"
},
{
"hash": "01HQJ5GW9NXBCC62CCQFQB6XN7",
"ip_range": "14.51.82.2/32"
}
]
}
Create IP Skipping List
POST
/residential-users/{
residential_user_hash}/ips-skipping
Query Parameters
residential_user_hash
String
Hash of the user
Body Parameters
title
String
Title of the IP skipping list
Example request:
curl -X POST "https://resi-api.iproyal.com/v1/residential-users/<residential_user_hash>/ips-skipping" \
-H "Authorization: Bearer <your_api_token>" \
-H "Content-Type: application/json" \
-d '{
"title": "Your Title"
}'
Example response:
{
"hash": "01HQ5K3P97DY8EX9Y90YT1K6XA",
"title": "Your Title",
"items": [
{
"hash": "01HQJ5GS1NXBP562CCQFQB6XN7",
"ip_range": "24.52.81.2/32"
},
{
"hash": "01HQJ5GW9NXBCC62CCQFQB6XN7",
"ip_range": "14.51.82.2/32"
}
]
}
Get IP Skipping Lists
GET
/residential-users/{
residential_user_hash}/ips-skipping
Query Parameters
residential_user_hash
String
Hash of the user
Example request:
curl -X GET "https://resi-api.iproyal.com/v1/residential-users/<residential_user_hash>/ips-skipping" \
-H "Authorization: Bearer <your_api_token>" \
-H "Content-Type: application/json"
Example response:
{
"data": [
{
"hash": "01HQ5K3P97DY8EX9Y90YT1K6XA",
"title": "Your Title",
"items": [
{
"hash": "01HQJ5GS1NXBP562CCQFQB6XN7",
"ip_range": "24.52.81.2/32"
},
{
"hash": "01HQJ5GW9NXBCC62CCQFQB6XN7",
"ip_range": "14.51.82.2/32"
}
]
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "/",
"per_page": 15,
"to": 1,
"total": 1
}
}
Update IP Skipping List
UPDATE
/residential-users/{
residential_user_hash}/ips-skipping/{
ips_skipping_hash}
Query Parameters
residential_user_hash
String
Hash of the user
ips_skipping_hash
String
Hash of the IPs skipping list
Body Parameters
title
String
Title of the skipping list
ip_ranges
Array
Ranges to be added to the list
Example request:
curl -X PUT "https://resi-api.iproyal.com/v1/residential-users/<residential_user_hash>/ips-skipping/<ips_skipping_hash>" \
-H "Authorization: Bearer <your_api_token>" \
-H "Content-Type: application/json" \
-d '{
"title": "New Title",
"ip_ranges": ["192.168.0.0/24", "10.0.0.0/8"]
}'
Example response:
{
"hash": "01HQ5K3P97DY8EX9Y90YT1K6XA",
"title": "New Title",
"items": [
{
"hash": "01HQJ5GS1NXBP562CCQFQB6XN7",
"ip_range": "192.168.0.0/24"
},
{
"hash": "01HQJ5GW9NXBCC62CCQFQB6XN7",
"ip_range": "10.0.0.0/8"
}
]
}
Delete IP Skipping List
DELETE
/residential-users/{
residential_user_hash}/ips-skipping/{
ips_skipping_hash}
Query Parameters
residential_user_hash
String
Hash of the user
ips_skipping_hash
String
Hash of the IPs skipping list
Example request:
curl -X DELETE "https://resi-api.iproyal.com/v1/residential-users/<residential_user_hash>/ips-skipping/<ips_skipping_hash>" \
-H "Authorization: Bearer <your_api_token>" \
-H "Content-Type: application/json"
Last updated