Subscriber IP Pools API
GET
/v1/pool(subscriber)
List IP Pools.
Service
subscriber
subscriber
Request Parameters
Name | In | Type | Description | MUST include |
---|---|---|---|---|
X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
X-Timezone | header | string | Timezone for response datetime property values. (default UTC) | |
page | query | integer | Page Number (default 1) |
Response Status Codes
Code | Meaning |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized / Require Authentication |
403 | Forbidden / Access Denied |
429 | Too Many Requests / Your Rate Limited |
500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
Name | In | Type | Description |
---|---|---|---|
available | body | integer | Number of available IPs in Pool |
id | body | string | Unique ID |
pool_name | body | string | Pool Name |
static | body | boolean | Are the IPs in the pool static |
status | body | string | Status |
total | body | integer | Total number of IPs in pool |
used | body | integer | Number of used IPs in pool |
Response Example
{
"links": {},
"payload": [
{
"id": "280f16cd-4bf2-45cf-8761-0f39b0262dc3",
"pool_name": "TEST",
"static": 0,
"status": "Ready",
"total": 65536,
"used": 0,
"available": 65536
},
{
"id": "4b2e21f7-4403-453f-b91b-430f353f1f23",
"pool_name": "TEST POOL",
"static": 0,
"status": "Ready",
"total": 0,
"used": 0,
"available": 0
}
],
"metadata": {
"records": 2,
"page": 1,
"pages": 1,
"per_page": 10,
"sort": null,
"search": [],
"filters": []
}
}
GET
/v1/pool/{pool_id}(subscriber)
Get one IP Pool.
Service
subscriber
subscriber
Request Parameters
Name | In | Type | Description | MUST include |
---|---|---|---|---|
X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
X-Timezone | header | string | Timezone for response datetime property values. (default UTC) | |
pool_id | url | string | Pool Id. | X |
page | query | integer | Page Number (default 1) |
Response Status Codes
Code | Meaning |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized / Require Authentication |
403 | Forbidden / Access Denied |
404 | Not Found |
429 | Too Many Requests / Your Rate Limited |
500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
Name | In | Type | Description |
---|---|---|---|
domain | body | string | Domain |
id | body | string | Unique ID |
pool_name | body | string | Pool Name |
static | body | boolean | Are the IPs in the pool static |
status | body | string | Status |
Response Example
{
"id": "4b2e21f7-4403-453f-b91b-430f353f1f23",
"domain": "interstellio.io",
"pool_name": "TEST POOL",
"status": "Ready",
"static": false,
"busy": false
}
POST
/v1/pool(subscriber)
Create IP Pool.
Service
subscriber
subscriber
Request Parameters
Name | In | Type | Description | MUST include |
---|---|---|---|---|
X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
X-Timezone | header | string | Timezone for response datetime property values. (default UTC) | |
page | query | integer | Page Number (default 1) | |
pool_name | body | string | Name Given to IP pool |
Response Status Codes
Code | Meaning |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized / Require Authentication |
403 | Forbidden / Access Denied |
429 | Too Many Requests / Your Rate Limited |
500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
Name | In | Type | Description |
---|---|---|---|
busy | body | boolean | Busy |
domain | body | string | Domain |
id | body | string | Unique ID |
pool_name | body | string | Pool Name |
static | body | boolean | static |
status | body | string | Status |
Response Example
{
"id": "8a101dff-e497-4930-9464-462f77d24c09",
"domain": "interstellio.io",
"pool_name": "API TEST POOL",
"status": "Ready",
"static": false,
"busy": false
}
PATCH
/v1/pool/{pool_id}(subscriber)
Update IP Pool.
Service
subscriber
subscriber
Request Parameters
Name | In | Type | Description | MUST include |
---|---|---|---|---|
X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
X-Timezone | header | string | Timezone for response datetime property values. (default UTC) | |
pool_id | url | string | Pool ID | X |
Response Status Codes
Code | Meaning |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized / Require Authentication |
403 | Forbidden / Access Denied |
404 | Not Found |
429 | Too Many Requests / Your Rate Limited |
500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
Name | In | Type | Description |
---|---|---|---|
id | body | string | Unique ID |
Response Example
{
"id": "8a101dff-e497-4930-9464-462f77d24c09",
"domain": "interstellio.io",
"pool_name": "API TEST POOL UPDATE",
"status": "Ready",
"static": false,
"busy": false
}
DELETE
/v1/pool/{pool_id}(subscriber)
Delete IP Pool.
Service
subscriber
subscriber
Request Parameters
Name | In | Type | Description | MUST include |
---|---|---|---|---|
X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
pool_id | url | string | Pool ID | X |
Response Status Codes
Code | Meaning |
---|---|
204 | OK - No Content |
400 | Bad Request |
401 | Unauthorized / Require Authentication |
403 | Forbidden / Access Denied |
404 | Not Found |
429 | Too Many Requests / Your Rate Limited |
500, 501, 502, 503, 504 | Service Unavailable |
GET
/v1/pool/{pool_id}/ips(subscriber)
Get IPs for a pool.
Service
subscriber
subscriber
Request Parameters
Name | In | Type | Description | MUST include |
---|---|---|---|---|
X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
X-Timezone | header | string | Timezone for response datetime property values. (default UTC) | |
pool_id | url | string | Pool ID | X |
page | query | integer | Page Number (default 1) |
Response Status Codes
Code | Meaning |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized / Require Authentication |
403 | Forbidden / Access Denied |
404 | Not Found |
429 | Too Many Requests / Your Rate Limited |
500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
Name | In | Type | Description |
---|---|---|---|
id | body | string | Unique ID of IP |
pool_id | body | string | Unique ID of IP POOL |
prefix | body | string | IP Prefix |
total | body | integer | Number of IPs |
Response Example
{
"links": {},
"payload": [
{
"id": "ca96f114-6835-11ee-9e95-0052af111173",
"pool_id": "280f16cd-4bf2-45cf-8761-0f39b0262dc3",
"prefix": "192.168.0.0/16",
"total": 65536
}
],
"metadata": {
"records": 1,
"page": 1,
"pages": 1,
"per_page": 10,
"sort": null,
"search": [],
"filters": []
}
}
DELETE
/v1/pool/{pool_id}/resync(subscriber)
Resync IP Pool.
Service
subscriber
subscriber
Request Parameters
Name | In | Type | Description | MUST include |
---|---|---|---|---|
X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
pool_id | url | string | Pool Id. | X |
Response Status Codes
Code | Meaning |
---|---|
204 | OK - No Content |
400 | Bad Request |
401 | Unauthorized / Require Authentication |
403 | Forbidden / Access Denied |
404 | Not Found |
429 | Too Many Requests / Your Rate Limited |
500, 501, 502, 503, 504 | Service Unavailable |
POST
/v1/pool/{pool_id}/add_prefix(subscriber)
Add Prefix.
Service
subscriber
subscriber
Request Parameters
Name | In | Type | Description | MUST include |
---|---|---|---|---|
X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
X-Timezone | header | string | Timezone for response datetime property values. (default UTC) | |
pool_id | url | string | Pool Id. | X |
Response Status Codes
Code | Meaning |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized / Require Authentication |
403 | Forbidden / Access Denied |
404 | Not Found |
429 | Too Many Requests / Your Rate Limited |
500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
Name | In | Type | Description |
---|---|---|---|
id | body | string | Unique ID |
Response Example
{
}
DELETE
/v1/pool/{pool_id}/rm_prefix/{prefix_id}(subscriber)
Remove prefix.
Service
subscriber
subscriber
Request Parameters
Name | In | Type | Description | MUST include |
---|---|---|---|---|
X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
pool_id | url | string | Pool Id. | X |
prefix_id | url | string | Prefix Id. | X |
page | query | integer | Page Number (default 1) |
Response Status Codes
Code | Meaning |
---|---|
204 | OK - No Content |
400 | Bad Request |
401 | Unauthorized / Require Authentication |
403 | Forbidden / Access Denied |
404 | Not Found |
429 | Too Many Requests / Your Rate Limited |
500, 501, 502, 503, 504 | Service Unavailable |