Search RadiusServers

GET

api

sys

radiusservers

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/radiusservers \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/radiusservers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

A RADIUS server is a hosted Wi-Fi authentication network that a location rents through the built-in provider integration, so customers sign in to the Wi-Fi with their Nexudus account and their network sessions become check-ins. Creating a record is not a settings change: the backend calls the provider to build a real network, a captive portal for the selected Vendor, and an authentication endpoint, then stores the returned network, portal, splash-page, IP, port and shared-secret values as read-only fields the operator copies into their wireless controller. It fails unless the location has a RADIUS licence key configured. Deleting a record deletes the network and captive portal at the provider and cannot be undone. Only the first active server of a location is used, an active server is billed monthly, and a server that is not active is skipped by the 15-minute synchronisation. The record alone does not grant anyone Wi-Fi access; that depends on each customer allowing network check-in and holding a pass that allows it.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the RadiusServer-List role.

Enums

eRadiusServerVendor — Vendor values

Value	Name
0	Aerohive_Networks
1	Alcatel_Lucent
2	Aruba_Instant
3	Aruba_Mobility_Controller
4	Avaya
5	Bluesocket
6	Casa_Systems
7	ChilliSpot
8	CoovaChilli
9	Cisco_Systems
10	Dell
11	EnGenius
12	ExtremeWireless
13	FortiGate
14	ICC
15	LigoWave
16	Meraki_Sign_On
17	Meraki_ClickThrough
18	Meru_Networks
19	MikroTik
20	Motorola
21	Mojo_Networks
22	Open_Mesh_Cloudtrax
23	pfSense
24	Peplink
25	Ruckus_Wireless
26	Ruckus_Virtual_SZ
27	SonicWall
28	Ubiquiti_Networks
29	TP_Link_EAP
30	Trapeze_Wireless
31	Trendnet
32	Xirrus
33	Virtual_Controller
34	Other

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the location that owns this RADIUS server. The location’s RADIUS licence key setting decides whether the server can be provisioned at all, and its country selects the hosting region: US, AU, or Europe for everywhere else..

string

Filter by operator-facing label for this server in the location’s list. The provider-side network and captive portal are named automatically from the location name and the creation date, so this value is not sent to the provider..

integer

Filter by wireless hardware or controller the captive portal is built for, such as Meraki_Sign_On, Ubiquiti_Networks, MikroTik or Ruckus_Wireless; use Other when the vendor is not listed. It is applied only while the captive portal is provisioned during creation, so changing it afterwards does not rebuild the portal and the admin form disables it once the record exists..

boolean

Filter by whether this server is included in the RADIUS synchronisation that runs every 15 minutes to import provider accounting data as customer check-ins. Only the first active server of a location is used, and an active server also adds a RADIUS line to the location’s monthly invoice. Set false to stop syncing and billing without tearing down the provisioned network..

string

Filter by optional free-text note about this server. It is not shown on the admin form and is not sent to the provider..

string

Filter by legacy provider customer identifier that no backend code ever populates, so it is always empty. Hidden from the agent because it would be misleading; use NetworkId to identify the provisioned network..

string

Filter by read-only identifier of the hosted RADIUS network created by the provider when this record was saved. Deleting the record deletes that network at the provider; it cannot be set or changed..

string

Filter by read-only identifier of the captive portal created alongside the network at creation time, using the selected Vendor. Deleting the record deletes the portal at the provider; it cannot be set or changed..

string

Filter by read-only public identifier the provider generates for the captive portal’s splash page. It appears in the customer-facing Wi-Fi login URL and cannot be set or changed..

string

Filter by read-only primary RADIUS server IP address supplied by the provider at creation. The operator enters it in the wireless controller’s RADIUS settings; it cannot be set or changed here..

string

Filter by read-only backup RADIUS server IP address supplied by the provider at creation, used when the primary address is unreachable. It cannot be set or changed here..

string

Filter by read-only RADIUS accounting port supplied by the provider at creation. The wireless controller sends accounting packets here, which become customer check-ins on the next synchronisation..

string

Filter by read-only RADIUS authentication port supplied by the provider at creation. The wireless controller sends authentication requests here..

string

Filter by credential the wireless controller uses to authenticate to the RADIUS server, issued by the provider at creation. Hidden from the agent because it is a secret; the operator must read it from the location’s RADIUS settings page in the admin panel..

Range Filters

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/sys/radiusservers?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/radiusservers?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/radiusservers',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/sys/radiusservers?RadiusServer_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/radiusservers?' + new URLSearchParams({
    RadiusServer_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/radiusservers',
    params={
        'RadiusServer_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/radiusservers?from_RadiusServer_UpdatedOn=2025-01-01T00:00&to_RadiusServer_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/radiusservers?' + new URLSearchParams({
    from_RadiusServer_UpdatedOn: '2025-01-01T00:00',
    to_RadiusServer_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/radiusservers',
    params={
        'from_RadiusServer_UpdatedOn': '2025-01-01T00:00',
        'to_RadiusServer_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

RadiusServer[]

The list of RadiusServer records matching the query. See the Get one RadiusServer endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each RadiusServer. The following fields are not populated in the Records[] response: Description.To get all fields, fetch the full record using the Get one RadiusServer endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "Vendor": 0,
      "Active": false,
      "CustomerId": null,
      "NetworkId": null,
      "CaptivePortalId": null,
      "SplashPageId": null,
      "RadiusIp1": null,
      "RadiusIp2": null,
      "AccountPort": null,
      "AuthPort": null,
      "SharedSecret": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "RadiusServer Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search RadiusServers

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/radiusservers \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/radiusservers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200