Register a NAS

POST /api/v1/admin/nas prm_nas_create

Creates the device record and its RADIUS shared secret. At least one of nas_identifier, nas_ip and called_station_id must be present — that is what an incoming RADIUS packet will be matched on.

A 409 here can be caused by a device belonging to a tenant you cannot see. The three identity columns are globally unique because RADIUS resolves on the bare key before any tenant is known, so "already taken" does not mean "already in your list".

At a glance

Authentication: Staff token or session
Requires permission: prm_nas_create Add NAS
Rate limit: t_mutate

Parameters

Parameter	Description
`shared_secret`required body · string	The RADIUS shared secret. Required.
`nas_identifier` body · string	NAS-Identifier. Unique across the whole platform.
`nas_ip` body · string	NAS-IP-Address. Unique across the whole platform.
`called_station_id` body · string	Called-Station-Id. Unique across the whole platform.
`vendor` body · string	Device vendor. Validated against the known-vendor catalogue.
`coa_port` body · integer	RFC 5176 port. Omit for the schema default of 3799.
`ip_accounting_enabled` body · boolean	Defaults to true when omitted. An explicit false is honoured.

Errors

Code	When it is returned
`ERR_VALIDATION`400	shared_secret missing, no identity field supplied, or an unknown vendor
`ERR_CONFLICT`409	the nas_ip, nas_identifier or called_station_id is already registered — possibly by another tenant

Request

curl -X POST "$BASE/api/v1/admin/nas" \
  -H "Authorization: Bearer $XR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "nas_identifier": "cairo-edge-2",
  "nas_ip": "10.20.0.2",
  "shared_secret": "a-long-random-secret",
  "description": "Nasr City edge 2",
  "vendor": "mikrotik",
  "coa_port": 3799
}'

BASE is your tenant host: the same address you sign in on.

Try it on your own network.

50 subscribers for 7 days. You pay nothing.

Try it free Talk to us