API Health Service
Provides services to monitor and diagnose API performance and usage.
Resource | Description |
---|---|
GET API Health Record | Represents API performance and diagnostic information. |
GET API Response Time Summary | Represents summarized information about response times for each service. |
GET API Calls Per Client | Returns the IP addresses of all clients using either all services or the specified service, over the last 24 hours. |
GET API Request Count Trend | Reports the number of requests, grouped by day and HTTP status, for all services or a given service if specified, over the last seven days. |
GET API Response Time Trend | For each request over the last 24 hours, shows the response time and the time the request was received, either for all services or for the specified service. |
GET API Service Name List | Returns the list of services for which there are ApiHealthRecords. |
Access Point Operations
Operations to delete and modify access points
Resource | Description |
---|---|
PUT Delete Unified Access Point | An operation to delete unified AP and third party AP. |
PUT Modify Unified Access Point | Modifies an Access Point's name, location, controller affinity, or admin status. |
CLI Template Configuration
The CLI Template Configuration service allows a CLI configuration template to be applied to one or more target devices. It also provides a way to upload, delete, and get the CLI templates in the system.
Resource | Description |
---|---|
GET CLI Configuration Templates | CLI configuration templates. |
DELETE Delete Configuration Template | Deletes a template from the system. |
GET Download Configuration Template |
Deprecated
Please use the CLI Configuration Templates resource instead. This operation may be removed in a future release. Export a template from the system. |
GET List Configuration Templates |
Deprecated
This operation does not support pagination, filtering, or sorting. Please use the CLI Configuration Templates resource instead. This operation may be removed in a future release. Get a list of the published Templates |
GET List Device Types | Returns the list of device types you can specify for a CLI template. |
POST Upload Configuration Template | Upload a new template into the system. |
PUT Deploy Configuration Template |
Deprecated
This resource deploys templates in a synchronized way which may take a long time to respond. Use the resource Deploy Configuration Template Through Job instead Deploy a template to a list of devices. |
PUT Deploy Configuration Template Through Job | Deploy a template to a list of devices through Job. A job name will be returned. Use the job name to query the job result using Job Operations services. To query job status, use the query api/v1/data/JobSummary?jobName=CliTemplateDeploy123. To query the full run result if the deployment fails, use the query api/v1/op/jobService/runhistory?jobName=CliTemplateDeploy123 |
Clients
Provides information about wired and wireless clients.
Resource | Description |
---|---|
GET Client Counts | Represents number of clients counted during the last polling cycle. The combination of type, key and subtype represents number of clients associated with the entity. |
GET Client Details | Represents the detail view of a client. It provides attributes of client device, security information, connected device, traffic and session information. All information is collected in current or last session. |
GET Client Sessions | Represents detail view of client sessions. It provides device and session related attributes including security, connected device, session time, traffic, etc. |
GET Client Summary | Represents client view with information about the end points. It provides end point information such as MAC address, IP address, username, and status. |
GET Client Traffic Information | Represents clients traffic information collected during the last polling cycle. |
GET Historical Client Counts | Represents client count collected in last 24 hours with 5 minutes (default) interval. The dataset could be really big. When querying, you must use paged query or filtered by entity or time. Otherwise it could result in longer running query to affect system performance. |
GET Historical Client Traffic Information | Represents client traffic information collected in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying, you must use paged query or filtered by entity or time. Otherwise it could be resulted in longer running query to affect system performance. |
Credentials Service
A REST based operation to query the Credential Manager for a device's credentials.
Resource | Description |
---|---|
GET Credentials | Operation to retrieve device credentials. Can take one of two parameters: 'id' or 'address'. , e.g. ?id=17010 or ?address=172.23.218.75, where the id is MEI ID or the address is the management address. |
Device Details
- Device summary and inventory information about devices.
- Events and alarms in the system.
Resource | Description |
---|---|
GET Alarms | Alarm is a representation of the fault or change of state that occurred in the managed system; it could be resource or service and customer related. Alarms are associated with a group of events received from the managed resources, usually with the same source and category, indicating that such fault or event had occurred. |
GET Devices | Represents the device view with information about the managed network elements. It provides device information such as device name, device type, ip address, software type, version, and also provides the reachability and management status. |
GET Events | Represents a "normalized" record of an occurrence reported by the network (or any system capable of notifying of such an occurrence); it could be a syslog, SNMP trap, or any other such type. The term "normalized" denotes a single format abstracted over all types of reported events, regardless of source and structure. |
GET Inventory Details | It provides an aggregated view of all the available inventory information for the device. |
GET Syslogs | Represents the syslog view. Syslogs are standard method for logging messages such as system events in an IP network. |
Device Operations
Operations to create, update, delete devices
Resource | Description |
---|---|
GET Export Devices |
An operation to export a list of devices. It accepts three parameters: ipAddress, groupId or groupPath. If no parameters are specified, no devices will be exported. NBI filtering can be applied to the parameters. Use the GroupSpecification service to obtain groupId or groupPath information. Examples
|
PUT Bulk Import |
An operation to add or update multiple devices using a batch job Credential Profiles Support
User Defined Field Support
|
PUT Delete Devices | An operation to delete devices by ip address. The response time of this service varies and depends on the status of the devices. |
Group Summary Service
The Group Summary Service provides a summary of alarms per group for each type of group (Site, Device Type or User Defined Group) , an overall alarm summary and a summary of the number devices per Site.
Resource | Description |
---|---|
GET Device Groups |
Deprecated
Do not use this resource. Replaced by /op/groups/deviceGroups. This provides information about the hierarchy of device type groups. Note that internally, DeviceGroups are type of "Group", and thus all children will be of the generic type "subGroup". |
GET Group Specification | Provides a view of group specific information of devices. Use this service to query or navigate groups |
GET Sites |
Deprecated
Do not use this resource. Replaced by /op/groups/sites. This provides information about the location groups and its hierarchy of campus and buildings. Note that internally, Locations are type of "Group", and thus all children will be of the generic type "subGroup". |
GET User Defined Groups |
Deprecated
Do not use this resource. Replaced by /op/groups/userDefinedGroups. Provides the list of User Defined groups and the associated sub group hierarchy. Note that internally, UserDefinedGroups are type of "Group", and thus all children will be of the generic type "subGroup". |
GET Alarm Summary | Provides alarm summary information including: total number of alarms, number of alarmed devices, number of alarmed sites, number of alarmed APs and number of alarmed Clients. |
GET Device Groups | Returns list of Device Type groups, including the count of alarms of each severity for each group. |
GET Location Groups | Returns list of Locations, including the count of alarms of each severity for each group. Also includes counts of devices, APs and Clients associated with the Location and also location information regarding the location. This service was formerly known as "Site Groups." |
GET User Defined Groups | Returns list of User Defined groups, including the count of alarms of each severity for each group. |
Job Operations
To check job status, suspend, cancel and resume jobs.
Resource | Description |
---|---|
GET Job Summary | Provides a consolidated view of the latest status of all scheduled jobs. Use this resource to get a quick job status check. To query system jobs , specify username=SYSTEM |
GET Query Job Run History |
Query the past run instances of a job. All request parameters are optional. If no parameters are specified, If no parameters are specified, no run instances will be returned.. NBI filtering can be applied to the parameters to customize the query. Please refer the filtering page for the details of how to use filtering Examples :
|
PUT Cancel A Job | Disable the trigger permanently. The canceled job cannnot be resumed using "Resume A Job" service |
PUT Cancel A Job running instance | Stop a running instance of a job. |
PUT Resume A Job | Re-enable the trigger of a suspended job. |
PUT Suspend A Job | Disable the trigger temporarily. The job will no longer to run when suspended. To re-enable the job trigger, use 'Resume A Job' service. Suspending a job in running status dose not impact the running instance. |
Manage and Monitor Info Service
The Manage and Monitor Info Service service provides information about the application and the server it runs on.
Resource | Description |
---|---|
GET Core Dumps | Returns the number of application core dumps present on the server. |
GET Disk Usage and Capacity | Returns capacity and usage information for the volumes present on the application's server. |
GET Licenses | Returns license information about the application. |
GET Uptime | Returns uptime information as well as information about the application and the server it runs on. |
GET Version | Returns the version of the application. |
Report Service
The Report service provides operations to discover and run reports. Reports need to be defined in the system prior to access through the API.
Resource | Description |
---|---|
GET Get Available Report Templates |
This URL is used to get all the saved report templates. It returns an array of information about the available saved report templates.
Report templates need to be set up in the GUI to be available here. |
GET Get a Report |
This URL is used to retrieve the report data for a report that was previously generated from an asynchronous call of the
reportService/report URL, or returns the latest result from a scheduled report generation.
|
GET Run a Report |
This URL is used to generate reports from a specific saved report template and return the report output as an XML/JSON response.
It takes two arguments: a String reportTitle - a unique title of the saved report template, and a Boolean async indicating if the call is asynchronous when the value is true. It provides the report data in the case of a synchronous call, or just provides a report URL using which the latest report can be retrieved. |
GET Run a ZIP Report | This API operation is used to generate reports from a specific saved report template and return the report output as ZIP of one or more CSV files. It takes one argument, a String reportTitle, which is the name of the saved report template. This API features similarly to the export functionality available in the Report Launch Pad. |
Statistics
The Statistics services provide summary, pre-defined statistical information about the system.
Resource | Description |
---|---|
GET Application Art Analysis |
Retrieves the application art analysis statistics in the list of time, client network time, server response time, transaction time and data time. Here are the sample queries
|
GET Application Performance |
Retrieves the application performance statistics.
|
GET Application Top N Traffics |
Retrieves the top N clients or server traffic statistics of an application or all applications. Here are the sample queries
|
GET Application Traffic Analysis |
Retrieves the traffic analysis of an application.
|
GET Application Volume |
Retrieves the application volume statistics in the list of application name and volume pairs. Here are the sample queries
|
GET Applications Number of Users |
Retrieves the number of users of an application.
|
GET CPU Utilization Summary |
Retrieves the device CPU utilization summary.
|
GET CPU Utilization Trend |
Retrieves the device CPU utilization trend.
|
GET Device Availability |
Retrieves the device availability summary for a given IP address.
|
GET Device Availability Message |
Retrieves the device availability message.
|
GET Device Availability Summary |
Retrieves the device availability summary. |
GET Device Down Message |
Retrieves the device down message.
|
GET Device Health Info |
Retrieves the device health information.
|
GET Device Port Summary |
Retrieves the device port summary.
|
GET Device Reachability Status |
Retrieves the device reachability status.
|
GET Interface Availability |
Retrieve the interface availability.
|
GET Interface Availability Message |
Retrieves the interface availability message.
|
GET Interface Availability Summary |
Retrieves the interface availability summary.
|
GET Interface Details |
Retrieves the interface details.
|
GET Interface Discards |
Retrieves the interface discards.
|
GET Interface Down Message |
Retrieves the interface down message.
|
GET Interface Errors |
Retrieves the interface errors.
|
GET Interface Status Summary |
Retrieves the interface status summary.
|
GET Interface Utilization Summary |
Retrieves the interface utilization summary.
|
GET Interface Utilizations |
Retrieves the interface utilization.
|
GET Memory Utilization Trend |
Retrieves the device memory utilization trend.
|
GET System Health |
Retrieves system health statistics.
|
GET System Information |
Retrieves system information statistics.
|
GET Top N Application Hosts |
Retrieves the top N application hosts.
|
GET Top N Class Map QOS |
Retrieves the top N class map QOS statistics.
|
GET Top N Device CPU Utilization |
Retrieves the top N device CPU utilization statistics.
|
GET Top N Device Memory Utilization |
Retrieves the top N device memory utilization statistics.
|
GET Top N Device Temperature |
Retrieves the top N device temperature statistics.
|
GET Top N Interface Errors |
Retrieves the top N interface error statistics.
|
GET Top N Interface Utilization |
Retrieves the top N interface utilization statistics.
|
GET Top N WAN Interface Issues |
Retrieves the top N WAN interface issue statistics.
|
GET Top N WAN Interface Utilization |
Retrieves the top N WAN interface utilization statistics.
|
GET Worst N Application Hosts |
Retrieves the worst N application hosts.
|
GET Worst N Application Locations |
Retrieves the worst N application sites.
|
User Defined Field Management
The User Defined Field Management services provide operations to query, create, update and delete user tag definitions
Resource | Description |
---|---|
GET User Defined Field Definition | Provides a view of the User Defined Field Definitions of the system |
PUT Delete User Defined Field Definition | An operation to delete User Defined Field definitions |
PUT Import User Defined Field Definition | An operation to create or update User Defined Field definitions. |
WLAN Provisioning
Provides for operations to retrieve, create, modify, and delete interfaces, WLAN profiles, and AP groups.
Resource | Description |
---|---|
GET Wlan Profiles | Provides information about WLANs present on controllers managed by this system. |
GET Wlan Templates | Provides information about WLAN templates stored on this system. |
DELETE Delete AP Group | Schedules a job to delete an AP group from a Wlan Controller. |
DELETE Delete Interface | Schedules a job to delete an interface from a Wlan Controller. |
DELETE Delete Interface Group | Schedules a job to delete an interface group from a Wlan Controller. |
DELETE Delete WLAN Profile | Schedules a job to delete a WLAN profile from a Wlan Controller. |
DELETE Delete Wlan Template | Removes a WLAN template from the server. |
POST Create AP Group | Schedules a job to create an AP group on a Wlan Controller. |
POST Create Interface | Schedules a job to create an interface on a Wlan Controller. |
POST Create Interface Group | Schedules a job to create an interface group on a Wlan Controller. |
POST Create Wlan Template | Creates a WLAN template on the server. |
PUT Deploy Wlan Template | Schedules a job to deploy a WLAN template onto a Wlan Controller, creating a WLAN profile. |
PUT Modify AP Group | Schedules a job to modify an existing AP group on a Wlan Controller. The apGroupName attribute must match the existing AP group to be modified, and cannot be changed. |
PUT Modify Interface | Schedules a job to modify an existing interface on a Wlan Controller. The interfaceName attribute must match the existing interface to be modified, and cannot be changed. |
PUT Modify Interface Group | Schedules a job to modify an existing interface group on a Wlan Controller. The interfaceGroupName attribute must match the existing interface group to be modified, and cannot be changed. |
PUT Modify Wlan Template | Modifies an existing WLAN template on the server. The template name must match an existing template. |
Wireless Device Details
Resource | Description |
---|---|
GET Autonomous AP Radio Details | Represents a radio interface of an autonomous access point. |
GET Client Statistics | Represents client statistics data collected during the last polling cycle. The data represented here are the counters retrieved from controllers. The counters only get reset in new sessions. |
GET Historical Client Statistics | Represents client statistics collected in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying it, it is better to use paged query or filtered by client or time. |
GET Historical Radio Interface 802.11 Counters in Last 24 Hours | Represents 802.11 counters collected for radio interfaces of lightweight wireless access points in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying it, it is better to use paged query or filtered by AP or time. |
GET Historical Radio Interface Statistics in Last 24 Hours | Represents statistics for radio interfaces of lightweight wireless access points collected in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying it, it is better to use paged query or filtered by AP or time. |
GET Historical Wireless Lan Controller Utlizations | Represents the historical CPU and memory utilization information collected from WLAN controllers in past 24 hours. |
GET Lightweight AP Radio Details | Represents detail information of a radio interfaces on lightweight access point. |
GET Radio Interface 802.11 Counters | Represents the latest 802.11 counters for radio interfaces of lightweight wireless access points collected from controllers. |
GET Radio Interface Statistics | Represents the latest statistics information for radio interfaces of lightweight wireless access points collected from WLAN controllers. |
GET Radio Summary | Represents a radio interface of an wireless access point. |
GET Wireless Access Point Details | Represents detail information of a wireless access points. It includes basic attributes, inventory, CDP, client and other information. |
GET Wireless Access Point Summary | Represents a wireless access point including both unified and autonomous. It provides device attributes such as type, version, assoication controller, number of associated client, etc. |
GET Wireless Lan Controller Details | Represents detail information about a WLAN controller. |
GET Wireless Lan Controller Summary | Represents summary information about a WLAN controller. |
GET Wireless Lan Controller Utlizations | Represents the latest CPU and memory utilization collected from a WLAN controller. |