Access Point Operations
Operations to delete and modify access points.
Resource | Description | API Version |
---|---|---|
PUT Delete Access Points By IDs
PUT op/apService/deleteById |
An operation to delete unified AP and third party AP by IDs. |
Credential Profile Management Service
Provides services to create, retrieve, update and delete credential profiles
Resource | Description | API Version |
---|---|---|
DELETE Delete credential profile
DELETE op/credentialProfilesManagement/credentialProfiles |
Deletes a credential profile. | |
GET Get credential profiles
GET op/credentialProfilesManagement/credentialProfiles |
Returns list of credential profiles. | |
GET Get list of configured devices
GET op/credentialProfilesManagement/deviceList |
Returns list of devices configured with the credential profile. | |
POST Create credential profile
POST op/credentialProfilesManagement/credentialProfiles |
Creates a new credential profile. | |
PUT Update credential profile
PUT op/credentialProfilesManagement/credentialProfiles |
Updates an existing credential profile. Profile name is used to identify the credential profile to be edited. After updating the profile, you can synchronize devices using the POST op/devices/syncDevices resource. |
Device Details
- Device summary and inventory information about devices.
- Events and alarms in the system.
Resource | Description | API Version |
---|---|---|
GET RogueApAlarms
GET data/RogueApAlarms |
Represents Rogue Access Point Alarms. It includes basic alarm attributes and additional details for Rogue AP 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. |
Device Operations
Operations to create, update, and delete devices.
Resource | Description | API Version |
---|---|---|
POST Synchronize devices
POST op/devices/syncDevices |
Synchronize devices. Forces an inventory collection of the specified devices. |
Guest User Management Service
Provides services to create, retrieve, update and delete guest users. You can use GET data/WlanControllers resource for getting an information about controllers.
Resource | Description | API Version |
---|---|---|
GET Get guest users
GET data/GuestUsers |
Returns a list of guest users. | |
GET Get guest users from controller
GET op/guestUser/guestUsersOnController |
Lists guest user names currently associated with a particular controller. | |
GET Get logged in guest users from controller
GET op/guestUser/loggedInGuestUsersOnController |
Lists guest user names currently logged in and associated to a particular controller. | |
POST Create guest user
POST op/guestUser |
Creates a new guest user. | |
PUT Delete guest user
PUT op/guestUser/delete |
Deletes a guest user. | |
PUT Update guest user
PUT op/guestUser |
Updates an existing guest user. User name is used to identify the guest user to be edited. |
MAC Filters Management Service
Provides services to create, retrieve, update and delete mac filters.
Resource | Description | API Version |
---|---|---|
GET MAC Filter Templates
GET data/MacFilterTemplates |
Returns a list of MAC filter templates. | |
DELETE Delete MAC Filter Template
DELETE op/macFilter/macFilterTemplate |
Deletes an existing MAC filter template. | |
POST Create MAC Filter Template
POST op/macFilter/macFilterTemplate |
Create new MAC filter template. | |
PUT Deploy MAC Filter Template
PUT op/macFilter/deploy |
Deploy a MAC filter to WLAN controllers. | |
PUT Update MAC Filter Template
PUT op/macFilter/macFilterTemplate |
Updates an existing MAC filter template. Template name is used to identify the template to be edited. |
Statistics
The Statistics services provide summary, pre-defined statistical information about the system.
Resource | Description | API Version |
---|---|---|
GET Client Distribution Data
GET op/statisticsService/clients/distributions/{distribution} |
Fetches the distribution data for Clients
|
|
GET Client Distribution Supported
GET op/statisticsService/clients/distributions |
Fetches the URLs for various distributions of Clients
|
System Settings
System Settings
Resource | Description | API Version |
---|---|---|
DELETE WLAN FTP Server
DELETE op/settings/servers/ftpServers/{serverName} |
Deletes existing FTP server. | |
GET Alarms notification settings
GET op/settings/notification/alarmCategories |
Retrieves current alarms notification settings | |
GET Basic parameters for the configuration archive
GET op/settings/inventory/configArchiveBasic |
Retrieves basic parameters for the configuration archive, such as protocol, timeout value, number of configuration versions to store, and so forth. | |
GET Configuration for Automatic Deletion Periods of Alarms
GET op/settings/alarms/alarmDeletionPeriods |
Retrieves configuration for automatic deletion periods of alarms | |
GET Current general logging options
GET op/settings/logging/generalLoggingOptions |
Retrieves current general logging options with log modules names in alphabet case insensitive order. | |
GET Data Pruning Configuration
GET op/settings/data/pruneDataConfig/{tableName} |
Retrieves data pruning configuration for particular table. | |
GET Data Pruning Configuration for Category
GET op/settings/data/pruneDataConfigsByGroup/{category} |
Retrieves data pruning configurations for given category. | |
GET Data Retention Periods
GET op/settings/data/dataRetentionPeriods |
Retrieves data retention periods configured. | |
GET List of WLAN FTP Servers
GET op/settings/servers/ftpServers |
Retrieves the list of FTP servers. | |
GET Mail Server settings
GET op/settings/notification/mailServer |
Retrieves current Mail Server configuration | |
GET SNMP settings
GET op/settings/logging/snmpSettings |
Retrieves SNMP settings. | |
GET Severity and Auto Clear Config
GET op/settings/alarms/severityAutoClearConfig |
Retrieves existing configuration for alarms. Returns tree of alarm types groups containing all alarms with their severities and auto clear ages if configured. | |
GET System log settings
GET op/settings/logging/sysLogSettings |
Retrieves system log settings. | |
POST Add WLAN FTP Server
POST op/settings/servers/ftpServers |
Adds new FTP server. | |
PUT Update Configuration for Automatic Deletion Periods of Alarms
PUT op/settings/alarms/alarmDeletionPeriods |
Updates configuration for automatic deletion periods of alarms | |
PUT Update Data Pruning Configuration
PUT op/settings/data/pruneDataConfig/{tableName} |
Updates data pruning configuration for particular table. | |
PUT Update Data Retention Periods
PUT op/settings/data/dataRetentionPeriods |
Updates configuration of data retention periods. | |
PUT Update Mail Server settings
PUT op/settings/notification/mailServer |
Updates current Mail Server configuration | |
PUT Update SNMP settings
PUT op/settings/logging/snmpSettings |
Updates SNMP settings. | |
PUT Update Severity and Auto Clear Config
PUT op/settings/alarms/severityAutoClearConfig |
Updates alarm settings for passed types changing severities and auto clear ages. | |
PUT Update WLAN FTP Server
PUT op/settings/servers/ftpServers |
Updates an existing FTP server. The server name attribute must match the existing server to be modified, and cannot be changed. | |
PUT Update alarms notification settings
PUT op/settings/notification/alarmCategories |
Updates current alarms notification settings | |
PUT Update basic parameters for the configuration archive
PUT op/settings/inventory/configArchiveBasic |
Updates basic parameters for the configuration archive, such as protocol, timeout value, number of configuration versions to store, and so forth. | |
PUT Update general logging options
PUT op/settings/logging/generalLoggingOptions |
Updates general logging options for passed arguments. | |
PUT Update system log settings
PUT op/settings/logging/sysLogSettings |
Updates system log settings. |
User Management Service
Provides services to create, retrieve, update and delete users
Resource | Description | API Version |
---|---|---|
DELETE Delete user
DELETE op/userManagement/users |
Deletes a user | |
GET Get user groups
GET op/userManagement/userGroups |
Returns list of user groups | |
GET Get users
GET op/userManagement/users |
Returns list of users | |
POST Create user
POST op/userManagement/users |
Creates a new user | |
PUT Update user
PUT op/userManagement/users |
Updates an existing user. User name is used to identify the user to be edited |
Virtual Domains Management Service
Provides services to create, retrieve, update and delete virtual domains
Resource | Description | API Version |
---|---|---|
GET Access Points associated with current Virtual Domain
GET data/VDAssociatedAccessPoints |
Represents an Access Point (Autonomous, Unified or Thirdparty) associated with a virtual domain. | |
GET Dynamic Groups associated with current Virtual Domain
GET data/VDAssociatedDynamicGroups |
Represents a Location or User Defined group assigned to a current virtual domain. Network devices assigned to dynamic groups will be associated with the virtual domain automatically. This API is not intended for ROOT-DOMAIN, for ROOT-DOMAIN the API returns all groups including Device Type groups. | |
GET Groups associated with current Virtual Domain
GET data/VDAssociatedGroups |
Represents a Location or User Defined group explicitly assigned to a current virtual domain. This API is not intended for ROOT-DOMAIN, for ROOT-DOMAIN the API returns all groups including Device Type groups. | |
GET Network Devices associated with current Virtual Domain
GET data/VDAssociatedDevices |
Represents a Network Device associated with a virtual domain. | |
GET Site Maps associated with current Virtual Domain
GET data/VDAssociatedSiteMaps |
Represents a Site Map associated with a virtual domain. | |
GET Virtual Elements associated with current Virtual Domain
GET data/VDAssociatedVirtualElements |
Represents a Virtual Element associated with a virtual domain. | |
DELETE Delete Virtual Domain
DELETE op/vd |
Deletes an existing virtual domain. Fully qualified domain name is used to identify the domain to be deleted | |
GET List Virtual Domains
GET op/vd |
Returns the list of virtual domains | |
POST Create Virtual Domain
POST op/vd |
Creates a new virtual domain | |
PUT Update Virtual Domain
PUT op/vd |
Updates existing virtual domain. Fully qualified domain name is used to identify the domain to be edited |
Wireless Device Details
Resource | Description | API Version |
---|---|---|
GET Historical Radio Interface Load Statistics in Last 24 Hours
GET data/HistoricalRFLoadStats |
Represents load 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 Radio Interface Load Statistics
GET data/RFLoadStats |
Represents the latest load statistics information for radio interfaces of lightweight wireless access points collected from WLAN controllers. |
|
GET Third Party Access Point Summary
GET data/ThirdpartyAccessPoints |
Represents a third party access point. It provides device attributes such as type, version, associated controller, number of associated clients, etc. |