IP Query API

Looks up which subscriber was using a given IP address (or CIDR) at a point in time, from the IP-usage log. Each record is returned with details from its corresponding CDR.

The id returned for each record is the CDR record ID. To retrieve the full CDR for a record, pass that id to the GET /v1/subscriber/cdr/record/{cdr_id} endpoint documented in the Subscriber Telemetry API - Caller Data Records.

POST

/v1/subscriber/ip_query

(telemetry)

IP Query.

Service
telemetry

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Domain	header	string	Optional domain context for the request. (default: the token domain)
ip	body	string	IP address or CIDR to search for.	X
time	body	string	Date and time the IP was in use, as an ISO-8601 datetime with a timezone offset, e.g. "2024-02-16T10:00:00+00:00".	X

Request Example

{
    "time": "2024-02-16T10:00:00+00:00",
    "ip": "198.51.100.10"
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
409	Conflict
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	Unique ID
calling_station_id	body	string	Calling station ID.
id	body	string	Unique ID of the IP record. This is also the CDR record ID; pass it to GET /v1/subscriber/cdr/record/{cdr_id} to retrieve the full CDR.
nas_identifier	body	string	NAS identifier.
nas_ip_address	body	string	NAS IP address.
prefix	body	string	IP address
prefix_type	body	string	Type of address
service	body	string	Service name.
start_time	body	string	Start Time
update_time	body	string	Update Time
username	body	string	Username of the subscriber.
virtual	body	string	Virtual AAA name.

Response Example

[
    {
        "id": "33b934f0-cc81-11ee-a3ca-9d2f10704be2::2024-02-01",
        "start_time": "2024-02-16T04:09:38+00:00",
        "update_time": "2024-02-16T10:09:39+00:00",
        "acct_unique_id": "33b934f0-cc81-11ee-a3ca-9d2f10704be2",
        "prefix_type": "framed-ip-address",
        "prefix": "198.51.100.10",
        "username": "user@example.com",
        "calling_station_id": "00:11:22:33:44:55",
        "nas_ip_address": "192.0.2.20",
        "nas_identifier": "NAS-1",
        "service": "Premium-100",
        "virtual": "ExampleAAA"
    }
]