Subscriber Virtual Servers API
Virtual Servers
Reference material for usage on Subscriber > Virtual Servers.
List Virtual Servers.
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest 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) | |
id | query | string | Filter by id. (can suffix with wildcard *) | |
l | query | integer | Paginate Limit / Entities per Page. (1-50, 0 for infinite, -1 for streaming) | |
name | query | string | Filter by name. (can suffix with wildcard *) | |
p | query | integer | Paginate Current Page. (default 1) | |
sc | query | string | Sort by Property/Column. (id, name) | |
sd | query | string | Sort direction. asc for Ascending or desc for Descending |
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 |
---|---|---|---|
domain | body | string | Entity Domain. |
id | body | string | Unique Entity ID. |
metadata.page | body | integer | Current Page. (always 1 for infinite) |
metadata.pages | body | integer | Total Pages. (always 1 for infinite) |
metadata.per_page | body | integer | Equeal to the entities per page limit or always equal to total records for infinite queries. |
metadata.records | body | integer | Total entities found. (always max 250 unless infinite is accepted query parameter) |
name | body | string | Name of Entity. |
Response Example
{
"payload": [
{
"id": "0ba81d12-3202-4019-95b7-7d7e14f98703",
"domain": "interstellio.io",
"name": "TEST"
}
],
"metadata": {
"records": 1,
"page": 1,
"pages": 1,
"per_page": 10
}
}
Show Virtual Server Details.
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest 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) | |
virtual_id | url | string | Virtual 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 |
---|---|---|---|
domain | body | string | Entity Domain. |
id | body | string | Unique Entity ID. |
name | body | string | Name of Entity. |
Response Example
{
"id": "0ba81d12-3202-4019-95b7-7d7e14f98703",
"domain": "interstellio.io",
"name": "TEST"
}
Radius Clients
Client Profiles
Reference material for Client Profiles on Subscriber > Virtual Servers > Creating a new Client Profile
List Client Profiles.
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest 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) | |
id | query | string | Filter by id. (can suffix with wildcard *) | |
l | query | integer | Paginate Limit / Entities per Page. (1-50, 0 for infinite, -1 for streaming) | |
name | query | string | Filter by name. (can suffix with wildcard *) | |
p | query | integer | Paginate Current Page. (default 1) | |
sc | query | string | Sort by Property/Column. (id, name) | |
sd | query | string | Sort direction. asc for Ascending or desc for Descending |
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 |
---|---|---|---|
description | body | string | Description of Entity. |
domain | body | string | Entity Domain. |
id | body | string | Unique Entity ID. |
metadata.page | body | integer | Current Page. (always 1 for infinite) |
metadata.pages | body | integer | Total Pages. (always 1 for infinite) |
metadata.per_page | body | integer | Equeal to the entities per page limit or always equal to total records for infinite queries. |
metadata.records | body | integer | Total entities found. (always max 250 unless infinite is accepted query parameter) |
name | body | string | Name of Entity. |
Response Example
{
"payload": [
{
"id": "d3e14621-bac1-11ee-8769-525400bd8e3a",
"domain": "interstellio.io",
"name": "CISCO",
"description": "CISCO"
},
{
"id": "9bece11b-bc39-4672-bb8a-c94362a6b815",
"domain": "interstellio.io",
"name": "JUNIPER",
"description": "JUNIPER"
}
],
"metadata": {
"records": 2,
"page": 1,
"pages": 1,
"per_page": 10
}
}
Create Client Profile.
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest 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) | |
description | body | string | Description of Entity. | |
name | body | string | Name of Entity. | X |
Request Example
{
"name": "MIKROTIK",
"description": "MIKROTIK"
}
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 |
---|---|---|---|
description | body | string | Description of Entity. |
domain | body | string | Entity Domain. |
id | body | string | Unique Entity ID. |
name | body | string | Name of Entity. |
Response Example
{
"id": "9bece11b-bc39-4672-bb8a-c94362a6b815",
"domain": "interstellio.io",
"name": "MIKROTIK",
"description": "MIKROTIK"
}
Show Client Profile Details.
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest 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) | |
client_profile_id | url | string | Client Profile 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 |
---|---|---|---|
description | body | string | Description of Entity. |
domain | body | string | Entity Domain. |
id | body | string | Unique Entity ID. |
name | body | string | Name of Entity. |
Response Example
{
"id": "9bece11b-bc39-4672-bb8a-c94362a6b815",
"domain": "interstellio.io",
"name": "JUNIPER",
"description": "JUNIPER"
}
Update Client Profile.
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest 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) | |
client_profile_id | url | string | Client Profile Id. | X |
Request Example
{
"name": "NEW_NAME",
"description": "NEW DESCRIPTION"
}
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 |
---|---|---|---|
description | body | string | Description of Entity. |
domain | body | string | Entity Domain. |
id | body | string | Unique Entity ID. |
name | body | string | Name of Entity. |
Response Example
{
"id": "9bece11b-bc39-4672-bb8a-c94362a6b815",
"domain": "interstellio.io",
"name": "NEW_NAME",
"description": "NEW DESCRIPTION"
}
Delete Client Profile.
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest Parameters
Name | In | Type | Description | MUST include |
---|---|---|---|---|
X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
client_profile_id | url | string | Client Profile 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 |
Radius Clients
Reference material for Radius Clients on Subscriber > Virtual Servers > Virtual Server Client
List Clients for Virtual Server.
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest 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) | |
virtual_id | url | string | Virtual Id. | X |
id | query | string | Filter by id. (can suffix with wildcard *) | |
l | query | integer | Paginate Limit / Entities per Page. (1-50, 0 for infinite, -1 for streaming) | |
name | query | string | Filter by name. (can suffix with wildcard *) | |
p | query | integer | Paginate Current Page. (default 1) | |
sc | query | string | Sort by Property/Column. (id, name) | |
sd | query | string | Sort direction. asc for Ascending or desc for Descending |
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 |
---|---|---|---|
coa_port | body | integer | Port number for COA. |
creation_time | body | string | Creation Time. |
id | body | string | Unique Entity ID. |
ip4_address | body | string | Client IP address. |
metadata.page | body | integer | Current Page. (always 1 for infinite) |
metadata.pages | body | integer | Total Pages. (always 1 for infinite) |
metadata.per_page | body | integer | Equeal to the entities per page limit or always equal to total records for infinite queries. |
metadata.records | body | integer | Total entities found. (always max 250 unless infinite is accepted query parameter) |
name | body | string | Name of Entity. |
profile | body | string | Assigned Client Profile Name. |
secret | body | string | Secret given to the Radius Client, used for authentication. |
type | body | string | Client Type. (proxy or nas) |
virtual_id | body | string | Virtual Id. |
Response Example
{
"payload": [
{
"id": "e27627f8-3a13-4154-a19b-dc516de37577",
"virtual_id": "0ba81d12-3202-4019-95b7-7d7e14f98703",
"name": "TEST-BNG.INTERSTELLIO.IO",
"type": "nas",
"tags": "",
"profile": "JUNIPER",
"secret": "testing123",
"ip4_address": "102.220.62.19",
"coa_port": 3799,
"pool_id": null,
"pool_id_deactivate": null,
"creation_time": "2024-01-19T05:37:46.000Z"
}
],
"metadata": {
"records": 1,
"page": 1,
"pages": 1,
"per_page": 10
}
}
Show Client for Virtual Server.
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest 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) | |
client_id | url | string | Client 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 |
---|---|---|---|
coa_port | body | integer | Port number for COA. |
creation_time | body | string | Creation Time. |
id | body | string | Unique Entity ID. |
ip4_address | body | string | Client IP address. |
name | body | string | Name of Entity. |
profile | body | string | Assigned Client Profile Name. |
secret | body | string | Secret given to the Radius Client, used for authentication. |
type | body | string | Client Type. (proxy or nas) |
virtual_id | body | string | Virtual Id. |
Response Example
{
"id": "e27627f8-3a13-4154-a19b-dc516de37577",
"virtual_id": "0ba81d12-3202-4019-95b7-7d7e14f98703",
"name": "TEST-BNG.INTERSTELLIO.IO",
"type": "nas",
"tags": "",
"profile": "JUNIPER",
"secret": "testing123",
"ip4_address": "102.220.62.19",
"coa_port": 3799,
"pool_id": null,
"pool_id_deactivate": null,
"creation_time": "2024-01-19T05:37:46.000Z"
}
Create Client for Virtual Server.
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest 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) | |
virtual_id | url | string | Virtual Id. | X |
coa_port | body | integer | Port number for COA. | X |
ip4_address | body | string | Client IP address. | X |
name | body | string | Name of Entity. | X |
profile | body | string | Assigned Client Profile Name. | X |
secret | body | string | Secret given to the Radius Client, used for authentication. | X |
type | body | string | Client Type. (proxy or nas) | X |
Request Example
{
"virtual_id": "0ba81d12-3202-4019-95b7-7d7e14f98703",
"name": "TEST-BNG.INTERSTELLIO.IO",
"type": "nas",
"tags": "",
"profile": "JUNIPER",
"secret": "testing123",
"ip4_address": "102.220.62.19",
"coa_port": 3799,
"pool_id": null,
"pool_id_deactivate": null
}
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 |
---|---|---|---|
coa_port | body | integer | Port number for COA. |
creation_time | body | string | Creation Time. |
id | body | string | Unique Entity ID. |
ip4_address | body | string | Client IP address. |
name | body | string | Name of Entity. |
profile | body | string | Assigned Client Profile Name. |
secret | body | string | Secret given to the Radius Client, used for authentication. |
type | body | string | Client Type. (proxy or nas) |
virtual_id | body | string | Virtual Id. |
Response Example
{
"id": "e27627f8-3a13-4154-a19b-dc516de37577",
"virtual_id": "0ba81d12-3202-4019-95b7-7d7e14f98703",
"name": "TEST-BNG.INTERSTELLIO.IO",
"type": "nas",
"tags": "",
"profile": "JUNIPER",
"secret": "testing123",
"ip4_address": "102.220.62.19",
"coa_port": 3799,
"pool_id": null,
"pool_id_deactivate": null,
"creation_time": "2024-01-19T05:37:46.000Z"
}
Update Client for Virtual Server.
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) | |
client_id | url | string | Client Id. | X |
coa_port | body | integer | Port number for COA. | |
ip4_address | body | string | Client IP address. | |
name | body | string | Name of Entity. | |
profile | body | string | Assigned Client Profile Name. | |
secret | body | string | Secret given to the Radius Client, used for authentication. | |
type | body | string | Client Type. (proxy or nas) |
Request Example
{
"name": "TEST-BNG.INTERSTELLIO.IO",
"type": "nas",
"tags": "",
"profile": "JUNIPER",
"secret": "testing123",
"ip4_address": "102.220.62.19",
"coa_port": 3799,
"pool_id": null,
"pool_id_deactivate": null
}
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 |
---|---|---|---|
coa_port | body | integer | Port number for COA. |
creation_time | body | string | Creation Time. |
id | body | string | Unique Entity ID. |
ip4_address | body | string | Client IP address. |
name | body | string | Name of Entity. |
profile | body | string | Assigned Client Profile Name. |
secret | body | string | Secret given to the Radius Client, used for authentication. |
type | body | string | Client Type. (proxy or nas) |
virtual_id | body | string | Virtual Id. |
Response Example
{
"id": "e27627f8-3a13-4154-a19b-dc516de37577",
"virtual_id": "0ba81d12-3202-4019-95b7-7d7e14f98703",
"name": "TEST-BNG.INTERSTELLIO.IO",
"type": "nas",
"tags": "",
"profile": "JUNIPER",
"secret": "testing123",
"ip4_address": "102.220.62.19",
"coa_port": 3799,
"pool_id": null,
"pool_id_deactivate": null,
"creation_time": "2024-01-19T05:37:46.000Z"
}
Delete Client for Virtual Server.
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest Parameters
Name | In | Type | Description | MUST include |
---|---|---|---|---|
X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
client_id | url | string | Client 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 |