Subscriber Sessions API

Reference material for usage on Subscriber Management > Telemetry > Subscriber Sessions.

GET

/v2/sessions/{subscriber_id}

(subscriber)

Sessions for subscriber.

Service
subscriber

Accepted Roles (RBAC)

AdministratorCustomerNetwork OperationsStaff MemberSubscriber AccountsSubscriber AdministratorSubscriber SupportSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
subscriber_id	url	string	Subscriber Id.	X
calling_station_id	query	string	Filter by calling_station_id. (can suffix with wildcard )*
ctx	query	string	Filter by ctx. (can suffix with wildcard )*
framed_ip_address	query	string	Filter by framed_ip_address. (can suffix with wildcard )*
l	query	integer	Paginate Limit / Entities per Page. (1-50, -1 for streaming)
p	query	integer	Paginate Current Page. (default 1)
realm	query	string	Filter by realm. (can suffix with wildcard )*
sc	query	string	Sort by Property/Column. (username, calling_station_id, realm, start_time, updated_time, ctx, framed_ip_address)
sd	query	string	Sort direction. asc for Ascending or desc for Descending
username	query	string	Filter by username. (can suffix with wildcard )*

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
acct_unique_id	body	string	Acct Unique Id.
calling_station_id	body	string	Calling Station Id.
ctx	body	string	Subscriber Context.
framed_ip_address	body	string	Framed Ip Address.
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)
nas_ip_address	body	string	Nas Ip Address.
start_time	body	string	Start Time.
updated_time	body	string	Updated Time.
user_id	body	string	Unique Subscriber Identifier.
username	body	string	Username.

Response Example

{
    "payload": [
        {
            "id": "520d4872-66ac-11ef-abed-ef0503fe37cf",
            "calling_station_id": "",
            "acct_unique_id": "a2b3ec16-5996-4add-963d-e5fd46641d95",
            "start_time": "2024-08-26T04:46:16.000Z",
            "updated_time": "2024-08-30T08:46:17.000Z",
            "user_id": "2c79f1c6-c9dd-11ee-b885-ddbef08e6d9d",
            "username": "test@example.com",
            "framed_ip_address": "205.25.1.1",
            "nas_ip_address": "192.168.0.1",
            "ctx": "activate-login"
        }
    ],
    "metadata": {
        "records": 1,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

GET

/v2/session/{session_id}

(subscriber)

Show subscriber session.

Service
subscriber

Accepted Roles (RBAC)

AdministratorCustomerNetwork OperationsStaff MemberSubscriber AccountsSubscriber AdministratorSubscriber SupportSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
session_id	url	string	Session 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
acct_session_id	body	string	Acct Session Id.
acct_unique_id	body	string	Acct Unique Id.
arrival_interval	body	integer	Arrival Interval.
arrival_time	body	string	Arrival Time.
called_station_id	body	string	Called Station Id.
calling_station_id	body	string	Calling Station Id.
client_ip_address	body	string	Client Ip Address.
ctx	body	string	Subscriber Context.
domain	body	string	Entity Domain.
expire_time	body	string	Expire Time.
framed_ip_address	body	string	Framed Ip Address.
id	body	string	Unique Entity ID.
metadata	body	object	Radius AVP(s) as per last Accounting-Request.
nas_ip_address	body	string	Nas Ip Address.
nas_type	body	string	Nas Type.
pool_id	body	string	Pool Id.
process_time	body	string	Process Time.
profile_id	body	string	Profile Id.
realm	body	string	Realm.
server_ip_address	body	string	Server Ip Address.
service_id	body	string	Service Id.
start_time	body	string	Start Time.
stop_time	body	string	Stop Time.
updated_time	body	string	Updated Time.
user_id	body	string	User Id.
username	body	string	Username.
virtual_id	body	string	Virtual Id.

Response Example

{
    "id": "0a9685a8-1540-45ae-91bb-de990041008e",
    "virtual_id": "465be807-54f1-4bf6-b940-398ed95cdbe7",
    "domain": "example.com",
    "user_id": "c5ddf963-cbb6-4019-b20a-0bbcfd51b49b",
    "profile_id": "87dae83d-2b26-4673-a86d-eff1ad30667b",
    "service_id": "dee171f4-34a7-401b-bdef-9cd2ca6a9e8f",
    "ctx": "activate-login",
    "nas_type": "JUNIPER",
    "username": "test@example.com",
    "calling_station_id": "",
    "called_station_id": "",
    "realm": "example.com",
    "acct_session_id": "47815835",
    "acct_unique_id": "10ecdeb0-e84a-4ded-b9e8-8cdae102698b",
    "start_time": "2023-12-13T13:54:32+00:00",
    "updated_time": "2023-12-13T14:04:32+00:00",
    "stop_time": null,
    "process_time": "2023-12-13T14:04:32+00:00",
    "arrival_time": "2023-12-13T14:04:32+00:00",
    "expire_time": "2023-12-13T14:36:32+00:00",
    "arrival_interval": 600,
    "update_interval": 0,
    "nas_ip_address": "192.168.0.1",
    "client_ip_address": "192.168.0.1",
    "server_ip_address": "10.0.0.4",
    "framed_ip_address": "100.66.47.215",
    "pool_id": "",
    "metadata": {
        "user-name": [
            "test@example.com"
        ],
        "nas-ip-address": [
            "192.168.0.1"
        ],
        ...
    },
    "input_octets": 0,
    "output_octets": 0,
    "acct_type": "interim-update",
    "version": 0,
    "version_hash": "3ff272be901a64f905cdd2f094c24445"
}

DELETE

/v1/disconnect/{session_id}

(subscriber)

Disconnect session.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber AdministratorSubscriber SupportSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
session_id	url	string	Session 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

Navigation

Subscriber Sessions API