SitesSynthetic Tests

triggerSiteSwitchRadiusSyntheticTest

POST
/api/v1/sites/{site_id}/devices/{device_id}/check_radius_server

Ping test from the AP to confirm 'reachability' of the RADIUS server.

Utilize Juniper EX switch(to which an AP is connected to) radius test capabilities to get details on the RADIUS Server 'availability'.

Subscribe to Device Command outputs

WS /api-ws/v1/stream

{    "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"}

Example output from ws stream

{  "event": "data",  "channel": "/sites/d6fb4f96-3ba4-4cf5-8af2-a8d7b85087ac/devices/00000000-0000-0000-1000-2093390b3580/cmd",  "data": "{\"event\": \"data\", \"channel\": \"/sites/d6fb4f96-3ba4-4cf5-8af2-a8d7b85087ac/devices/2093390b3580/cmd\", \"data\": {\"session\": \"6043daff-884e-48bc-aa9a-810d268aceb1\", \"raw\": \"    Reason : fail\"}}"}{  "event": "data",  "channel": "/sites/d6fb4f96-3ba4-4cf5-8af2-a8d7b85087ac/devices/00000000-0000-0000-1000-2093390b3580/cmd",  "data": "{\"event\": \"data\", \"channel\": \"/sites/d6fb4f96-3ba4-4cf5-8af2-a8d7b85087ac/devices/2093390b3580/cmd\", \"data\": {\"session\": \"6043daff-884e-48bc-aa9a-810d268aceb1\", \"raw\": \"    Test complete. Exiting\"}}"}

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

site_id*string
Formatuuid
device_id*string
Formatuuid

Request Body

application/json

Request body for testing RADIUS server availability from a switch

password*string

Specify the password associated with the username

Formatpassword
profile?string

Specify the access profile associated with the subscriber

Default"dot1x"
user*string

Specify the subscriber username to test

Response Body

curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab/check_radius_server" \  -H "Content-Type: application/json" \  -d '{    "password": "string",    "profile": "dot1x",    "user": "string"  }'
{  "session": "19e73828-937f-05e6-f709-e29efdb0a82b"}