Skip to main content
PUT
Update RadiusServer
Updates an existing RadiusServer record. You must include the Id of the record to update along with all required fields.

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-Edit role.

Enums

Request Body

Required Fields

integer
required
The Id of the RadiusServer record to update.
integer
required
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
required
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
required
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..

Optional Fields

boolean
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
Optional free-text note about this server. It is not shown on the admin form and is not sent to the provider..

Code Examples

Response

200

integer
HTTP status code. 200 on success.
string
A human-readable message confirming the update.
object
Contains the Id of the updated record.
boolean
true if the radiusserver was updated successfully.
array
null on success.
Example Response

400

string
A summary of the validation error(s), in the format PropertyName: error message.
any
null on validation failure.
object[]
Array of validation errors.
boolean
false when the request fails validation.
Example Response