REST API
The REST API documentation is available under https://YOURNAME.radius-as-a-service.com/docs/api
Last updated
The REST API documentation is available under https://YOURNAME.radius-as-a-service.com/docs/api
Last updated
RADIUSaaS exposes a REST API that allows you to automate most actions that would otherwise have to be performed through the RADIUSaaS Admin Portal UI.
Before executing any API call that leads to a configuration change, ensure you fully understand the implications. Incorrect use of the API may break the configuration of your service.
To authenticate a call to the REST API, populate an HTTP Authorization header with each request. This header must contain a valid access token:
The API documentation contains a complete Swagger-based API reference for each API endpoint including
available HTTP methods,
HTTP response codes,
JSON schemas / form data for request (bodies),
JSON schemas of response bodies, and
Request-response examples for some endpoints.
It is not possible to trigger API calls directly through the API Reference.
The REST API can be used to automate the management of username/password accounts for BYOD or guest access scenarios.
This may include the automatic provisioning of (WiFi) credentials during on-boarding of new students, tenants in a co-working space, ... as well as the automatic retirement of those accounts.
An example on how to use the REST API to provision a username/password account can be found in your API Reference under the User endpoints.
In general, there are two different content types for the REST API, either form data or JSON. You can find out which media type is required in the API documentation.
If you are not familiar with the curl syntax, you can find two examples here:
