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. |
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 |
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 |
Deprecated
This operation deletes devices in a synchronized way which may take a long time to respond. Use the Delete devices through job (POST /devices/removalJob) instead 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 Group Specification | Provides a view of group specific information of devices. Use this service to query or navigate groups |
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 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. |
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 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. |
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. |