External Monitoring

This article demonstrates how to use the provided API for external monitoring of your RADIUSaaS instance.

Overview

The monitoring endpoint of your RADIUSaaS instance allows you to perform the following tasks in your own 3rd party monitoring solution:

• Monitor uptime of your RadSec endpoints.

• Monitor uptime of your RADIUS proxies.

• Monitor expiry of your RADIUS Server Certificate and its issuing CA.

If feasible in your monitoring solution, aggregation and metrics can be built around those monitors to trigger automated alerts.

API Schema Defition

Please refer to the API documentation in your RADIUSaaS Admin Portal for detailed information on the schema of the /status endpoint.

API Examples

Please note that we are unable to provide support for 3rd party monitoring solutions and you will need to bring your own expertise beyond the scope of this article.

1

Create an Access Token as described here.

2

Retrieve Data

To retrieve data from the API endpoint, authenticate your requests using the access token created previously:

PowerShell

1. Store the Access Token

Store the access token in a PowerShell variable for easy reference. Replace your_access_token with the actual token.

$accessToken = "your_access_token"

1. Make the API Request

Use PowerShell's Invoke-RestMethod to send a request to the desired API. Ensure to include the access token in the request header.

$url = "https://contoso.radius-as-a-service.com/api/status"
$headers = @{
    Authorization = "Bearer $accessToken"
}
$response = Invoke-RestMethod -Uri $url -Headers $headers -Method Get

cURL

Python

3

Process the data according to your needs

Example 1 - Show information about the RadSec servers:

$response.radsecservers

cluster_name                     : eu1
ip                               : 20.113.8.151
name                             : radius-server-contoso-main
radius-server-contoso-main-state : True
state                            : True

Example 2 - Show information about the RADIUS proxies:

$response.proxies

ip                                       : 142.93.161.44
location                                 : Europe (Frankfurt)
name                                     : radius-proxy-contoso-142.93.161.44
radius-proxy-contoso-142.93.161.44-state : True
state                                    : True

ip                                     : 209.38.81.0
location                               : Australia (Sydney)
name                                   : radius-proxy-contoso-209.38.81.0
radius-proxy-contoso-209.38.81.0-state : True
state                                  : True

Example 3 - Show certificate information:

$response.certificates | Format-List

contoso-certificate--Proxycertificate-state : True
name                                        : contoso-certificate--Proxycertificate
state                                       : True
validity_days_left                          : 2570

contoso-certificate-Customer-CA-state : True
name                                  : contoso-certificate-Customer-CA
state                                 : True
validity_days_left                    : 6900

Please consider that the certificates will be checked every 10 hours, and the data is cached for 60 seconds. Consequently, after renewing an expired certificate, it may take several hours for the status to be updated.