REST API Overview
The REST API provides numerous system functions, including:
-
Displaying information about devices in the SD-AVC network
-
Controlling external sources
-
Displaying information about generic traffic
-
Creating user-defined applications
![]() Note |
Using the REST API requires authentication. See Authentication from SD-AVC Network Service. |
Authentication |
|
POST https://<SD-AVC-network-service-address>:8443/avc-sd-service/ external-api/login |
Acquires an authentication token, enabling use of the REST API. |
System |
|
GET /avc-sd-service/external-api/status |
Displays the SD-AVC version and system times. |
GET /avc-sd-service/external-api/devices |
Displays devices in the SD-AVC network. |
POST /avc-sd-service/external-api/cleanDevices |
Removes a device from the SD-AVC network. |
GET /avc-sd-service/external-api/analytics?period=Period - GET /avc-sd-service/external-api/analytics/SegmentName ?period=Period - GET /avc-sd-service/external-api/analytics/SegmentName/ DeviceName?period=Period |
Display traffic analytics (applications and bandwidth) for the complete SD-AVC network, a specific segement, or a specific device. |
External Sources |
|
GET /avc-sd-service/external-api/configuration/externalSource/ externalSourceName_enabled/start - GET /avc-sd-service/external-api/configuration/externalSource/ externalSourceName_enabled/stop |
Enables or disables receiving data from an external source. In this release, the only external source is the MS Office365 Connector (o365). |
GET /avc-sd-service/external-api/configuration |
Displays status of external sources. |
User-defined Applications |
|
POST /avc-sd-service/external-api/app-rules |
Create one or more user-defined applications. |
GET /avc-sd-service /external-api/app-rules - GET /avc-sd-service /external-api/app-rules?sourceId=sourceId |
Displays user-defined applications defined by REST API. |
GET /avc-sd-service/external-api/app-rules/status - GET /avc-sd-service /external-api/app-rules/status[?sourceId=sourceId] |
Displays activation status of user-defined applications, per device. |
DELETE /avc-sd-service /external-api/app-rules - DELETE /avc-sd-service /external-api/app-rules?sourceId= sourceId |
Deletes a set of user-defined applications. |
Generic Applications |
|
GET /avc-sd-service/external-api/apps/generics |
Displays the list of traffic types that contribute to "generic" traffic. |