RUCKUS ONE APIs

Overview

This document describes the RUCKUS One public APIs. All RUCKUS One API's are hosted on the mapped subdomain, "api.".

Asynchronous Workflows: In many cases, requests to create or change data is handled asynchronously. In these case the return value from the API call will be the requestId for the activity that was triggered to perform the request. The API consumer will need to:

Read the "requestId" from the response
Poll the activity service with the requestId and wait for SUCCESS using GET /api/tenant/{tenantId}/activity/{requestId}
GET the list of resources to find the item created

RUCKUS One API Hosts

Region	Domain Name
Asia	https://api.asia.ruckus.cloud
Europe	https://api.eu.ruckus.cloud
North America	https://api.ruckus.cloud

Original R1 API Site

If you are looking for the original RUCKUS One API website, it has been removed, as the site was only be maintained until 2/28/2024.

License and Terms of Service

License: RUCKUS One Privacy Policy | Terms of Service APIs published in this document are subject to strict change control by RUCKUS. As far as possible, when new versions of the Public API are published, all documented API endpoints will maintain backward compatibility. When not possible, an API endpoint will be deprecated and a replacement API or some other workaround will be provided. Support for deprecated API endpoints will continue for at least six months prior to removal in order to provide API client developers sufficient time to adopt the replacement. This document will indicate when API endpoints are deprecated along with the schedule for their removal. API client developers may discover other experimental API endpoints provided by RUCKUS One not included in this API document. RUCKUS reserves the right to change these experimental APIs without notice to API client developers.

Upcoming Changes

This section is a short list of the upcoming API changes and features.

API Rate Limiting: API's will start to enforce rate limiting.

Role Based Access: we are adding custom role based access for resources

Rate Limiting

The Ruckus One API's have added rate limiting to several of the APIs. A rate limit is the number of API calls an app or user can make within a given time period. If this limit is exceeded, the app or user may be throttled. API requests made by a throttled user or app will fail. The API will return a 429 to indicate rate limiting has been encountered. Each set of APIs which have rate limiting will identify the limits for those APIs in the API information included with each API section. The rate limit is determined by three key aspects:

The "Key": For Ruckus ONE Core APIs the all rate limiting is per tenant.

How many calls are permitted per minute for each tenant.

How fast the number of calls allowed are restored. To prevent a flood of API requests, rate limiting only allows a fixed number of APIs calls to be restored after the limit is encountered.

Versioning

Ruckus One APIs will support versioning using the Content Negotiation approach, or by deprecating and replacing specific URI's. The format of the versioned content will be: "application/vnd.ruckus.v+json", in addition the most current version of a resource will be supported with "application/json". Only breaking changes will require versioning. The deprecated version will be maintained for a minimum of 6 months and the removal will only occur in March of a given year. Please be aware that current APIs always support "application/json", so changes using the versioning will transition to the latest version of the resource. Please update your use of the API, either to the latest resource, or update to the correct "application/vnd.ruckus.v+json" that you are supporting.

--

API Authentication and JWT

Authenticating

The RUCKUS One REST APIs use JSON Web Tokens (JWT) to secure all endpoints.

Ruckus One authentication APIs are using the OAuth2 client credentials standard APIs, as described here: https://datatracker.ietf.org/doc/html. The API will authenticate a user client and will provide the JWT token.

As part of our ongoing efforts to enhance security and efficiency, we have deprecated the use of the /token authentication API. The /token authentication API will be officially turned down on August 31, 2024. To continue accessing RUCKUS One APIs seamlessly, it is imperative that you transition to using the Java Web Token (JWT) authentication method.

How to Authenticate

Once logged into Ruckus One, the Administrator must create an "Application Token" consisting of client ID, client secret and scope, and can be found under Administration -> Account Management -> Settings.

The following endpoint will be used to authenticate and retrieve the JWT token:

https://{yourRegion.}ruckus.cloud/oauth2/token/{tenantId}

Body of the request must contain: grant_type, client_id, and client_secret

Here is an example with curl:

    curl --request POST \
    --url 'https://ruckus.cloud/oauth2/token/<tenantId>' \
    --header 'content-type: application/x-www-form-urlencoded' \
    --data grant_type=client_credentials \
    --data client_id=<client id> \
    --data client_secret=<client secret>

Once you have acquired your JWT token, it must be included as "Authorization" HTTP request header of all subsequent requests. The format expected in the authentication header is "Bearer xxxxxxa". For additional information on the authentication scheme being used, please see RFC 6750 Section 2.1.

Using the API's in Delegated Mode

To access any REST API for a delegated account, correctly authenticate. Provide your JWT authentication credentials, but in addition, include the custom header with a key of "x-rks-tenantid" and value of tenant id to identify the delegated account. If the request URL specifies the "{tenantId}" as a path parameter, then this needs to be the id for the value of delegated account.

Introduction to MSP & VAR Concepts

Business Entities

The following table describes the type of businesses (aka organizations) that use these API endpoints. Not all endpoints are useful for every business entity.

Abbreviation	Description
REC	RUCKUS end customer. RUCKUS end customers use API endpoints to manage their own account and networks.
VAR	Value-added reseller. VARs can manage the account (including networks) of specific RECs. In order for a VAR to manage an REC's account, the REC must first invite the VAR to manage their account and the VAR must accept the invitation. A successful invitation and acceptance process is modeled by a delegation resource. API endpoints in the "Delegation" API group are used to manage these delegations. In order for a VAR to manage (configure and monitor) an RECâs account using API endpoints, the VARâs API client must log into their own account and then identify the tenant they are acting on by providing the "x-rks-tenantid" to identify the tenant. All API calls will need to include the JWT and the customer header. When a VAR is managing an RECâs network, the VAR may need to install devices in that network on behalf of the REC. Entitlements which the REC has purchased and activated are used for this purpose. VAR accounts can have their own networks, just like an REC has its own networks. API endpoints can be used to manage the VARâs account (including networks) in the same way endpoints are used to manage an RECâs account. A VAR must have their own entitlements to install devices in their own network.
MSP	Managed service provider. MSPs have their own customers, referred to as MSP-ECs, which are not known to RUCKUS. MSPs manage the accounts (including networks) of all their MSP-ECs. MSP-ECs and the resources that represent them are "created" by an MSP. These resources are not visible to any other business entity. MSPs use the endpoints defined in "MSP Services" to configure and brand their business as well as to create and manage MSP-EC resources. Note that MSP to MSP-EC relationships are modeled as a delegation resource (as is done for VARs and RECs). However, MSP to MSP-EC delegation resources are created automatically, requiring no action on the part of an MSP-EC. Moreover, an MSP to MSP-EC delegation cannot be revoked by the MSP-EC. In order for an MSP to manage (configure and monitor) an MSP-ECâs account using API endpoints, the MSPâs API client must obtain an API token for that MSP-EC; an endpoint in the "Manage API Client Authentication" group is used for this purpose (refer to Platform APIs and Model Documentation). MSPs use MSP entitlements (aka bulk licenses) to enable the installation of networking devices in MSP-EC networks. In order to install a networking device, one or more MSP entitlements are assigned to an MSP-EC; this action creates an assignment resource. Once assignment resources are created, devices can be installed. MSP API clients use the endpoints in the "MSP Entitlement" API group to manage their MSP entitlements and assignments. MSP accounts can have their own networks, just like an REC has its own networks. API endpoints can be used to manage the MSPâs account (including networks) in the same way endpoints are used to manage an RECâs account. Note that entitlements (that is, not MSP entitlements) purchased by the MSP are used to install devices in their own networks.
MSP-EC	MSPs end customer. MSP-ECs can use API endpoints to manage their own networks, if permitted by their MSP.

Entitlements/Licenses

Entitlements (aka licenses) are purchased by an account holder and entitle that account to install networking devices in their venues. After purchase, entitlements must be "activated" using the RUCKUS Support website before becoming effective for device installation. There are two classes of entitlements:

Device entitlements, simply referred to as "entitlements", which entitle an account to provision/install one networking device per entitlement.
MSP entitlements, used only by MSPs, are assigned to MSP-EC accounts, enabling the provision/installation of one networking device per assignment in an MSP-EC network.

Introduction to Wi-Fi Workflows

As an introduction to the Wi-Fi API endpoints, a basic workflow to install and configure a Wi-Fi network is described. The order of the following steps is merely an example. The following description is not meant to be comprehensive; rather, it is meant to be a guide to get you started with API client development.

Create a venue for your APs. You can create as many venues as you like. Typically, one venue is created for each building in which you install APs. Or you can use a single "venue" for all the buildings on a campus; alternatively, a "venue" may be just a single floor in a multistory building, or an outdoor park.
Provision your APs. To provision an AP, add the AP using the "Add APs" endpoint found in the AP section. Once your APs are provisioned, physically install them. They will automatically contact and join RUCKUS One. You can physically install your APs prior to provisioning, but they will not join the network until provisioned. In order to install an AP, your account must possess activated licenses. Purchased licenses are activated on the RUCKUS Support website. Use endpoints found under the Entitlements group to manage your entitlements (aka licenses). If you do not have any activated entitlements, the "Add APs" endpoint will return an error response.
Verify your APs have connected to RUCKUS One. To check an AP's connection, use the "Get APs" endpoint in the "AP" API group. The API response provides the AP's connection status. If your APs are having trouble connecting, you can locally log in to your AP and use its troubleshooting utilities to diagnose the problem.
Create a WLAN. Use the endpoints in the "Network" API group to create a WLAN. Note that WLANs are global resources that can be activated in as many venues as you like. Simply creating a WLAN does not deploy it to APs. To deploy the WLAN, it must be "activated" on a venue. Use the endpoints in the "Network-Venue" API group for managing WLAN deployments.
Customize the configuration of your APs. AP configuration can be customized on three different levels:
- All the APs in a venue can be collectively customized using endpoints in the "AP-Venue" API group. On a per-venue basis, you can customize the radio or LAN port settings of your APs, as well as enable and manage mesh networking.
- APs can be grouped together using endpoints in the "AP" Group APIs. Each venue can have one or more AP groups; if you do not explicitly configure AP groups, all APs in a venue are members of the "default" group. Grouping APs is typically done to restrict the deployment of certain WLANs to the APs in a group rather than all the APs in a venue. You may want to do this, for example, to enable only your guest WLAN in the lobby of your venue. Also, using AP groups, WLANs can be enabled on either the 2.4-GHz or 5-GHz band instead of both bands (which is the default). Use the endpoints in the "Network-Venue" API group for managing WLAN (network) assignments to AP groups.
- APs can be individually customized using endpoints in the "AP" API group. On a per-AP basis, you can customize an AP's radio or LAN port settings. Individual AP configurations override group-level and venue-level configurations.
Protect your network. Enable rogue AP detection, configure rogue AP classification policies, and view reports on detected rogue APs. Use the endpoints in the "AP-Venue" API group for this purpose. Note: Once an administrator is informed of the presence of a rogue AP, they can take steps to manually remove it.
Add sophistication to your WLAN. Use the endpoints in the "L2ACL Policy", "L3ACL Policy", "Device Policy", and "Application Policy" API groups to create and manage WLAN policies that manage your wireless clients (end-user devices) and their connections to online services more effectively.
Add new services to your wireless network. Services such as Wi-Fi calling and RUCKUS Location Services (aka vSPoT) are available; they can be configured and managed using the endpoints in their respective API groups. APs can provide DHCP service with sufficient scale for small offices or branch offices; use the endpoints in the "DHCP Configuration Service Profile" to configure the service and endpoints in "Update DHCP Service Profile Settings of This Venue" to activate them on your venues.
Manage your network's client devices. If you have a guest WLAN that uses guest passes, you can create and manage guest users with endpoints in the "Guest User" API group. If you find client devices that should not be on your network, you can disconnect them using an endpoint in the "Clients Control" API.

Switch Information

On RUCKUS One, manage ICX switches deployed with Fastiron firmware version 8.0.95. In this API document, you may read about topics unfamiliar to you; for example, ACLs, LAGs, trusted ports, etc. A thorough treatment of these topics is beyond the scope of this document. However, these topics and more are covered in detail in the Fastiron configuration guides. Links to configuration guides for Fastiron firmware are provided in the following table.

Format	URL
HTML	The complete set of FastIron product guides supporting firmware version 08.0.95 is available on the CommScope Technical Content Portal here: https://docs.commscope.com/bundle?labelkey=fi-08.0.95.
PDF bundle	A zip bundle of all FastIron product guides supporting firmware version 08.0.95 is available on the RUCKUS Support Portal here (~50 MB): https://support.ruckuswireless.com/documents/3446-fastiron-08-0-95-ga-software-documentation-zip.
PDF	Individual PDF configuration guides can be downloaded on the RUCKUS Support Portal by navigating to the RUCKUS ICX product area, https://support.ruckuswireless.com/product_families/21-ruckus-icx-switches, selecting an ICX Model you've deployed, and selecting the "Documentsâ tab.

Introduction to Resident Portal API

As part of the Property management feature, RUCKUS One administrators can create units for each Venue. The Resident Portal APIs enable the unit resident to manage their own devices, DPSKs, and guest access, and their contact information.

The Resident Portal APIs, categorized under API Group "Resident Portal" offer access to device and owner information for a single unit, as defined and created in the Venue Property Management Feature. These APIs serve as a foundation for creating a custom Resident Portal. Both the Resident Portal and the Resident Portal APIs can be disabled with the RUCKUS One UI, or through the Property Configuration APIs, "Selectively Update Property Configuration".

Authentication to the resident portal are provided by a unique key associated to the unit and not the administrative credentials. Consequently, the API provides information and limited control only of aspects respective of the unit. Both the Administrator and the Resident Portal APIs can be used to reset the unique key linked to a particular unit.

Login into the API per Unit. ETo access the Resident portal, APIs on a per unit bases, you will utilize the specific unique key associated to the unit. To initiate this process, make use of the "Resident Portal Login API". This API will return a JSON Web Token (JWT) that will be used in subsequent Resident Portal API calls. The following API groups can be accessed by this mechanism:

Resident Portal Login API: The login APIs.
Resident Portal Configuration: Provides details for the venue that can be presented to the unit owner.
Resident Portal Unit API: Provides unit specific details and allows management of certain properties.
Resident Portal UI Configuration: Provides details on the resident portal UI configuration, like logo, and title information.

API Changelog

The following is a list of changes on the RUCKUS One API. This will cover a comparison of parameters, responses, endpoints and http methods. It will detail "What's New", "What's Deleted", "What's Deprecated" and "What's Changed". It will also detail if a schema change is compatible, or has broken compatibility.

2025-03-13

What's New

`POST` /events/details/query

Get Events Details Like Venue, AP and Network Data

What's Changed

`POST` /events/metas/query

Request:

Changed content type : application/json

Changed property filters (object)

Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

Changed content type : application/vnd.ruckus.v1+json

Changed property filters (object)

Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

`POST` /alarms/metas/query

Request:

Changed content type : application/json

Changed property filters (object)

Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

Changed content type : application/vnd.ruckus.v1+json

Changed property filters (object)

Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

2025-02-28

What's New

`POST` /templates/ethernetPortProfiles/query

Get Ethernet Port Profile Templates

What's Changed

`GET` /clients

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed items (object): > Client
- Added property band (string)
Changed content type : application/vnd.ruckus.v1+json

Changed items (object): > Client
- Added property band (string)

`GET` /clients/{mac}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Added property band (string)
Changed content type : application/vnd.ruckus.v1+json
- Added property band (string)

`POST` /venues/switches/switchPorts/query

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property switchPortProfileName (string)
  - Added property switchPortProfileType (string)
  - Added property errorDisableStatus (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property switchPortProfileName (string)
  - Added property switchPortProfileType (string)
  - Added property errorDisableStatus (string)

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property switchPortProfileName (string)
  - Added property switchPortProfileType (string)
  - Added property errorDisableStatus (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property switchPortProfileName (string)
  - Added property switchPortProfileType (string)
  - Added property errorDisableStatus (string)

`POST` /tunnelServiceProfiles/query

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property natTraversalEnabled (boolean)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property natTraversalEnabled (boolean)

`POST` /switches/ports/query

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property switchPortProfileName (string)
  - Added property switchPortProfileType (string)
  - Added property errorDisableStatus (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property switchPortProfileName (string)
  - Added property switchPortProfileType (string)
  - Added property errorDisableStatus (string)

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property switchPortProfileName (string)
  - Added property switchPortProfileType (string)
  - Added property errorDisableStatus (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property switchPortProfileName (string)
  - Added property switchPortProfileType (string)
  - Added property errorDisableStatus (string)

`POST` /delegations

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property entitlements (array)
  
  Changed items (object):
  - Added property adaptivePolicyCount (string)
  - Added property piNetworkCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property entitlements (array)
  
  Changed items (object):
  - Added property adaptivePolicyCount (string)
  - Added property piNetworkCount (string)

Changed response : 501 Not Implemented

not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property adaptivePolicyCount (string)
    - Added property piNetworkCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property adaptivePolicyCount (string)
    - Added property piNetworkCount (string)

`POST` /wifiNetworks/query

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Added property isEnforced (boolean)
- Added property isManagedByTemplate (boolean)
Changed content type : application/vnd.ruckus.v1+json
- Added property isEnforced (boolean)
- Added property isManagedByTemplate (boolean)

Changed response : 501 Not Implemented

not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property isEnforced (boolean)
  - Added property isManagedByTemplate (boolean)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property isEnforced (boolean)
  - Added property isManagedByTemplate (boolean)

`POST` /venues/switches/query

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property portStatuses (array)
    
    Changed items (object):
    - Added property switchPortProfileName (string)
    - Added property switchPortProfileType (string)
    - Added property errorDisableStatus (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property portStatuses (array)
    
    Changed items (object):
    - Added property switchPortProfileName (string)
    - Added property switchPortProfileType (string)
    - Added property errorDisableStatus (string)

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property portStatuses (array)
    
    Changed items (object):
    - Added property switchPortProfileName (string)
    - Added property switchPortProfileType (string)
    - Added property errorDisableStatus (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property portStatuses (array)
    
    Changed items (object):
    - Added property switchPortProfileName (string)
    - Added property switchPortProfileType (string)
    - Added property errorDisableStatus (string)

`POST` /venues/aps/clients/query

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property band (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property band (string)

Changed response : 501 Not Implemented

not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property band (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property band (string)

`POST` /techpartners/mspecs/query

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property customerCount (integer)
  - Changed property integrator (string)
  - Changed property installer (string)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property adaptivePolicyCount (string)
    - Added property piNetworkCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property customerCount (integer)
  - Changed property integrator (string)
  - Changed property installer (string)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property adaptivePolicyCount (string)
    - Added property piNetworkCount (string)

Changed response : 501 Not Implemented

not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property customerCount (integer)
  - Changed property integrator (string)
  - Changed property installer (string)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property adaptivePolicyCount (string)
    - Added property piNetworkCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property customerCount (integer)
  - Changed property integrator (string)
  - Changed property installer (string)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property adaptivePolicyCount (string)
    - Added property piNetworkCount (string)

`POST` /mspecs/query

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property customerCount (integer)
  - Changed property integrator (string)
  - Changed property installer (string)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property adaptivePolicyCount (string)
    - Added property piNetworkCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property customerCount (integer)
  - Changed property integrator (string)
  - Changed property installer (string)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property adaptivePolicyCount (string)
    - Added property piNetworkCount (string)

Changed response : 501 Not Implemented

not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property customerCount (integer)
  - Changed property integrator (string)
  - Changed property installer (string)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property adaptivePolicyCount (string)
    - Added property piNetworkCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property customerCount (integer)
  - Changed property integrator (string)
  - Changed property installer (string)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property adaptivePolicyCount (string)
    - Added property piNetworkCount (string)

`POST` /guestUsers/query

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property clients (array)
    
    Changed items (object):
    - Added property band (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property clients (array)
    
    Changed items (object):
    - Added property band (string)

`POST` /clientIsolationProfiles/query

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Deleted property venueActivations (array)
  - Deleted property apActivations (array)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Deleted property venueActivations (array)
  - Deleted property apActivations (array)

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Deleted property venueActivations (array)
  - Deleted property apActivations (array)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Deleted property venueActivations (array)
  - Deleted property apActivations (array)

`POST` /venues/switches/aggregationDetails

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property switchPortProfileName (string)
      - Added property switchPortProfileType (string)
      - Added property errorDisableStatus (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property switchPortProfileName (string)
      - Added property switchPortProfileType (string)
      - Added property errorDisableStatus (string)

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property switchPortProfileName (string)
      - Added property switchPortProfileType (string)
      - Added property errorDisableStatus (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property switchPortProfileName (string)
      - Added property switchPortProfileType (string)
      - Added property errorDisableStatus (string)

`POST` /switches/aggregationDetails

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property switchPortProfileName (string)
      - Added property switchPortProfileType (string)
      - Added property errorDisableStatus (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property switchPortProfileName (string)
      - Added property switchPortProfileType (string)
      - Added property errorDisableStatus (string)

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property switchPortProfileName (string)
      - Added property switchPortProfileType (string)
      - Added property errorDisableStatus (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property switchPortProfileName (string)
      - Added property switchPortProfileType (string)
      - Added property errorDisableStatus (string)

2025-02-18

What's New

`PUT` /identityGroups/{id}/macRegistrationPools/{poolId}

Update the MAC Registration Association for Identity Group

`PUT` /identityGroups/{id}/dpskPools/{dpskPoolId}

Update the DPSK Pool Association for Identity Group

`PUT` /identityGroups/{groupId}/identities/{id}/venues/{venueId}/ethernetPorts

Update Ethernet Ports for the Identity

`GET` /identityGroups

Returns the Identity Groups

`POST` /identityGroups

Create an Identity Group

`GET` /identityGroups/{groupId}/identities

Returns the Identities in a Specific Group

`POST` /identityGroups/{groupId}/identities

Create an Identity Into a Specific Group

`DELETE` /identityGroups/{groupId}/identities

Delete the Specific Identities in a Group

`POST` /identityGroups/{groupId}/identities/{id}/devices

Create Devices Into the Identity

`POST` /identityGroups/{groupId}/identities/csvFile

Import Identities Into the Specified Identity Group

`POST` /identityGroups/query

Query the Identity Groups

`POST` /identityGroups/csvFile

Export the Identity Groups Into a CSV File

`POST` /identities/query

Query Identities

`POST` /identities/csvFile

Export the Identities Into a CSV File

`GET` /identityGroups/{id}

Returns the Specific Identity Group

`DELETE` /identityGroups/{id}

Delete the Identity Group

`PATCH` /identityGroups/{id}

Update the Identity Group

`GET` /identityGroups/{groupId}/identities/{id}

Returns the Identity

`DELETE` /identityGroups/{groupId}/identities/{id}

Delete the Identity

`PATCH` /identityGroups/{groupId}/identities/{id}

Update the Identity

`GET` /identities

Returns Identities in All Groups

`DELETE` /identityGroups/{groupId}/identities/{id}/vnis

Retry the VNI Allocation for the Identity

`DELETE` /identityGroups/{groupId}/identities/{id}/ethernetPorts/{macAddress}/{portIndex}

Delete the Ethernet Port from the Identity

`DELETE` /identityGroups/{groupId}/identities/{id}/devices/{macAddress}

Delete the Device from the Identity

2025-02-10

What's New

`POST` /tenants/{tenantId}/entitlements/assignments/query

Get Entitlements Assignments

`POST` /tenants/self/entitlements/assignments

Create a Self Assignment

`POST` /tenants/self/entitlements/assignments/query

Get Self Entitlement Assignment

`POST` /entitlements/utilizations/query

Get Entitlements Utilization Summaries

`POST` /entitlements/query

Get Entitlements

`POST` /entitlements/mileageReports/query

Query License Mileage Report

`POST` /entitlements/compliances/query

Get Compliance

`POST` /entitlements/banners/query

Get Entitlements Banners

`POST` /entitlements/availabilityReports/query

Query Availability Reports

`POST` /entitlements/attentionNotes/query

Query License Attention Notes

`DELETE` /tenants/self/entitlements/assignments/{id}

Delete Self Assignment

`PATCH` /tenants/self/entitlements/assignments/{id}

Update a Self Assignment

`PUT` /portalServiceProfiles/{portalServiceProfileId}/poweredImages

Update Portal Service Profile Powered Image

`PUT` /portalServiceProfiles/{portalServiceProfileId}/photos

Update Portal Service Profile Photo

`PUT` /portalServiceProfiles/{portalServiceProfileId}/logos

Update Portal Service Profile Logo

`PUT` /portalServiceProfiles/{portalServiceProfileId}/backgroundImages

Update Portal Service Profile Background Image

`POST` /wifiNetworks/{wifiNetworkId}/guestUsers

Add Guest User

`PATCH` /wifiNetworks/{wifiNetworkId}/guestUsers

Guest User Action

`GET` /wifiNetworks/{wifiNetworkId}/guestUsers/{guestUserId}

Get Guest User by ID

`DELETE` /wifiNetworks/{wifiNetworkId}/guestUsers/{guestUserId}

Delete Guest User by ID

`PATCH` /wifiNetworks/{wifiNetworkId}/guestUsers/{guestUserId}

Update Guest User

`POST` /wifiNetworks/query

Get Wi-Fi Networks Data

`POST` /wifiCallingServiceProfiles/query

Get Wifi Calling Profiles

`POST` /vlanPoolProfiles/query

Query VLAN Pool Profiles

`POST` /venues/aps/query

Get APs

`POST` /venues/aps/clients/query

Query AP Clients

`POST` /venues/apGroups/query

Query AP Groups

`POST` /syslogServerProfiles/query

Get Syslog Server Profiles

`POST` /softGreProfiles/query

Query SoftGRE Profiles

`POST` /snmpAgentProfiles/query

Query SNMP Agent Profiles

`POST` /roguePolicies/query

Get Rogue Policies

`POST` /radiusServerProfiles/query

Get RADIUS Server Profiles

`POST` /multicastDnsProxyProfiles/query

Get Multicast DNS Proxy Profiles

`POST` /lbsServerProfiles/query

Get Location Based Service Server Profiles

`POST` /l3AclPolicies/query

Get Layer Three Policies

`POST` /l2AclPolicies/query

Get Layer Two Policies

`POST` /hotspot20Operators/query

Get Hotspot 2.0 Operators

`POST` /hotspot20IdentityProviders/query

Get Hotspot 2.0 Identity Providers

`POST` /ethernetPortProfiles/query

Get Ethernet Port Profiles

`POST` /edgeSdLanServices/query

Get RUCKUS Edge SD-LANs

`POST` /dhcpConfigServiceProfiles/query

Get DHCP Configuration Service Profiles

`POST` /devicePolicies/query

Get Device Policies

`POST` /clientIsolationProfiles/query

Query Client Isolation Profiles

`POST` /applicationPolicies/query

Get Application Policies

`POST` /accessControlProfiles/query

Get Access Control Profiles

`PUT` /accessControlProfiles/{accessControlProfileId}/applicationPolicies/{applicationPolicyId}

Activate Application Policy On Access Control Profile

`DELETE` /accessControlProfiles/{accessControlProfileId}/applicationPolicies/{applicationPolicyId}

Deactivate Application Policy On Access Control Profile

`PUT` /accessControlProfiles/{accessControlProfileId}/devicePolicies/{devicePolicyId}

Activate Device Policy On Access Control Profile

`DELETE` /accessControlProfiles/{accessControlProfileId}/devicePolicies/{devicePolicyId}

Deactivate Device Policy On Access Control Profile

`PUT` /accessControlProfiles/{accessControlProfileId}/l2AclPolicies/{l2AclPolicyId}

Activate Layer-2 ACL Policy On Access Control Profile

`DELETE` /accessControlProfiles/{accessControlProfileId}/l2AclPolicies/{l2AclPolicyId}

Deactivate Layer-2 ACL Policy On Access Control Profile

`PUT` /accessControlProfiles/{accessControlProfileId}/l3AclPolicies/{l3AclPolicyId}

Activate Layer-3 ACL Policy On Access Control Profile

`DELETE` /accessControlProfiles/{accessControlProfileId}/l3AclPolicies/{l3AclPolicyId}

Deactivate Layer-3 ACL Policy On Access Control Profile

`GET` /applicationLibraries/{applicationLibraryId}/categories

Get Application Library Categories

`GET` /applicationLibraries/{applicationLibraryId}/categories/{categoryId}/applications

Get Application Library Applications

`GET` /applicationLibrarySettings

Get Application Library Settings

`PATCH` /applicationLibrarySettings

Patch Application Library Settings

`POST` /clientIsolationProfiles

Create Client Isolation Profile

`GET` /clientIsolationProfiles/{clientIsolationProfileId}

Get Client Isolation Profile

`PUT` /clientIsolationProfiles/{clientIsolationProfileId}

Update Client Isolation Profile

`DELETE` /clientIsolationProfiles/{clientIsolationProfileId}

Delete Client Isolation Profile

`POST` /hotspot20IdentityProviders

Add Hotspot 2.0 Identity Provider

`GET` /hotspot20IdentityProviders/{hotspot20IdentityProviderId}

Get Hotspot 2.0 Identity Provider

`PUT` /hotspot20IdentityProviders/{hotspot20IdentityProviderId}

Update Hotspot 2.0 Identity Provider

`DELETE` /hotspot20IdentityProviders/{hotspot20IdentityProviderId}

Delete Hotspot 2.0 Identity Provider

`PUT` /hotspot20IdentityProviders/{hotspot20IdentityProviderId}/radiusServerProfiles/{radiusId}

Activate RADIUS Server Profile On Hotspot 2.0 Identity Provider

`DELETE` /hotspot20IdentityProviders/{hotspot20IdentityProviderId}/radiusServerProfiles/{radiusId}

Deactivate RADIUS Server Profile On Hotspot 2.0 Identity Provider

`POST` /hotspot20Operators

Create Hotspot 2.0 Operator

`GET` /hotspot20Operators/{hotspot20OperatorId}

Get Hotspot 2.0 Operator

`PUT` /hotspot20Operators/{hotspot20OperatorId}

Update Hotspot 2.0 Operator

`DELETE` /hotspot20Operators/{hotspot20OperatorId}

Delete Hotspot 2.0 Operator

`POST` /lbsServerProfiles

Create Location Based Service Server Profile

`GET` /lbsServerProfiles/{lbsServerProfileId}

Get Location Based Service Server Profile

`PUT` /lbsServerProfiles/{lbsServerProfileId}

Update Location Based Service Server Profile

`DELETE` /lbsServerProfiles/{lbsServerProfileId}

Delete Location Based Service Server Profile

`POST` /multicastDnsProxyProfiles

Create Multicast DNS Proxy Service Profile

`GET` /multicastDnsProxyProfiles/{multicastDnsProxyProfileId}

Get Multicast DNS Proxy Service Profile

`PUT` /multicastDnsProxyProfiles/{multicastDnsProxyProfileId}

Update Multicast DNS Proxy Service Profile

`DELETE` /multicastDnsProxyProfiles/{multicastDnsProxyProfileId}

Delete Multicast DNS Proxy Service Profile

`GET` /networks/qosMapSets

Get Default Rules for QoS Map Set

`POST` /roguePolicies

Create Rogue AP Detection Policy

`GET` /roguePolicies/{roguePolicyId}

Get Rogue AP Detection Policy

`PUT` /roguePolicies/{roguePolicyId}

Update Rogue AP Detection Policy

`DELETE` /roguePolicies/{roguePolicyId}

Delete Rogue AP Detection Policy

`POST` /snmpAgentProfiles

Create SNMP Agent Profile

`GET` /snmpAgentProfiles/{snmpAgentProfileId}

Get SNMP Agent Profile

`PUT` /snmpAgentProfiles/{snmpAgentProfileId}

Update SNMP Agent Profile

`DELETE` /snmpAgentProfiles/{snmpAgentProfileId}

Delete SNMP Agent Profile

`POST` /softGreProfiles

Add SoftGRE Profile

`GET` /softGreProfiles/{softGreProfileId}

Get SoftGRE Profile

`PUT` /softGreProfiles/{softGreProfileId}

Update SoftGRE Profile

`DELETE` /softGreProfiles/{softGreProfileId}

Delete SoftGRE Profile

`POST` /tunnelServiceProfiles

Add Tunnel Service Profile

`GET` /tunnelServiceProfiles/{tunnelServiceProfileId}

Get Tunnel Service Profile

`PUT` /tunnelServiceProfiles/{tunnelServiceProfileId}

Update Tunnel Service Profile

`DELETE` /tunnelServiceProfiles/{tunnelServiceProfileId}

Delete Tunnel Service Profile

`PATCH` /tunnelServiceProfiles/{tunnelServiceProfileId}

Partial Update Tunnel Service Profile

`GET` /venues/apAvailableLteBands

Get Available LTE Bands

`GET` /venues/apModelCapabilities

Get Venue All AP-Model Capabilities

`GET` /venues/aps/{serialNumber}/bssColoringSettings

Get AP Basic Service Set Coloring Settings

`PUT` /venues/aps/{serialNumber}/bssColoringSettings

Update AP Basic Service Set Coloring Settings

`GET` /venues/aps/{serialNumber}/clientAdmissionControlSettings

Get AP Client Admission Control Settings

`PUT` /venues/aps/{serialNumber}/clientAdmissionControlSettings

Update AP Client Admission Control Settings

`DELETE` /venues/aps/{serialNumber}/clientAdmissionControlSettings

Reset AP Client Admission Control Settings

`GET` /venues/aps/{serialNumber}/ledSettings

Get AP LED

`PUT` /venues/aps/{serialNumber}/ledSettings

Update AP LED

`DELETE` /venues/aps/{serialNumber}/ledSettings

Reset AP LED

`GET` /venues/aps/{serialNumber}/meshSettings

Get AP Mesh Settings

`PUT` /venues/aps/{serialNumber}/meshSettings

Update AP Mesh Settings

`GET` /venues/{venueId}/apBssColoringSettings

Get Venue Basic Service Set Coloring Settings

`PUT` /venues/{venueId}/apBssColoringSettings

Update Venue Basic Service Set Coloring Settings

`GET` /venues/{venueId}/apCellularSettings

Get Venue AP-Model Cellular

`PUT` /venues/{venueId}/apCellularSettings

Update Venue AP-Model Cellular

`GET` /venues/{venueId}/apClientAdmissionControlSettings

Get Venue Client Admission Control Settings

`PUT` /venues/{venueId}/apClientAdmissionControlSettings

Update Venue Client Admission Control Settings

`GET` /venues/{venueId}/apDirectedMulticastSettings

Get Venue Directed Multicast Settings

`PUT` /venues/{venueId}/apDirectedMulticastSettings

Update Venue Directed Multicast Settings

`GET` /venues/{venueId}/apDosProtectionSettings

Get Venue DoS Protection

`PUT` /venues/{venueId}/apDosProtectionSettings

Update Venue DoS Protection

`GET` /venues/{venueId}/apGroups/{apGroupId}

Get AP Group

`PUT` /venues/{venueId}/apGroups/{apGroupId}

Update AP Group

`DELETE` /venues/{venueId}/apGroups/{apGroupId}

Delete AP Group

`POST` /venues/{venueId}/apGroups/{apGroupId}/aps

Add AP with AP Group

`PUT` /venues/{venueId}/apGroups/{apGroupId}/aps/{serialNumber}

Move AP Into AP Group

`GET` /venues/{venueId}/apIpModeSettings

Get Venue IP Mode Settings for APs

`PUT` /venues/{venueId}/apIpModeSettings

Update Venue IP Mode Settings for APs

`GET` /venues/{venueId}/apLoadBalancingSettings

Get Venue Load Balancing Settings

`PUT` /venues/{venueId}/apLoadBalancingSettings

Update Venue Load Balancing Settings

`GET` /venues/{venueId}/apManagementTrafficVlanSettings

Get Venue AP Management VLAN Settings

`PUT` /venues/{venueId}/apManagementTrafficVlanSettings

Update Venue AP Management VLAN Settings

`GET` /venues/{venueId}/apMeshSettings

Get Mesh Settings

`PUT` /venues/{venueId}/apMeshSettings

Update Mesh

`GET` /venues/{venueId}/apModelAntennaTypeSettings

Get Venue Antenna Type

`PUT` /venues/{venueId}/apModelAntennaTypeSettings

Update Venue Antenna Type

`GET` /venues/{venueId}/apModelBandModeSettings

Get Venue Band Mode

`PUT` /venues/{venueId}/apModelBandModeSettings

Update Venue Band Mode

`GET` /venues/{venueId}/apModelCapabilities

Get Venue AP-Model Capabilities

`GET` /venues/{venueId}/apModelExternalAntennaSettings

Get Venue AP Model External Antenna Settings

`PUT` /venues/{venueId}/apModelExternalAntennaSettings

Update Venue AP Model External Antenna Settings

`GET` /venues/{venueId}/apModelLanPortSettings

Get Venue LAN-Ports

`PUT` /venues/{venueId}/apModelLanPortSettings

Update Venue LAN-Ports

`GET` /venues/{venueId}/apModelLedSettings

Get Venue LED

`PUT` /venues/{venueId}/apModelLedSettings

Update Venue LED

`GET` /venues/{venueId}/apMulticastDnsFencingSettings

Get Venue Multicast DNS Fencing Settings

`PUT` /venues/{venueId}/apMulticastDnsFencingSettings

Update Venue Multicast DNS Fencing Settings

`GET` /venues/{venueId}/apRadioSettings

Get Venue Radio

`PUT` /venues/{venueId}/apRadioSettings

Update Venue Radio

`GET` /venues/{venueId}/apRadiusOptions

Get Venue RADIUS Options Settings

`PUT` /venues/{venueId}/apRadiusOptions

Update Venue RADIUS Options Settings

`GET` /venues/{venueId}/apSmartMonitorSettings

Get Venue Smart Monitor Settings

`PUT` /venues/{venueId}/apSmartMonitorSettings

Update Venue Smart Monitor Settings

`GET` /venues/{venueId}/apTlsKeyEnhancedSettings

Get Venue Transport Layer Security KEY Enhanced Mode Settings for APs

`PUT` /venues/{venueId}/apTlsKeyEnhancedSettings

Update Venue Transport Layer Security KEY Enhanced Mode Settings for APs

`POST` /venues/{venueId}/aps

Add AP or Import APs

`GET` /venues/{venueId}/aps/importResults

Get Import Venue APs Results

`PUT` /venues/{venueId}/aps/{apSerialNumber}/multicastDnsProxyProfiles/{multicastDnsProxyProfileId}

Activate Multicast DNS Proxy Service Profile On the AP

`DELETE` /venues/{venueId}/aps/{apSerialNumber}/multicastDnsProxyProfiles/{multicastDnsProxyProfileId}

Deactivate Multicast DNS Proxy Service Profile On the AP

`GET` /venues/{venueId}/aps/{serialNumber}

Get AP

`PUT` /venues/{venueId}/aps/{serialNumber}

Update AP

`DELETE` /venues/{venueId}/aps/{serialNumber}

Delete AP

`GET` /venues/{venueId}/aps/{serialNumber}/bandModeSettings

Get AP Band Mode

`PUT` /venues/{venueId}/aps/{serialNumber}/bandModeSettings

Update AP Band Mode

`GET` /venues/{venueId}/aps/{serialNumber}/bssColoringSettings

Get AP Basic Service Set Coloring Settings

`PUT` /venues/{venueId}/aps/{serialNumber}/bssColoringSettings

Update AP Basic Service Set Coloring Settings

`GET` /venues/{venueId}/aps/{serialNumber}/capabilities

Get AP Capabilities

`GET` /venues/{venueId}/aps/{serialNumber}/clientAdmissionControlSettings

Get AP Client Admission Control Settings

`PUT` /venues/{venueId}/aps/{serialNumber}/clientAdmissionControlSettings

Update AP Client Admission Control Settings

`PATCH` /venues/{venueId}/aps/{serialNumber}/clients/{clientMacAddress}

Patch AP Client

`GET` /venues/{venueId}/aps/{serialNumber}/dhcpSettings

Get AP DHCP Settings

`PATCH` /venues/{venueId}/aps/{serialNumber}/diagnosisCommands

Trigger AP Diagnosis Commands

`GET` /venues/{venueId}/aps/{serialNumber}/directedMulticastSettings

Get AP Directed Multicast Settings

`PUT` /venues/{venueId}/aps/{serialNumber}/directedMulticastSettings

Update AP Directed Multicast Settings

`GET` /venues/{venueId}/aps/{serialNumber}/externalAntennaSettings

Get AP External Antenna Settings

`PUT` /venues/{venueId}/aps/{serialNumber}/externalAntennaSettings

Update AP External Antenna Settings

`GET` /venues/{venueId}/aps/{serialNumber}/lanPortSettings

Get AP LAN-Ports

`PUT` /venues/{venueId}/aps/{serialNumber}/lanPortSettings

Update AP LAN-Ports

`GET` /venues/{venueId}/aps/{serialNumber}/ledSettings

Get AP LED

`PUT` /venues/{venueId}/aps/{serialNumber}/ledSettings

Update AP LED

`GET` /venues/{venueId}/aps/{serialNumber}/logs

Get the AP Log Info

`GET` /venues/{venueId}/aps/{serialNumber}/managementTrafficVlanSettings

Get AP Management Traffic VLAN Settings

`PUT` /venues/{venueId}/aps/{serialNumber}/managementTrafficVlanSettings

Update AP Management Traffic VLAN Settings

`GET` /venues/{venueId}/aps/{serialNumber}/meshSettings

Get AP Mesh Settings

`PUT` /venues/{venueId}/aps/{serialNumber}/meshSettings

Update AP Mesh Settings

`PATCH` /venues/{venueId}/aps/{serialNumber}/neighbors

Patch AP Neighbors

`POST` /venues/{venueId}/aps/{serialNumber}/neighbors/query

Query AP Neighbors

`GET` /venues/{venueId}/aps/{serialNumber}/networkSettings

Get AP Network Settings

`PUT` /venues/{venueId}/aps/{serialNumber}/networkSettings

Update AP Network Settings

`GET` /venues/{venueId}/aps/{serialNumber}/packets

Get AP Packets

`PATCH` /venues/{venueId}/aps/{serialNumber}/packets

Patch AP Packets

`GET` /venues/{venueId}/aps/{serialNumber}/pictures

Get AP Pictures

`PUT` /venues/{venueId}/aps/{serialNumber}/pictures

Update AP Pictures

`DELETE` /venues/{venueId}/aps/{serialNumber}/pictures

Delete AP Pictures

`GET` /venues/{venueId}/aps/{serialNumber}/radioSettings

Get AP Radio

`PUT` /venues/{venueId}/aps/{serialNumber}/radioSettings

Update AP Radio

`GET` /venues/{venueId}/aps/{serialNumber}/smartMonitorSettings

Get AP Smart Monitor Settings

`PUT` /venues/{venueId}/aps/{serialNumber}/smartMonitorSettings

Update AP Smart Monitor Settings

`GET` /venues/{venueId}/aps/{serialNumber}/snmpAgentProfileSettings

Get SNMP Agent Profile Settings On AP

`PUT` /venues/{venueId}/aps/{serialNumber}/snmpAgentProfileSettings

Update SNMP Agent Profile Settings On AP

`PUT` /venues/{venueId}/aps/{serialNumber}/snmpAgentProfiles/{snmpAgentProfileId}

Activate SNMP Agent Profile On AP

`DELETE` /venues/{venueId}/aps/{serialNumber}/snmpAgentProfiles/{snmpAgentProfileId}

Deactivate SNMP Agent Profile On AP

`PUT` /venues/{venueId}/aps/{serialNumber}/stickyClientSteeringSettings

Update AP Sticky Client Steering Settings

`DELETE` /venues/{venueId}/aps/{serialNumber}/stickyClientSteeringSettings

Reset AP Sticky Client Steering Settings

`PATCH` /venues/{venueId}/aps/{serialNumber}/systemCommands

Trigger AP System Commands

`GET` /venues/{venueId}/aps/{serialNumber}/wifiAvailableChannels

Get AP Available Channels

`GET` /venues/{venueId}/aps/{serialNumber}/wifiDhcpClientLeases

Get AP DHCP Client Leases

`GET` /venues/{venueId}/aps/{serialNumber}/wifiDhcpPoolUsages

Get DHCP Pools Usage in This AP

`GET` /venues/{venueId}/bssColoringSettings

Get Venue Basic Service Set Coloring Settings

`PUT` /venues/{venueId}/bssColoringSettings

Update Venue Basic Service Set Coloring Settings

`GET` /venues/{venueId}/clientAdmissionControlSettings

Get Venue Client Admission Control Settings

`PUT` /venues/{venueId}/clientAdmissionControlSettings

Update Venue Client Admission Control Settings

`GET` /venues/{venueId}/dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId}

Get DHCP Service Profile Settings of This Venue

`PUT` /venues/{venueId}/dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId}

Activate DHCP Configuration Service Profile On This Venue and Update Settings

`DELETE` /venues/{venueId}/dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId}

Deactivate DHCP Configuration Service Profile On This Venue

`GET` /venues/{venueId}/floorplans/{floorplanId}/aps/{serialNumber}/floorPositions

Get AP Floor Position

`PUT` /venues/{venueId}/floorplans/{floorplanId}/aps/{serialNumber}/floorPositions

Activate AP Floor Position

`DELETE` /venues/{venueId}/floorplans/{floorplanId}/aps/{serialNumber}/floorPositions

Deactivate AP Floor Position

`PUT` /venues/{venueId}/lbsServerProfiles/{lbsServerProfileId}

Activate Location Based Service Server Profile On Venue

`DELETE` /venues/{venueId}/lbsServerProfiles/{lbsServerProfileId}

Deactivate Location Based Service Server Profile On Venue

`PUT` /venues/{venueId}/roguePolicies/{roguePolicyId}

Activate Rogue AP Detection Policy On Venue

`DELETE` /venues/{venueId}/roguePolicies/{roguePolicyId}

Deactivate Rogue AP Detection Policy On Venue

`GET` /venues/{venueId}/roguePolicySettings

Get Venue Rogue Policy Settings

`PUT` /venues/{venueId}/roguePolicySettings

Update Venue Rogue Policy Settings

`PUT` /venues/{venueId}/snmpAgentProfiles/{snmpAgentProfileId}

Activate SNMP Agent Profile On Venue

`DELETE` /venues/{venueId}/snmpAgentProfiles/{snmpAgentProfileId}

Deactivate SNMP Agent Profile On Venue

`PUT` /venues/{venueId}/syslogServerProfiles/{syslogServerProfileId}

Activate Syslog Server Profile On Venue

`DELETE` /venues/{venueId}/syslogServerProfiles/{syslogServerProfileId}

Deactivate Syslog Server Profile On Venue

`GET` /venues/{venueId}/wifiAvailableChannels

Get Venue Available Channels

`GET` /venues/{venueId}/wifiDhcpClientLeases

Get Venue DHCP Leases

`GET` /venues/{venueId}/wifiDhcpPoolUsages

Get DHCP Pools Usage in Venue

`PUT` /venues/{venueId}/wifiNetworks/{wifiNetworkId}

Activate Wi-Fi Network On Venue

`DELETE` /venues/{venueId}/wifiNetworks/{wifiNetworkId}

Deactivate Wi-Fi Network On Venue

`PUT` /venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}

Activate AP Group On Wi-Fi Network

`DELETE` /venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}

Deactivate AP Group On Wi-Fi Network

`GET` /venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}/settings

Get AP Group Settings On Wi-Fi Network

`PUT` /venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}/settings

Update AP Group Settings On Wi-Fi Network

`PUT` /venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}/vlanPoolProfiles/{vlanPoolProfileId}

Activate VLAN Pool Profile On AP Group

`DELETE` /venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}/vlanPoolProfiles/{vlanPoolProfileId}

Deactivate VLAN Pool Profile On AP Group

`PUT` /venues/{venueId}/wifiNetworks/{wifiNetworkId}/clientIsolationProfiles/{clientIsolationProfileId}

Activate Client Isolation Profile On Wi-Fi Network

`DELETE` /venues/{venueId}/wifiNetworks/{wifiNetworkId}/clientIsolationProfiles/{clientIsolationProfileId}

Deactivate Client Isolation Profile On Wi-Fi Network

`GET` /venues/{venueId}/wifiNetworks/{wifiNetworkId}/settings

Get Venue Wi-Fi Network Settings

`PUT` /venues/{venueId}/wifiNetworks/{wifiNetworkId}/settings

Update Venue Wi-Fi Network Settings

`PUT` /venues/{venueId}/wifiNetworks/{wifiNetworkId}/softGreProfiles/{softGreProfileId}

Activate SoftGRE Profile On Venue Wi-Fi Network

`DELETE` /venues/{venueId}/wifiNetworks/{wifiNetworkId}/softGreProfiles/{softGreProfileId}

Deactivate SoftGRE Profile On Venue Wi-Fi Network

`POST` /vlanPoolProfiles

Add VLAN Pool Profile

`GET` /vlanPoolProfiles/{vlanPoolProfileId}

Get VLAN Pool

`PUT` /vlanPoolProfiles/{vlanPoolProfileId}

Update VLAN Pool Profile

`DELETE` /vlanPoolProfiles/{vlanPoolProfileId}

Delete VLAN Pool Profile

`POST` /wifiNetworks

Create Wi-Fi Network

`GET` /wifiNetworks/hotspot20IdentityProviders

Get Predefined Hotspot 2.0 Identity Providers

`GET` /wifiNetworks/hotspot20Operators

Get Predefined Hotspot 2.0 Operators

`GET` /wifiNetworks/qosMapSetOptions

Get Default Options for QoS Map Set

`GET` /wifiNetworks/recoveryPassphraseSettings

Get Wi-Fi Recovery Network Passphrase Settings

`PUT` /wifiNetworks/recoveryPassphraseSettings

Update Wi-Fi Recovery Network Passphrase Settings

`GET` /wifiNetworks/wisprProviders

Get External WISPr Providers

`GET` /wifiNetworks/{wifiNetworkId}

Get Wi-Fi Network

`PUT` /wifiNetworks/{wifiNetworkId}

Update Wi-Fi Network

`DELETE` /wifiNetworks/{wifiNetworkId}

Delete Wi-Fi Network

`PUT` /wifiNetworks/{wifiNetworkId}/accessControlProfiles/{accessControlProfileId}

Activate Access Control Profile On Wi-Fi Network

`DELETE` /wifiNetworks/{wifiNetworkId}/accessControlProfiles/{accessControlProfileId}

Deactivate Access Control Profile On Wi-Fi Network

`PUT` /wifiNetworks/{wifiNetworkId}/applicationPolicies/{applicationPolicyId}

Activate Application Policy On Wifi Network

`DELETE` /wifiNetworks/{wifiNetworkId}/applicationPolicies/{applicationPolicyId}

Deactivate Application Policy On Wifi Network

`PUT` /wifiNetworks/{wifiNetworkId}/devicePolicies/{policyId}

Activate Device Policy On Wi-Fi Network

`DELETE` /wifiNetworks/{wifiNetworkId}/devicePolicies/{policyId}

Deactivate Device Policy On Wi-Fi Network

`PUT` /wifiNetworks/{wifiNetworkId}/dpskServices/{dpskServiceId}

Activate DPSK Service On Wi-Fi Network

`PUT` /wifiNetworks/{wifiNetworkId}/hotspot20IdentityProviders/{hotspot20IdentityProviderId}

Activate Hotspot 2.0 Identity Provider On Wi-Fi Network

`DELETE` /wifiNetworks/{wifiNetworkId}/hotspot20IdentityProviders/{hotspot20IdentityProviderId}

Deactivate Hotspot 2.0 Identity Provider On Wi-Fi Network

`PUT` /wifiNetworks/{wifiNetworkId}/hotspot20Operators/{hotspot20OperatorId}

Activate Hotspot 2.0 Operator On Wi-Fi Network

`DELETE` /wifiNetworks/{wifiNetworkId}/hotspot20Operators/{hotspot20OperatorId}

Deactivate Hotspot 2.0 Operator On Wi-Fi Network

`PUT` /wifiNetworks/{wifiNetworkId}/l2AclPolicies/{l2AclPolicyId}

Activate Layer-2 ACL Policy On Wi-Fi Network

`DELETE` /wifiNetworks/{wifiNetworkId}/l2AclPolicies/{l2AclPolicyId}

Deactivate Layer-2 ACL Policy On Wi-Fi Network

`PUT` /wifiNetworks/{wifiNetworkId}/l3AclPolicies/{l3AclPolicyId}

Activate Layer-3 ACL Policy On Wi-Fi Network

`DELETE` /wifiNetworks/{wifiNetworkId}/l3AclPolicies/{l3AclPolicyId}

Deactivate Layer-3 ACL Policy On Wi-Fi Network

`PUT` /wifiNetworks/{wifiNetworkId}/macRegistrationPools/{macRegistrationPoolId}

Activate MAC Registration Pool On Wi-Fi Network

`DELETE` /wifiNetworks/{wifiNetworkId}/macRegistrationPools/{macRegistrationPoolId}

Deactivate MAC Registration Pool On Wi-Fi Network

`PUT` /wifiNetworks/{wifiNetworkId}/portalServiceProfiles/{portalServiceProfileId}

Activate Portal Service Profile On Wi-Fi Network

`GET` /wifiNetworks/{wifiNetworkId}/radiusServerProfileSettings

Get RADIUS Server Profile Settings On Wi-Fi Network

`PUT` /wifiNetworks/{wifiNetworkId}/radiusServerProfileSettings

Update RADIUS Server Profile Settings On Wi-Fi Network

`PUT` /wifiNetworks/{wifiNetworkId}/radiusServerProfiles/{radiusId}

Activate RADIUS Server Profile On Wi-Fi Network

`DELETE` /wifiNetworks/{wifiNetworkId}/radiusServerProfiles/{radiusId}

Deactivate RADIUS Server Profile On Wi-Fi Network

`PUT` /wifiNetworks/{wifiNetworkId}/vlanPoolProfiles/{vlanPoolProfileId}

Activate VLAN Pool Profile On Wi-Fi Network

`DELETE` /wifiNetworks/{wifiNetworkId}/vlanPoolProfiles/{vlanPoolProfileId}

Deactivate VLAN Pool Profile On Wi-Fi Network

`PUT` /wifiNetworks/{wifiNetworkId}/wifiCallingServiceProfiles/{wifiCallingServiceProfileId}

Activate Wi-Fi Calling Service Profile On Wi-Fi Network

`DELETE` /wifiNetworks/{wifiNetworkId}/wifiCallingServiceProfiles/{wifiCallingServiceProfileId}

Deactivate Wi-Fi Calling Service Profile On Wi-Fi Network

`PATCH` /entitlements

Update Entitlements

What's Deleted

`POST` /reports/switches/utilizations

Get Switches Utilization

`POST` /reports/switches/traffics

Get Switches Traffic Report

`POST` /reports/switches/top5Traffics

Get Top Five Switches by Traffic Volume

`POST` /reports/switches/top5PoeUtilizations

Get Top Five Switches Utilization

`POST` /reports/switches/statusHistories

Get Switches Status Histories

`POST` /reports/ltes/traffics

Get LTE Traffic Reports

`POST` /reports/clients/traffics

Get Client Traffics

`POST` /reports/clients/statistics

Get Client Historical Statistics Reports

`POST` /reports/clients/sessionHistories

Get Client Session Histories

`POST` /reports/aps/traffics

Get AP Traffic Reports

`POST` /reports/apps/top10Traffics

Get Top Ten Traffics

`POST` /reports/apps/top10TotalTraffics

Get Top Ten Total Traffics

What's Deprecated

`GET` /entitlements

Get Entitlements

`GET` /banners

Get Banners

`POST` /guestUsers/query/csvFiles

Export Guest CSV

`GET` /clients

Get AP Clients

`GET` /clients/{mac}

Get Client by MAC

`GET` /entitlements/summaries

Get Entitlement Summaries

`POST` /switches/query/csvFiles

Export Switch Inventory

`POST` /switches/ports/query

Get Ports

`POST` /switches/clients/query

Get Switch Clients

`POST` /cloudpaths/query

Get Cloudpath Servers

`POST` /aps/query/csvFiles

Export AP Inventory

`GET` /apSnmpAgentProfiles/{apSnmpProfileId}

Get AP SNMP Profile

`PUT` /apSnmpAgentProfiles/{apSnmpProfileId}

Update AP SNMP Agent Profile

`DELETE` /apSnmpAgentProfiles/{apSnmpProfileId}

Delete AP SNMP Agent Profile

`POST` /apSnmpAgentProfiles/{apSnmpProfileId}/aps/query

Get AP SNMP Agent Profile AP Usage

`GET` /applicationPolicies/capabilities/applications

Get Application Policies Applications

`GET` /applicationPolicies/capabilities/categories

Get Application Policies Categories

`PATCH` /aps/clients

Clients Control

`GET` /isolationAllowlists/{clientIsolationAllowlistId}

Get Client Isolation Allowlist

`PUT` /isolationAllowlists/{clientIsolationAllowlistId}

Update Client Isolation Allowlist

`DELETE` /isolationAllowlists/{clientIsolationAllowlistId}

Delete Client Isolation Allowlist

`POST` /isolationAllowlists/{clientIsolationAllowlistId}/venues/query

Get Venue Usage

`GET` /l2AclPolicies

Get Layer-2 ACL Policies.

`DELETE` /l2AclPolicies

Delete Layer-2 ACL Policies.

`GET` /mDnsProxyServiceProfiles

Get Multicast DNS Proxy Service Profiles

`POST` /mDnsProxyServiceProfiles

Create Multicast DNS Proxy Service Profile

`DELETE` /mDnsProxyServiceProfiles

Delete Multicast DNS Proxy Service Profiles

`GET` /mDnsProxyServiceProfiles/{mDnsProxyProfileId}

Get Multicast DNS Proxy Service Profile

`PUT` /mDnsProxyServiceProfiles/{mDnsProxyProfileId}

Update Multicast DNS Proxy Service Profile

`DELETE` /mDnsProxyServiceProfiles/{mDnsProxyProfileId}

Delete Multicast DNS Proxy Service Profile

`POST` /mDnsProxyServiceProfiles/{mDnsProxyProfileId}/aps

Activate Multicast DNS Proxy Service Profile for APs

`DELETE` /mDnsProxyServiceProfiles/{mDnsProxyProfileId}/aps

Deactivate Multicast DNS Proxy Service Profile for APs

`POST` /networkActivations

Create Network Activation

`DELETE` /networkActivations

Delete Network Activation

`POST` /networkActivations/mappings

Create Network Activation Mappings

`GET` /networkActivations/{networkVenueId}

Get Network Activation

`PUT` /networkActivations/{networkVenueId}

Update Network Activation

`DELETE` /networkActivations/{networkVenueId}

Delete Network Activation

`GET` /recoveryPskSettings

Get Recovery PSK

`PUT` /recoveryPskSettings

Update Recovery PSK

`GET` /rogueApPolicyProfiles/{roguePolicyId}

Get Rogue AP Detection Policy

`PUT` /rogueApPolicyProfiles/{roguePolicyId}

Update Rogue AP Detection Policy

`DELETE` /rogueApPolicyProfiles/{roguePolicyId}

Delete Rogue AP Detection Policy

`POST` /rogueApPolicyProfiles/{roguePolicyId}/venues

Create Rogue AP Detection Policy Venue Bindings

`DELETE` /rogueApPolicyProfiles/{roguePolicyId}/venues

Unbind Rogue AP Detection Policy from Venues

`GET` /syslogServerProfiles

Get Syslog Server Profiles

`DELETE` /syslogServerProfiles

Delete Syslog Server Profiles

`GET` /venues/aps/importResults

Get Result for Import APs from CSV File

`GET` /venues/aps/{serialNumber}/dhcpLeases

Get DHCP Lease Times

`GET` /venues/aps/{serialNumber}/dhcpPoolUsages

Get DHCP Pool Usages

`GET` /venues/aps/{serialNumber}/directedMulticastSettings

Get AP Directed Multicast Settings

`PUT` /venues/aps/{serialNumber}/directedMulticastSettings

Update AP Directed Multicast Settings

`DELETE` /venues/aps/{serialNumber}/directedMulticastSettings

Reset AP Directed Multicast Settings

`PUT` /venues/aps/{serialNumber}/floorPositions

Update AP Position

`GET` /venues/aps/{serialNumber}/lanPortSettings

Get AP LAN-Ports

`PUT` /venues/aps/{serialNumber}/lanPortSettings

Update AP LAN-Ports

`DELETE` /venues/aps/{serialNumber}/lanPortSettings

Reset AP LAN-Ports

`GET` /venues/aps/{serialNumber}/logs

Download AP Log

`GET` /venues/aps/{serialNumber}/networkSettings

Get AP Network Settings

`PUT` /venues/aps/{serialNumber}/networkSettings

Update AP Network Settings

`DELETE` /venues/aps/{serialNumber}/networkSettings

Reset AP Network Settings

`GET` /venues/aps/{serialNumber}/packets

Get Packet Capture State

`POST` /venues/aps/{serialNumber}/packets

Start Packet Capture

`DELETE` /venues/aps/{serialNumber}/packets

Stop Packet Capture

`GET` /venues/aps/{serialNumber}/pictures

Get AP Picture

`PUT` /venues/aps/{serialNumber}/pictures

Upload AP Picture

`DELETE` /venues/aps/{serialNumber}/pictures

Delete AP Picture

`GET` /venues/aps/{serialNumber}/radioSettings

Get AP Radio

`PUT` /venues/aps/{serialNumber}/radioSettings

Update AP Radio

`DELETE` /venues/aps/{serialNumber}/radioSettings

Reset AP Radio Customization

`GET` /venues/aps/{serialNumber}/snmpAgentSettings

Get AP SNMP Agent Settings

`PUT` /venues/aps/{serialNumber}/snmpAgentSettings

Update AP SNMP Agent Settings

`DELETE` /venues/aps/{serialNumber}/snmpAgentSettings

Reset AP SNMP Agent Settings

`GET` /venues/aps/{serialNumber}/wifiOverwriteSettings

Get AP Customization

`PUT` /venues/aps/{serialNumber}/wifiOverwriteSettings

Update AP Customization

`DELETE` /venues/aps/{serialNumber}/wifiOverwriteSettings

Reset AP Customization

`GET` /venues/lteBands

Get Available LTE Bands

`GET` /venues/{venueId}/dhcpConfigServiceProfileSettings

Get DHCP Service Profile Settings of This Venue

`POST` /venues/{venueId}/dhcpConfigServiceProfileSettings

Update DHCP Service Profile Settings of This Venue

`GET` /venues/{venueId}/dhcpPoolLeases

Get Venue DHCP Leases

`GET` /venues/{venueId}/dhcpPools

Get DHCP Pools Usage in Venue

`POST` /venues/{venueId}/dhcpPools/{dhcpPoolId}

Activate DHCP Pools in Venue

`DELETE` /venues/{venueId}/dhcpPools/{dhcpPoolId}

Deactivate DHCP Pools in Venue

`GET` /venues/{venueId}/directedMulticastSettings

Get Venue Directed Multicast Settings

`PUT` /venues/{venueId}/directedMulticastSettings

Update Venue Directed Multicast Settings

`GET` /venues/{venueId}/dosProtectionSettings

Get Venue DoS Protection

`PUT` /venues/{venueId}/dosProtectionSettings

Update Venue DoS Protection

`GET` /venues/{venueId}/externalAntennaSettings

Get Venue External Antenna

`PUT` /venues/{venueId}/externalAntennaSettings

Update Venue External Antenna

`POST` /venues/{venueId}/isolationAllowlists/query

Get Venue Client Isolation Allowlists

`GET` /venues/{venueId}/lanPortSettings

Get Venue LAN-Ports

`PUT` /venues/{venueId}/lanPortSettings

Update Venue LAN-Ports

`GET` /venues/{venueId}/ledSettings

Get Venue LED

`PUT` /venues/{venueId}/ledSettings

Update Venue LED

`GET` /venues/{venueId}/loadBalancingSettings

Get Venue Load Balancing Settings

`PUT` /venues/{venueId}/loadBalancingSettings

Update Venue Load Balancing Settings

`GET` /venues/{venueId}/mDnsProxyProfileAps

Get Multicast DNS Proxy Service Profile APs by Venue

`PUT` /venues/{venueId}/meshSettings

Update Mesh

`GET` /venues/{venueId}/radiusOptions

Get Venue RADIUS Options Settings

`PUT` /venues/{venueId}/radiusOptions

Update Venue RADIUS Options Settings

`GET` /venues/{venueId}/rogueApSettings

Get Venue Rogue AP

`PUT` /venues/{venueId}/rogueApSettings

Update Venue Rogue AP

`GET` /venues/{venueId}/snmpAgentSettings

Get Venue AP SNMP Agent Settings

`PUT` /venues/{venueId}/snmpAgentSettings

Update Venue AP SNMP Agent Settings

`GET` /venues/{venueId}/syslogServerProfileSettings

Get Venue Syslog Server Profile Settings

`POST` /venues/{venueId}/syslogServerProfileSettings

Update Venue Syslog Server Profile Settings

`GET` /venues/{venueId}/syslogSettings

Get Venue Syslog

`PUT` /venues/{venueId}/syslogSettings

Update Venue Syslog

`DELETE` /venues/{venueId}/syslogSettings

Reset Venue Syslog

`GET` /vlanPools

Get VLAN Pools

`POST` /vlanPools

Add VLAN Pool

`DELETE` /vlanPools

Delete VLAN Pools

`POST` /vlanPools/query

Query VLAN Pool

`GET` /vlanPools/{vlanPoolId}

Get VLAN Pool

`PUT` /vlanPools/{vlanPoolId}

Update VLAN Pool

`DELETE` /vlanPools/{vlanPoolId}

Delete VLAN Pool

`PATCH` /vlanPools/{vlanPoolId}

Partial Update VLAN Pool

`GET` /wifiCallingServiceProfiles

Get Wi-Fi Calling Service Profiles

`DELETE` /wifiCallingServiceProfiles

Delete Wi-Fi Calling Service Profiles

`POST` /x509certs

Validate X509 Certificates

`GET` /accessControlProfiles

Get All Access Control Profiles

`DELETE` /accessControlProfiles

Delete Multiple Access Control Profiles

`GET` /apSnmpAgentProfiles

Get AP SNMP Agent Profiles

`DELETE` /apSnmpAgentProfiles

Delete AP SNMP Agent Profiles

`POST` /apSnmpAgentProfiles

Create AP SNMP Agent Profile

`GET` /applicationPolicies

Get Application Policies

`DELETE` /applicationPolicies

Delete Application Policies

`GET` /devicePolicies

Get All Device Policies

`DELETE` /devicePolicies

Delete Device-Policies

`GET` /dhcpConfigServiceProfiles

Get DHCP Configuration Service Profiles

`DELETE` /dhcpConfigServiceProfiles

Delete DHCP Configuration Service Profiles

`GET` /isolationAllowlists

Get Client Isolation Allowlists

`DELETE` /isolationAllowlists

Delete Isolation Allowlists

`POST` /isolationAllowlists

Create Client Isolation Allowlist

`POST` /networkActivations/query

Get Network Activations by Query Filter

`GET` /radiusServerProfiles

List RADIUS Profiles

`DELETE` /radiusServerProfiles

Delete RADIUS Profiles

`GET` /rogueApPolicyProfiles

Get Rogue AP Detection Policies

`DELETE` /rogueApPolicyProfiles

Delete AP Detection Policies

`POST` /rogueApPolicyProfiles

Create Rogue AP Detection Policy

`GET` /venues/apGroups/{apGroupId}/aps

Get APs by AP-Group

`POST` /venues/aps

Add APs

`DELETE` /venues/aps

Delete APs

`GET` /venues/aps

Get APs

`GET` /venues/aps/capabilities

Get Capabilities

`PUT` /venues/aps/{serialNumber}

Update AP

`DELETE` /venues/aps/{serialNumber}

Delete AP

`PATCH` /venues/aps/{serialNumber}

Trigger AP Action

`GET` /venues/aps/{serialNumber}

Get AP

`GET` /venues/aps/{serialNumber}/capabilities

Get AP Capabilities

`GET` /venues/aps/{serialNumber}/channels

Get AP Default Regulatory-Channels

`GET` /venues/{venueId}/aps/capabilities

Get Venue AP-Model Capabilities

`GET` /venues/{venueId}/cellularSettings

Get Venue AP-Model Cellular

`PUT` /venues/{venueId}/cellularSettings

Update Venue AP-Model Cellular

`GET` /venues/{venueId}/channels

Get Venue Default Regulatory-Channels

`GET` /venues/{venueId}/mDnsFencingSettings

Get Multicast DNS Fencing Settings

`PUT` /venues/{venueId}/mDnsFencingSettings

Update Multicast DNS Fencing Settings

`DELETE` /venues/{venueId}/radioSettings

Reset Venue Radio

`GET` /venues/{venueId}/radioSettings

Get Venue Radio

`PUT` /venues/{venueId}/radioSettings

Update Venue Radio

`POST` /vlanPools/{vlanPoolId}/venues

Get VLAN Pool Venues Activations

`POST` /switches/aggregationDetails

Get Switches Aggregation Details

`DELETE` /l3AclPolicies

Delete Layer-3 ACL Policies.

`GET` /l3AclPolicies

Get Layer-3 ACL Policies.

`DELETE` /venues/apGroups

Delete AP-Groups

`GET` /venues/apGroups

Get AP-Groups

`PUT` /venues/apGroups/{apGroupId}

Update AP-Group

`DELETE` /venues/apGroups/{apGroupId}

Delete AP-Group

`GET` /venues/apGroups/{apGroupId}

Get AP-Group

`GET` /venues/wifiSettings

Get Venues Wi-Fi Settings

`GET` /venues/{venueId}/apGroups

Get AP-Groups by Venue

`GET` /venues/{venueId}/wifiSettings

Get Venue Wi-Fi Settings

`POST` /aps/query

Get APs

`GET` /networks

Get Networks

`DELETE` /networks

Delete Networks

`POST` /networks

Create Network

`GET` /networks/wisprProviders

Get External WISPr Providers

`GET` /networks/{networkId}

Get Network

`DELETE` /networks/{networkId}

Delete Network

`PUT` /networks/{networkId}

Update Network

`POST` /aps/aggregationDetails

Get APs Aggregation Details

What's Changed

`GET` /entitlements

Parameters:

Added: licenseType in query

Filter by license type (optional)

Changed: type in query

Filter by device type (optional). If device agnostic sku feature is enabled, all device types will be treated as APSW except ANALYTICS.

Return Type:

New response : 404 Not Found

This tenant does not exist.

New response : 417 Expectation Failed

Entitlement ID is missing.

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Returns the entitlements.

Changed content type : application/json

Changed items (object):
- Added property emailStage (string)
- Added property alm (boolean)
- Added property almLicenseType (string)
  
  Enum values:
  - UNKNOWN
  - APSW
  - URLF
  - EDGE_SECS
  - EDGE_SECL
- Added property almActivationId (string)
- Added property almSoEntQuantity (integer)
- Added property almUsedQuantity (integer)
- Added property extendedLicensesAssignment (boolean)
- Added property r1Sku (boolean)
- Changed property deviceType (string)
  
  Added enum values:
  - RWG
  - VIRTUAL_EDGE
  - APSW

`GET` /banners

Parameters:

Added: licenseType in query

Filter by license type (optional)

Changed: type in query

Filter by device type (Optional). If device agnostic sku feature is enabled, all device types will be treated as APSW except ANALYTICS.

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

OK

Changed content type : application/json

Changed items (object):
- Added property alm (boolean)
- Added property almExtraInfo (object)
  - Property licenseType (string)
  - Property remainingQuantity (integer)
  - Property soEntQuantity (integer)
  - Property activeApCount (integer)
  - Property activeSwitchCount (integer)
  - Property activeEdgeCount (integer)
- Added property licenseType (string)
- Changed property deviceType (string)
  
  Added enum values:
  - RWG
  - VIRTUAL_EDGE
  - APSW

`POST` /portalServiceProfiles/query

Request:

New content type : application/vnd.ruckus.v1.1+json

Deleted content type : application/vnd.ruckus.v1+json

Changed content type : application/json

Added property multiSortFields (array)

Items (string):
Added property matchFields (array)

Items (object):
- Property field (string)
- Property value (string)
Added property rangeFilter (object)
- Property field (string)
- Property gte (integer)
- Property lte (integer)
- Property lt (integer)
Added property rangeDateFilter (object)
Added property mustNotMatchField (array)

Items (object):
Added property pageByDate (object)
- Property value (string)
- Property key (string)
Added property fields (array)

Items (string):
Added property mustHaveFields (array)
Added property mustNotHaveFields (array)
Added property termField (object)
Added property terms (object)
Added property exists (string)
Added property groupBy (string)
Deleted property excludeContent (boolean)

Return Type:

New response : 501 Not Implemented

Not implemented

Deleted response : 423 Locked

Locked

Changed response : 400 Bad Request

Bad/malformed request

Deleted content type : application/json

Changed response : 401 Unauthorized

Unauthorized

Deleted content type : application/json

Changed response : 403 Forbidden

Forbidden

Deleted content type : application/json

Changed response : 404 Not Found

Requested resource or related-entity not found

Deleted content type : application/json

Changed response : 422 Unprocessable Entity

Validation error

Deleted content type : application/json

Changed response : 500 Internal Server Error

Internal Server Error

Deleted content type : application/json

Changed response : 200 OK

Successful operation

New content type : application/vnd.ruckus.v1.1+json
Deleted content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Added property fields (array)
- Added property totalCount (integer)
- Added property page (integer)
- Added property objectId (string)
- Added property data (array)
  
  Items (object):
  - Property id (string)
  - Property name (string)
  - Property displayLangCode (string)
  - Property wifiNetworkIds (array)
- Added property errorMessage (string)
- Added property subsequentQueries (array)
  
  Items (object):
  - Property fields (array)
  - Property url (string)
  - Property httpMethod (string)
    
    Enum values:
    - GET
    - HEAD
    - POST
    - PUT
    - PATCH
    - DELETE
    - OPTIONS
    - TRACE
  - Property payload (object)
- Deleted property content (array)
- Deleted property paging (object)

`GET` /tenants/authentications

Return Type:

Changed response : 200 OK

OK

Changed content type : application/vnd.ruckus.v1+json

Changed items (object):
- Deleted property samlSignatureEnabled (boolean)
Changed content type : application/json

Changed items (object):
- Deleted property samlSignatureEnabled (boolean)

`POST` /tenants/authentications

Request:

Changed content type : application/vnd.ruckus.v1+json

Deleted property samlSignatureEnabled (boolean)

Changed content type : application/json

Deleted property samlSignatureEnabled (boolean)

Return Type:

Changed response : 200 OK

OK

Changed content type : application/vnd.ruckus.v1+json
- Deleted property samlSignatureEnabled (boolean)
Changed content type : application/json
- Deleted property samlSignatureEnabled (boolean)

`POST` /guestUsers/query/csvFiles

`GET` /clients

`GET` /clients/{mac}

`GET` /entitlements/summaries

Parameters:

Added: licenseType in query

Filter by license type (optional)

Changed: type in query

Filter by device type (optional). If device agnostic sku feature is enabled, all device types will be treated as APSW except ANALYTICS.

Return Type:

New response : 404 Not Found

This tenant does not exist.

New response : 417 Expectation Failed

This tenant does not have Entitlement ID.

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 400 Bad Request

The bulk operations request was rejected due to bad input.

Deleted response : 403 Forbidden

The requesting tenant is not an MSP.

Changed response : 200 OK

Returns the entitlement summary. The response is actual in case when the refresh request parameter value is false

Changed content type : application/json
- Changed property entitlements (array)
  
  Changed items (object):
  - Added property emailStage (string)
  - Added property alm (boolean)
  - Added property almLicenseType (string)
  - Added property almActivationId (string)
  - Added property almSoEntQuantity (integer)
  - Added property almUsedQuantity (integer)
  - Added property extendedLicensesAssignment (boolean)
  - Added property r1Sku (boolean)
  - Changed property deviceType (string)
    
    Added enum values:
    - RWG
    - VIRTUAL_EDGE
    - APSW
- Changed property summary (array)
  
  Changed items (object):
  - Added property alm (boolean)
  - Added property almExtraInfo (object)
  - Added property wifiDeviceCount (integer)
  - Added property switchDeviceCount (integer)
  - Added property edgeDeviceCount (integer)
  - Added property virtualEdgeDeviceCount (integer)
  - Added property rwgDeviceCount (integer)
  - Added property remainingQuantity (integer)
  - Added property toBeRemovedDeviceCount (integer)
  - Added property outOfComplianceDevices (integer)
  - Added property futureOutOfComplianceDevices (integer)
  - Added property futureOfComplianceDate (string)
  - Added property assignedLicenses (integer)
  - Added property purchasedLicenses (integer)
  - Deleted property remainingDevices (integer)
  - Changed property deviceType (string)
    
    Added enum values:
    - RWG
    - VIRTUAL_EDGE
    - APSW
- Changed property banners (array)
  
  Changed items (object):
  - Added property alm (boolean)
  - Added property almExtraInfo (object)
  - Added property licenseType (string)
  - Changed property deviceType (string)
    
    Added enum values:
    - RWG
    - VIRTUAL_EDGE
    - APSW

`POST` /tenants/mobilePushNotifications

`POST` /venues/switches/switchPorts/query

Query Switch Ports

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property tags (string)
    
    Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
  - Added property portSpeedConfig (string)
  - Added property portConnectorType (string)
  - Added property authDefaultVlan (string)
  - Deleted property tag (string)
    
    Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
  - Changed property vsixIngressAclName (string)
    
    The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
  - Changed property vsixEgressAclName (string)
    
    The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property tags (string)
    
    Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
  - Added property portSpeedConfig (string)
  - Added property portConnectorType (string)
  - Added property authDefaultVlan (string)
  - Deleted property tag (string)
    
    Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
  - Changed property vsixIngressAclName (string)
    
    The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
  - Changed property vsixEgressAclName (string)
    
    The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property tags (string)
    
    Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
  - Added property portSpeedConfig (string)
  - Added property portConnectorType (string)
  - Added property authDefaultVlan (string)
  - Deleted property tag (string)
    
    Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
  - Changed property vsixIngressAclName (string)
    
    The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
  - Changed property vsixEgressAclName (string)
    
    The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property tags (string)
    
    Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
  - Added property portSpeedConfig (string)
  - Added property portConnectorType (string)
  - Added property authDefaultVlan (string)
  - Deleted property tag (string)
    
    Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
  - Changed property vsixIngressAclName (string)
    
    The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
  - Changed property vsixEgressAclName (string)
    
    The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.

`POST` /venues/switches/query/csvFiles

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`POST` /venues/switches/clients/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property clientAuthType (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property clientAuthType (string)

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property clientAuthType (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property clientAuthType (string)

`POST` /tunnelServiceProfiles/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property keepAliveInterval (integer)
  - Added property keepAliveRetry (integer)
  - Added property mtuRequestTimeout (integer)
  - Added property mtuRequestRetry (integer)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property keepAliveInterval (integer)
  - Added property keepAliveRetry (integer)
  - Added property mtuRequestTimeout (integer)
  - Added property mtuRequestRetry (integer)

`POST` /switches/query/csvFiles

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`POST` /switches/ports/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property tags (string)
    
    Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
  - Added property portSpeedConfig (string)
  - Added property portConnectorType (string)
  - Added property authDefaultVlan (string)
  - Deleted property tag (string)
    
    Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
  - Changed property vsixIngressAclName (string)
    
    The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
  - Changed property vsixEgressAclName (string)
    
    The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property tags (string)
    
    Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
  - Added property portSpeedConfig (string)
  - Added property portConnectorType (string)
  - Added property authDefaultVlan (string)
  - Deleted property tag (string)
    
    Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
  - Changed property vsixIngressAclName (string)
    
    The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
  - Changed property vsixEgressAclName (string)
    
    The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property tags (string)
    
    Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
  - Added property portSpeedConfig (string)
  - Added property portConnectorType (string)
  - Added property authDefaultVlan (string)
  - Deleted property tag (string)
    
    Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
  - Changed property vsixIngressAclName (string)
    
    The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
  - Changed property vsixEgressAclName (string)
    
    The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property tags (string)
    
    Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
  - Added property portSpeedConfig (string)
  - Added property portConnectorType (string)
  - Added property authDefaultVlan (string)
  - Deleted property tag (string)
    
    Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
  - Changed property vsixIngressAclName (string)
    
    The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
  - Changed property vsixEgressAclName (string)
    
    The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.

`POST` /switches/clients/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property clientAuthType (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property clientAuthType (string)

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property clientAuthType (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property clientAuthType (string)

`POST` /msps/{mspTenantId}/ecInventories/query/csvFiles

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`POST` /enhancedSyslogServerProfiles/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`POST` /enhancedRogueApPolicyProfiles/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`POST` /enhancedRadiusServerProfiles/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property hotspot20IdentityProviderIds (array)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property hotspot20IdentityProviderIds (array)

`POST` /enhancedL3AclPolicies/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`POST` /enhancedL2AclPolicies/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`POST` /enhancedIsolationAllowlists/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`POST` /enhancedDevicePolicies/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`POST` /enhancedApplicationPolicies/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`POST` /enhancedAccessControlProfiles/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`POST` /delegations

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property entitlements (array)
  
  Changed items (object):
  - Added property virtualEdgeDeviceCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property entitlements (array)
  
  Changed items (object):
  - Added property virtualEdgeDeviceCount (string)

Changed response : 501 Not Implemented

not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property virtualEdgeDeviceCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property virtualEdgeDeviceCount (string)

`POST` /cloudpaths/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`POST` /aps/query/csvFiles

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

`GET` /accessControlProfiles/{accessControlProfileId}

Return Type:

Changed response : 200 OK

OK

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`PUT` /accessControlProfiles/{accessControlProfileId}

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`DELETE` /accessControlProfiles/{accessControlProfileId}

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`GET` /apSnmpAgentProfiles/{apSnmpProfileId}

`PUT` /apSnmpAgentProfiles/{apSnmpProfileId}

`DELETE` /apSnmpAgentProfiles/{apSnmpProfileId}

`POST` /apSnmpAgentProfiles/{apSnmpProfileId}/aps/query

`GET` /applicationPolicies/capabilities/applications

`GET` /applicationPolicies/capabilities/categories

`GET` /applicationPolicies/{applicationPolicyId}

Return Type:

Changed response : 200 OK

OK

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json
Changed content type : application/json
- Changed property tenantId (string)

`PUT` /applicationPolicies/{applicationPolicyId}

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`DELETE` /applicationPolicies/{applicationPolicyId}

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`PATCH` /aps/clients

`GET` /devicePolicies/{devicePolicyId}

Return Type:

Changed response : 200 OK

OK

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json
Changed content type : application/json
- Changed property rules (array)
  
  Changed items (object): > Network device-policy rule
  - Changed property osVendor (string)
    
    The values of "Xbox360", "PlayStation2" and "PlayStation3" are now deprecated and will no longer be supported after 2024-07-31. However, the current back-end logic will continue to convert "Xbox360" to "Xbox" and also transform "PlayStation2" or "PlayStation3" to "PlayStation" for backward compatibility until that specified date.
    
    Added enum value:
    - PlayStation

`PUT` /devicePolicies/{devicePolicyId}

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Changed property rules (array)

Changed items (object): > Network device-policy rule
- Changed property osVendor (string)
  
  The values of "Xbox360", "PlayStation2" and "PlayStation3" are now deprecated and will no longer be supported after 2024-07-31. However, the current back-end logic will continue to convert "Xbox360" to "Xbox" and also transform "PlayStation2" or "PlayStation3" to "PlayStation" for backward compatibility until that specified date.
  
  Added enum value:
  - PlayStation

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`DELETE` /devicePolicies/{devicePolicyId}

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`GET` /dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId}

Return Type:

Changed response : 200 OK

OK

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`PUT` /dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId}

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`DELETE` /dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId}

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`GET` /isolationAllowlists/{clientIsolationAllowlistId}

`PUT` /isolationAllowlists/{clientIsolationAllowlistId}

`DELETE` /isolationAllowlists/{clientIsolationAllowlistId}

`POST` /isolationAllowlists/{clientIsolationAllowlistId}/venues/query

`GET` /l2AclPolicies

Get Layer-2 ACL Policies.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed items (object): > L2 access control policy
- Changed property macAddresses (array)
  
  Changed items (string):

`POST` /l2AclPolicies

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Changed property macAddresses (array)

Changed items (string):

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json
Changed content type : application/json
- Changed property response (object)
  
  L2 access control policy
  - Changed property macAddresses (array)
    
    Changed items (string):

`DELETE` /l2AclPolicies

Delete Layer-2 ACL Policies.

`GET` /l2AclPolicies/{l2AclPolicyId}

Return Type:

Changed response : 200 OK

OK

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Changed property macAddresses (array)
  
  Changed items (string):

`PUT` /l2AclPolicies/{l2AclPolicyId}

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Changed property macAddresses (array)

Changed items (string):

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`DELETE` /l2AclPolicies/{l2AclPolicyId}

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`GET` /mDnsProxyServiceProfiles

`POST` /mDnsProxyServiceProfiles

`DELETE` /mDnsProxyServiceProfiles

`GET` /mDnsProxyServiceProfiles/{mDnsProxyProfileId}

`PUT` /mDnsProxyServiceProfiles/{mDnsProxyProfileId}

`DELETE` /mDnsProxyServiceProfiles/{mDnsProxyProfileId}

`POST` /mDnsProxyServiceProfiles/{mDnsProxyProfileId}/aps

`DELETE` /mDnsProxyServiceProfiles/{mDnsProxyProfileId}/aps

`POST` /networkActivations

Request:

Changed content type : application/json

Changed property apGroups (array)

Changed items (object): > Network to AP-Group activation
- Changed property apGroupName (string)

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Added property response (object)
  
  Network venue association
  - Property allApGroupsRadio (string)
    
    Enum values:
    - Both
    - 2.4-GHz
    - 5-GHz
  - Property allApGroupsRadioTypes (array)
    
    Items (string):
    
    Enum values:
    - 2.4-GHz
    - 5-GHz
    - 6-GHz
  - Property allApGroupsVlanId (integer)
  - Property apGroups (array)
    
    Items (object): > Network to AP-Group activation
    - Property apGroupId (string)
    - Property apGroupName (string)
    - Property id (string)
    - Property isDefault (boolean)
    - Property radio (string)
    - Property radioTypes (array)
    - Property validationError (boolean)
    - Property validationErrorReachedMaxConnectedCaptiveNetworksLimit (boolean)
    - Property validationErrorReachedMaxConnectedNetworksLimit (boolean)
    - Property validationErrorSsidAlreadyActivated (boolean)
    - Property vlanId (integer)
    - Property vlanPoolId (string)
    - Property vlanPoolName (string)
  - Property clientIsolationAllowlistId (string)
  - Property dual5gEnabled (boolean)
  - Property id (string)
  - Property isAllApGroups (boolean)
  - Property networkId (string)
  - Property scheduler (object)
    
    Network-Venue scheduler
    - Property fri (string)
    - Property mon (string)
    - Property sat (string)
    - Property sun (string)
    - Property thu (string)
    - Property tue (string)
    - Property type (string)
      
      Enum values:
      - ALWAYS_ON
      - ALWAYS_OFF
      - CUSTOM
    - Property wed (string)
  - Property tripleBandEnabled (boolean)
  - Property venueId (string)
  - Property vlanPoolId (string)

`DELETE` /networkActivations

`POST` /networkActivations/mappings

Request:

Changed content type : application/json

Changed items (object): > Network activation mapping

Changed property apGroups (array)

Changed items (object): > Network to AP-Group activation
- Changed property apGroupName (string)

`GET` /networkActivations/{networkVenueId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property apGroups (array)
  
  Changed items (object): > Network to AP-Group activation
  - Changed property apGroupName (string)

`PUT` /networkActivations/{networkVenueId}

Request:

Changed content type : application/json

Changed property apGroups (array)

Changed items (object): > Network to AP-Group activation
- Changed property apGroupName (string)

`DELETE` /networkActivations/{networkVenueId}

`GET` /radiusServerProfiles/{radiusId}

Parameters:

Changed: radiusId in path

RADIUS server profile ID

Return Type:

Changed response : 200 OK

OK

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`PUT` /radiusServerProfiles/{radiusId}

Parameters:

Changed: radiusId in path

RADIUS server profile ID

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`DELETE` /radiusServerProfiles/{radiusId}

Parameters:

Changed: radiusId in path

RADIUS server profile ID

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`GET` /recoveryPskSettings

`PUT` /recoveryPskSettings

`GET` /rogueApPolicyProfiles/{roguePolicyId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property venues (array)
  
  Changed items (object): > Entity ID and name

`PUT` /rogueApPolicyProfiles/{roguePolicyId}

Request:

Changed content type : application/json

Changed property venues (array)

Changed items (object): > Entity ID and name

`DELETE` /rogueApPolicyProfiles/{roguePolicyId}

`POST` /rogueApPolicyProfiles/{roguePolicyId}/venues

`DELETE` /rogueApPolicyProfiles/{roguePolicyId}/venues

`GET` /syslogServerProfiles

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed items (object): > Syslog Server Profile Configuration
- Changed property venues (array)
  
  Changed items (object): > Entity ID and name

`POST` /syslogServerProfiles

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Changed property venues (array)

Changed items (object): > Entity ID and name

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`DELETE` /syslogServerProfiles

`GET` /syslogServerProfiles/{syslogServerProfileId}

Return Type:

Changed response : 200 OK

OK

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json
Changed content type : application/json
- Changed property venues (array)
  
  Changed items (object): > Entity ID and name

`PUT` /syslogServerProfiles/{syslogServerProfileId}

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Changed property venues (array)

Changed items (object): > Entity ID and name

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`DELETE` /syslogServerProfiles/{syslogServerProfileId}

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`GET` /venues/aps/importResults

`GET` /venues/aps/{serialNumber}/dhcpLeases

`GET` /venues/aps/{serialNumber}/dhcpPoolUsages

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed items (object): > DHCP Service Profile Configuration.
- Changed property venues (array)
  
  Changed items (object): > Entity ID and name

`GET` /venues/aps/{serialNumber}/directedMulticastSettings

`PUT` /venues/aps/{serialNumber}/directedMulticastSettings

`DELETE` /venues/aps/{serialNumber}/directedMulticastSettings

`PUT` /venues/aps/{serialNumber}/floorPositions

`GET` /venues/aps/{serialNumber}/lanPortSettings

`PUT` /venues/aps/{serialNumber}/lanPortSettings

`DELETE` /venues/aps/{serialNumber}/lanPortSettings

`GET` /venues/aps/{serialNumber}/logs

`GET` /venues/aps/{serialNumber}/networkSettings

`PUT` /venues/aps/{serialNumber}/networkSettings

`DELETE` /venues/aps/{serialNumber}/networkSettings

`GET` /venues/aps/{serialNumber}/packets

`POST` /venues/aps/{serialNumber}/packets

`DELETE` /venues/aps/{serialNumber}/packets

`GET` /venues/aps/{serialNumber}/pictures

Parameters:

Deleted: tenantId in path

Tenant ID

`PUT` /venues/aps/{serialNumber}/pictures

Parameters:

Deleted: tenantId in path

Tenant ID

`DELETE` /venues/aps/{serialNumber}/pictures

Parameters:

Deleted: tenantId in path

Tenant ID

`GET` /venues/aps/{serialNumber}/radioSettings

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property apRadioParams24G (object)
  
  AP radio customization for 2.4GHz.
  - Added property useVenueSettings (boolean)
- Changed property apRadioParams50G (object)
  
  AP radio customization for 5GHz.
  - Added property useVenueSettings (boolean)
- Changed property apRadioParams6G (object)
  
  AP radio customization for 6GHz.
  - Added property enableMulticastDownlinkRateLimiting (boolean)
    
    Enable rate limiting of multicast downlink traffic on 6-GHz radio.
  - Added property enableMulticastUplinkRateLimiting (boolean)
    
    Enable rate limiting of multicast uplink traffic on 6-GHz radio.
  - Added property multicastDownlinkRateLimiting (integer)
    
    Rate limiting of multicast downlink traffic (Mbps) on 6-GHz radio. The value should be not greater than 50% of BSS min rate.
  - Added property multicastUplinkRateLimiting (integer)
    
    Rate limiting of multicast uplink traffic (Mbps) on 6-GHz radio.
  - Added property useVenueSettings (boolean)
- Changed property apRadioParamsDual5G (object)
  
  AP radio customization for dual 5GHz radios.
  - Added property useVenueEnabled (boolean)

`PUT` /venues/aps/{serialNumber}/radioSettings

Request:

Changed content type : application/json

Changed property apRadioParams24G (object)

AP radio customization for 2.4GHz.
- Added property useVenueSettings (boolean)
Changed property apRadioParams50G (object)

AP radio customization for 5GHz.
- Added property useVenueSettings (boolean)
Changed property apRadioParams6G (object)

AP radio customization for 6GHz.
- Added property enableMulticastDownlinkRateLimiting (boolean)
  
  Enable rate limiting of multicast downlink traffic on 6-GHz radio.
- Added property enableMulticastUplinkRateLimiting (boolean)
  
  Enable rate limiting of multicast uplink traffic on 6-GHz radio.
- Added property multicastDownlinkRateLimiting (integer)
  
  Rate limiting of multicast downlink traffic (Mbps) on 6-GHz radio. The value should be not greater than 50% of BSS min rate.
- Added property multicastUplinkRateLimiting (integer)
  
  Rate limiting of multicast uplink traffic (Mbps) on 6-GHz radio.
- Added property useVenueSettings (boolean)
Changed property apRadioParamsDual5G (object)

AP radio customization for dual 5GHz radios.
- Added property useVenueEnabled (boolean)

`DELETE` /venues/aps/{serialNumber}/radioSettings

`GET` /venues/aps/{serialNumber}/snmpAgentSettings

`PUT` /venues/aps/{serialNumber}/snmpAgentSettings

`DELETE` /venues/aps/{serialNumber}/snmpAgentSettings

`GET` /venues/aps/{serialNumber}/wifiOverwriteSettings

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Added property bandMode (string)
  
  Enum values:
  - DUAL
  - TRIPLE
- Added property ledEnabled (boolean)

`PUT` /venues/aps/{serialNumber}/wifiOverwriteSettings

Request:

Changed content type : application/json

Added property bandMode (string)
Added property ledEnabled (boolean)

`DELETE` /venues/aps/{serialNumber}/wifiOverwriteSettings

`GET` /venues/lteBands

`GET` /venues/{venueId}/dhcpConfigServiceProfileSettings

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Deleted property bonjourFencingEnabled (boolean)

`POST` /venues/{venueId}/dhcpConfigServiceProfileSettings

Request:

Changed content type : application/json

Deleted property bonjourFencingEnabled (boolean)

`GET` /venues/{venueId}/dhcpPoolLeases

`GET` /venues/{venueId}/dhcpPools

`POST` /venues/{venueId}/dhcpPools/{dhcpPoolId}

`DELETE` /venues/{venueId}/dhcpPools/{dhcpPoolId}

`GET` /venues/{venueId}/directedMulticastSettings

`PUT` /venues/{venueId}/directedMulticastSettings

`GET` /venues/{venueId}/dosProtectionSettings

`PUT` /venues/{venueId}/dosProtectionSettings

`GET` /venues/{venueId}/externalAntennaSettings

`PUT` /venues/{venueId}/externalAntennaSettings

`POST` /venues/{venueId}/isolationAllowlists/query

`GET` /venues/{venueId}/lanPortSettings

`PUT` /venues/{venueId}/lanPortSettings

`GET` /venues/{venueId}/ledSettings

`PUT` /venues/{venueId}/ledSettings

`GET` /venues/{venueId}/loadBalancingSettings

`PUT` /venues/{venueId}/loadBalancingSettings

`GET` /venues/{venueId}/mDnsProxyProfileAps

`PUT` /venues/{venueId}/meshSettings

Request:

Changed content type : application/json

Added property passphrase (string)
Added property radioType (string)

Enum values:
- 2.4-GHz
- 5-GHz
Added property ssid (string)

`GET` /venues/{venueId}/radiusOptions

`PUT` /venues/{venueId}/radiusOptions

`GET` /venues/{venueId}/rogueApSettings

`PUT` /venues/{venueId}/rogueApSettings

`GET` /venues/{venueId}/snmpAgentSettings

`PUT` /venues/{venueId}/snmpAgentSettings

`GET` /venues/{venueId}/syslogServerProfileSettings

`POST` /venues/{venueId}/syslogServerProfileSettings

`GET` /venues/{venueId}/syslogSettings

`PUT` /venues/{venueId}/syslogSettings

`DELETE` /venues/{venueId}/syslogSettings

`GET` /vlanPools

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed items (object): > VLAN pool
- Changed property vlanMembers (array)
  
  Changed items (string):

`POST` /vlanPools

Request:

Changed content type : application/json

Changed property vlanMembers (array)

Changed items (string):

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property response (object)
  
  VLAN pool
  - Changed property vlanMembers (array)
    
    Changed items (string):

`DELETE` /vlanPools

`POST` /vlanPools/query

`GET` /vlanPools/{vlanPoolId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property vlanMembers (array)
  
  Changed items (string):

`PUT` /vlanPools/{vlanPoolId}

Request:

Changed content type : application/json

Changed property vlanMembers (array)

Changed items (string):

`DELETE` /vlanPools/{vlanPoolId}

`PATCH` /vlanPools/{vlanPoolId}

Request:

Changed content type : application/json

Changed property vlanMembers (array)

Changed items (string):

`GET` /wifiCallingServiceProfiles

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed items (object): > Wi-Fi calling profile configuration
- Changed property networkIds (array)
  
  Changed items (string):

`POST` /wifiCallingServiceProfiles

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Changed property networkIds (array)

Changed items (string):

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`DELETE` /wifiCallingServiceProfiles

`GET` /wifiCallingServiceProfiles/{wifiCallingServiceProfileId}

Return Type:

Changed response : 200 OK

OK

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json
Changed content type : application/json
- Changed property networkIds (array)
  
  Changed items (string):

`PUT` /wifiCallingServiceProfiles/{wifiCallingServiceProfileId}

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Changed property networkIds (array)

Changed items (string):

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`DELETE` /wifiCallingServiceProfiles/{wifiCallingServiceProfileId}

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`POST` /x509certs

`DELETE` /guestUsers

Request:

Changed content type : application/json

`GET` /guestUsers

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property content (array)
  
  Changed items (object):
  - Changed property guestUserType (string)
    
    This field is not editable after creation.
    
    Added enum value:
    - Directory

`POST` /guestUsers

Request:

Changed content type : application/json

Return Type:

Changed response : 201 Created

Created

Changed content type : application/json
- Changed property response (array)
  
  Changed items (object):
  - Changed property guestUserType (string)
    
    This field is not editable after creation.
    
    Added enum value:
    - Directory

`GET` /guestUsers/{guestUserId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property guestUserType (string)
  
  This field is not editable after creation.
  
  Added enum value:
  - Directory

`PATCH` /guestUsers/{guestUserId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property response (object)
  - Changed property guestUserType (string)
    
    This field is not editable after creation.
    
    Added enum value:
    - Directory

`GET` /tenants/userProfiles

Return Type:

Changed response : 200 OK

OK

Changed content type : application/vnd.ruckus.v1+json
- Deleted property customRoleType (string)
Changed content type : application/json
- Deleted property customRoleType (string)

`PUT` /tenants/userProfiles

Request:

Changed content type : application/vnd.ruckus.v1+json

Deleted property customRoleType (string)

Changed content type : application/json

Deleted property customRoleType (string)

Return Type:

Changed response : 200 OK

Accepted

Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Deleted property customRoleType (string)
Changed content type : application/json
- Changed property response (object)
  - Deleted property customRoleType (string)

Changed response : 500 Internal Server Error

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Deleted property customRoleType (string)
Changed content type : application/json
- Changed property response (object)
  - Deleted property customRoleType (string)

`POST` /venues/{venueId}/rogueAps/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`POST` /venues/switches/query

Get Switches of Venue

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property stackMemberOrder (string)
  - Added property veCount (integer)
  - Changed property portStatuses (array)
    
    Changed items (object):
    - Added property tags (string)
      
      Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
    - Added property portSpeedConfig (string)
    - Added property portConnectorType (string)
    - Added property authDefaultVlan (string)
    - Deleted property tag (string)
      
      Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
    - Changed property vsixIngressAclName (string)
      
      The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
    - Changed property vsixEgressAclName (string)
      
      The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property stackMemberOrder (string)
  - Added property veCount (integer)
  - Changed property portStatuses (array)
    
    Changed items (object):
    - Added property tags (string)
      
      Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
    - Added property portSpeedConfig (string)
    - Added property portConnectorType (string)
    - Added property authDefaultVlan (string)
    - Deleted property tag (string)
      
      Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
    - Changed property vsixIngressAclName (string)
      
      The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
    - Changed property vsixEgressAclName (string)
      
      The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property stackMemberOrder (string)
  - Added property veCount (integer)
  - Changed property portStatuses (array)
    
    Changed items (object):
    - Added property tags (string)
      
      Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
    - Added property portSpeedConfig (string)
    - Added property portConnectorType (string)
    - Added property authDefaultVlan (string)
    - Deleted property tag (string)
      
      Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
    - Changed property vsixIngressAclName (string)
      
      The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
    - Changed property vsixEgressAclName (string)
      
      The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property stackMemberOrder (string)
  - Added property veCount (integer)
  - Changed property portStatuses (array)
    
    Changed items (object):
    - Added property tags (string)
      
      Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
    - Added property portSpeedConfig (string)
    - Added property portConnectorType (string)
    - Added property authDefaultVlan (string)
    - Deleted property tag (string)
      
      Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
    - Changed property vsixIngressAclName (string)
      
      The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
    - Changed property vsixEgressAclName (string)
      
      The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.

`POST` /venues/query

Request:

New content type : application/vnd.ruckus.v1+json

Changed content type : application/json

Deleted property sortByCountField (string)

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Added property currentApFirmwares (array)
  
  Items (object):
  - Property apModel (string)
  - Property firmware (string)
- Added property isApFirmwareUpToDate (boolean)
- Added property lastApFirmwareUpdate (string)
- Added property nextApFirmwareSchedules (array)
  
  Items (object):
  - Property startDateTime (string)
  - Property versionInfo (object)
    - Property version (string)
    - Property type (string)
    - Property category (string)
Changed content type : application/vnd.ruckus.v1+json
- Added property currentApFirmwares (array)
- Added property isApFirmwareUpToDate (boolean)
- Added property lastApFirmwareUpdate (string)
- Added property nextApFirmwareSchedules (array)

Changed response : 501 Not Implemented

not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object): > Venue
  - Added property currentApFirmwares (array)
    
    Items (object):
    - Property apModel (string)
    - Property firmware (string)
  - Added property isApFirmwareUpToDate (boolean)
  - Added property lastApFirmwareUpdate (string)
  - Added property nextApFirmwareSchedules (array)
    
    Items (object):
    - Property startDateTime (string)
    - Property versionInfo (object)
  - Changed property wifiStates (object)
    
    Wifi-States
    - Changed property Operational (integer)
      
      Number of APs that are operational and managed by cloud.
    - Changed property RequiresAttention (integer)
      
      Number of APs that require technical assistance.
    - Changed property TransientIssue (integer)
      
      Number of APs that are temporarily offline.
  - Changed property lteStates (object)
    
    Lte-States
    - Changed property Operational (integer)
      
      Number of APs that are operational and managed by cloud.
    - Changed property Connected (integer)
      
      Number of APs that are connected but still not transmitting.
    - Changed property Disconnected (integer)
      
      Number of APs that are disconnected from the cloud.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object): > Venue
  - Added property currentApFirmwares (array)
  - Added property isApFirmwareUpToDate (boolean)
  - Added property lastApFirmwareUpdate (string)
  - Added property nextApFirmwareSchedules (array)
  - Changed property wifiStates (object)
    
    Wifi-States
    - Changed property Operational (integer)
      
      Number of APs that are operational and managed by cloud.
    - Changed property RequiresAttention (integer)
      
      Number of APs that require technical assistance.
    - Changed property TransientIssue (integer)
      
      Number of APs that are temporarily offline.
  - Changed property lteStates (object)
    
    Lte-States
    - Changed property Operational (integer)
      
      Number of APs that are operational and managed by cloud.
    - Changed property Connected (integer)
      
      Number of APs that are connected but still not transmitting.
    - Changed property Disconnected (integer)
      
      Number of APs that are disconnected from the cloud.

`POST` /techpartners/mspecs/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property mspecName (string)
  - Added property mspecId (string)
  - Added property virtualEdgeLicenses (integer)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property virtualEdgeDeviceCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property mspecName (string)
  - Added property mspecId (string)
  - Added property virtualEdgeLicenses (integer)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property virtualEdgeDeviceCount (string)

Changed response : 501 Not Implemented

not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property mspecName (string)
  - Added property mspecId (string)
  - Added property virtualEdgeLicenses (integer)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property virtualEdgeDeviceCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property mspecName (string)
  - Added property mspecId (string)
  - Added property virtualEdgeLicenses (integer)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property virtualEdgeDeviceCount (string)

`POST` /snmpAgents/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

`POST` /mspecs/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property mspecName (string)
  - Added property mspecId (string)
  - Added property virtualEdgeLicenses (integer)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property virtualEdgeDeviceCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property mspecName (string)
  - Added property mspecId (string)
  - Added property virtualEdgeLicenses (integer)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property virtualEdgeDeviceCount (string)

Changed response : 501 Not Implemented

not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property mspecName (string)
  - Added property mspecId (string)
  - Added property virtualEdgeLicenses (integer)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property virtualEdgeDeviceCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property mspecName (string)
  - Added property mspecId (string)
  - Added property virtualEdgeLicenses (integer)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property virtualEdgeDeviceCount (string)

`POST` /guestUsers/query

Request:

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

Return Type:

Deleted response : 501 Not Implemented

Not implemented

Changed response : 200 OK

Successful operation

New content type : text/vnd.ruckus.v1.1+csv
New content type : application/vnd.ruckus.v1.1+json

`POST` /enhancedWifiCallingProfiles/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`POST` /enhancedMdnsProxyProfiles/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`POST` /enhancedDhcpConfigServiceProfiles/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`GET` /accessControlProfiles

`DELETE` /accessControlProfiles

`POST` /accessControlProfiles

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`GET` /apSnmpAgentProfiles

`DELETE` /apSnmpAgentProfiles

`POST` /apSnmpAgentProfiles

`GET` /applicationPolicies

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed items (object): > Application policy
- Changed property tenantId (string)

`DELETE` /applicationPolicies

`POST` /applicationPolicies

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json
Changed content type : application/json
- Changed property response (object)
  
  Application policy
  - Changed property tenantId (string)

`GET` /devicePolicies

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed items (object): > Network device-policy
- Changed property rules (array)
  
  Changed items (object): > Network device-policy rule
  - Changed property osVendor (string)
    
    The values of "Xbox360", "PlayStation2" and "PlayStation3" are now deprecated and will no longer be supported after 2024-07-31. However, the current back-end logic will continue to convert "Xbox360" to "Xbox" and also transform "PlayStation2" or "PlayStation3" to "PlayStation" for backward compatibility until that specified date.
    
    Added enum value:
    - PlayStation

`DELETE` /devicePolicies

`POST` /devicePolicies

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Changed property rules (array)

Changed items (object): > Network device-policy rule
- Changed property osVendor (string)
  
  The values of "Xbox360", "PlayStation2" and "PlayStation3" are now deprecated and will no longer be supported after 2024-07-31. However, the current back-end logic will continue to convert "Xbox360" to "Xbox" and also transform "PlayStation2" or "PlayStation3" to "PlayStation" for backward compatibility until that specified date.
  
  Added enum value:
  - PlayStation

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json
Changed content type : application/json
- Changed property response (object)
  
  Network device-policy
  - Changed property rules (array)
    
    Changed items (object): > Network device-policy rule
    - Changed property osVendor (string)
      
      The values of "Xbox360", "PlayStation2" and "PlayStation3" are now deprecated and will no longer be supported after 2024-07-31. However, the current back-end logic will continue to convert "Xbox360" to "Xbox" and also transform "PlayStation2" or "PlayStation3" to "PlayStation" for backward compatibility until that specified date.
      
      Added enum value:
      - PlayStation

`GET` /dhcpConfigServiceProfiles

`DELETE` /dhcpConfigServiceProfiles

`POST` /dhcpConfigServiceProfiles

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`GET` /isolationAllowlists

`DELETE` /isolationAllowlists

`POST` /isolationAllowlists

`DELETE` /l3AclPolicies/{l3AclPolicyId}

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`GET` /l3AclPolicies/{l3AclPolicyId}

Return Type:

Changed response : 200 OK

OK

New content type : application/vnd.ruckus.v1+json

`PUT` /l3AclPolicies/{l3AclPolicyId}

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`POST` /networkActivations/query

Get Network Activations by Query Filter

Request:

New content type : application/vnd.ruckus.v1+json

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object): > Network venue association
  - Changed property apGroups (array)
    
    Changed items (object): > Network to AP-Group activation
    - Changed property apGroupName (string)

`GET` /radiusServerProfiles

`DELETE` /radiusServerProfiles

`POST` /radiusServerProfiles

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`GET` /rogueApPolicyProfiles

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed items (object): > Rogue classification policy.
- Changed property venues (array)
  
  Changed items (object): > Entity ID and name

`DELETE` /rogueApPolicyProfiles

`POST` /rogueApPolicyProfiles

Request:

Changed content type : application/json

Changed property venues (array)

Changed items (object): > Entity ID and name

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property response (object)
  
  Rogue classification policy.
  - Changed property venues (array)
    
    Changed items (object): > Entity ID and name

`GET` /venues/apGroups/{apGroupId}/aps

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed items (object): > AP for requests
- Added property bssColoring (object)
  
  BSS Coloring Setting of an AP.
  - Property bssColoringEnabled (boolean)
  - Property useVenueSettings (boolean)
- Added property clientAdmissionControl (object)
  
  AP Client Admission Control Settings
  - Property enable24G (boolean)
  - Property enable50G (boolean)
  - Property maxRadioLoad24G (integer)
  - Property maxRadioLoad50G (integer)
  - Property minClientCount24G (integer)
  - Property minClientCount50G (integer)
  - Property minClientThroughput24G (integer)
  - Property minClientThroughput50G (integer)
  - Property useVenueSettings (boolean)
- Changed property tags (array)
  
  Changed items (string):
- Changed property radio (object)
  
  AP radio customization
  - Changed property apRadioParams24G (object)
    
    AP radio customization for 2.4GHz.
    - Added property useVenueSettings (boolean)
  - Changed property apRadioParams50G (object)
    
    AP radio customization for 5GHz.
    - Added property useVenueSettings (boolean)
  - Changed property apRadioParams6G (object)
    
    AP radio customization for 6GHz.
    - Added property enableMulticastDownlinkRateLimiting (boolean)
      
      Enable rate limiting of multicast downlink traffic on 6-GHz radio.
    - Added property enableMulticastUplinkRateLimiting (boolean)
      
      Enable rate limiting of multicast uplink traffic on 6-GHz radio.
    - Added property multicastDownlinkRateLimiting (integer)
      
      Rate limiting of multicast downlink traffic (Mbps) on 6-GHz radio. The value should be not greater than 50% of BSS min rate.
    - Added property multicastUplinkRateLimiting (integer)
      
      Rate limiting of multicast uplink traffic (Mbps) on 6-GHz radio.
    - Added property useVenueSettings (boolean)
  - Changed property apRadioParamsDual5G (object)
    
    AP radio customization for dual 5GHz radios.
    - Added property useVenueEnabled (boolean)

`POST` /venues/aps

Request:

Changed content type : application/json

Changed items (object): > AP request payload

Changed property tags (array)

Changed items (string):

`DELETE` /venues/aps

`GET` /venues/aps

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed items (object): > AP for requests
- Added property bssColoring (object)
  
  BSS Coloring Setting of an AP.
- Added property clientAdmissionControl (object)
  
  AP Client Admission Control Settings
- Changed property tags (array)
  
  Changed items (string):
- Changed property radio (object)
  
  AP radio customization
  - Changed property apRadioParams24G (object)
    
    AP radio customization for 2.4GHz.
    - Added property useVenueSettings (boolean)
  - Changed property apRadioParams50G (object)
    
    AP radio customization for 5GHz.
    - Added property useVenueSettings (boolean)
  - Changed property apRadioParams6G (object)
    
    AP radio customization for 6GHz.
    - Added property enableMulticastDownlinkRateLimiting (boolean)
      
      Enable rate limiting of multicast downlink traffic on 6-GHz radio.
    - Added property enableMulticastUplinkRateLimiting (boolean)
      
      Enable rate limiting of multicast uplink traffic on 6-GHz radio.
    - Added property multicastDownlinkRateLimiting (integer)
      
      Rate limiting of multicast downlink traffic (Mbps) on 6-GHz radio. The value should be not greater than 50% of BSS min rate.
    - Added property multicastUplinkRateLimiting (integer)
      
      Rate limiting of multicast uplink traffic (Mbps) on 6-GHz radio.
    - Added property useVenueSettings (boolean)
  - Changed property apRadioParamsDual5G (object)
    
    AP radio customization for dual 5GHz radios.
    - Added property useVenueEnabled (boolean)

`GET` /venues/aps/capabilities

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property apModels (array)
  
  Changed items (object): > AP model capabilities
  - Added property bandCombinationCapabilities (array)
    
    Items (string):
    
    Enum values:
    - DUAL
    - TRIPLE
  - Added property defaultBandCombination (string)
  - Added property supportBandCombination (boolean)
  - Added property supportMesh (boolean)

`PUT` /venues/aps/{serialNumber}

Request:

Changed content type : application/json

Changed property tags (array)

Changed items (string):

`DELETE` /venues/aps/{serialNumber}

`PATCH` /venues/aps/{serialNumber}

`GET` /venues/aps/{serialNumber}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Added property bssColoring (object)
  
  BSS Coloring Setting of an AP.
- Added property clientAdmissionControl (object)
  
  AP Client Admission Control Settings
- Changed property tags (array)
  
  Changed items (string):
- Changed property radio (object)
  
  AP radio customization
  - Changed property apRadioParams24G (object)
    
    AP radio customization for 2.4GHz.
    - Added property useVenueSettings (boolean)
  - Changed property apRadioParams50G (object)
    
    AP radio customization for 5GHz.
    - Added property useVenueSettings (boolean)
  - Changed property apRadioParams6G (object)
    
    AP radio customization for 6GHz.
    - Added property enableMulticastDownlinkRateLimiting (boolean)
      
      Enable rate limiting of multicast downlink traffic on 6-GHz radio.
    - Added property enableMulticastUplinkRateLimiting (boolean)
      
      Enable rate limiting of multicast uplink traffic on 6-GHz radio.
    - Added property multicastDownlinkRateLimiting (integer)
      
      Rate limiting of multicast downlink traffic (Mbps) on 6-GHz radio. The value should be not greater than 50% of BSS min rate.
    - Added property multicastUplinkRateLimiting (integer)
      
      Rate limiting of multicast uplink traffic (Mbps) on 6-GHz radio.
    - Added property useVenueSettings (boolean)
  - Changed property apRadioParamsDual5G (object)
    
    AP radio customization for dual 5GHz radios.
    - Added property useVenueEnabled (boolean)

`GET` /venues/aps/{serialNumber}/capabilities

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property apModels (array)
  
  Changed items (object): > AP model capabilities
  - Added property bandCombinationCapabilities (array)
  - Added property defaultBandCombination (string)
  - Added property supportBandCombination (boolean)
  - Added property supportMesh (boolean)

`GET` /venues/aps/{serialNumber}/channels

`GET` /venues/{venueId}/aps/capabilities

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property apModels (array)
  
  Changed items (object): > AP model capabilities
  - Added property bandCombinationCapabilities (array)
  - Added property defaultBandCombination (string)
  - Added property supportBandCombination (boolean)
  - Added property supportMesh (boolean)

`GET` /venues/{venueId}/cellularSettings

`PUT` /venues/{venueId}/cellularSettings

`GET` /venues/{venueId}/channels

`GET` /venues/{venueId}/mDnsFencingSettings

`PUT` /venues/{venueId}/mDnsFencingSettings

`DELETE` /venues/{venueId}/radioSettings

`GET` /venues/{venueId}/radioSettings

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property radioParams6G (object)
  
  Radio customization for 6GHz.
  - Added property enableMulticastDownlinkRateLimiting (boolean)
    
    Enable rate limiting of multicast downlink traffic on 6-GHz radio.
  - Added property enableMulticastUplinkRateLimiting (boolean)
    
    Enable rate limiting of multicast uplink traffic on 6-GHz radio.
  - Added property multicastDownlinkRateLimiting (integer)
    
    Rate limiting of multicast downlink traffic (Mbps) on 6-GHz radio. The value should be not greater than 50% of BSS min rate.
  - Added property multicastUplinkRateLimiting (integer)
    
    Rate limiting of multicast uplink traffic (Mbps) on 6-GHz radio.

`PUT` /venues/{venueId}/radioSettings

Request:

Changed content type : application/json

Changed property radioParams6G (object)

Radio customization for 6GHz.
- Added property enableMulticastDownlinkRateLimiting (boolean)
  
  Enable rate limiting of multicast downlink traffic on 6-GHz radio.
- Added property enableMulticastUplinkRateLimiting (boolean)
  
  Enable rate limiting of multicast uplink traffic on 6-GHz radio.
- Added property multicastDownlinkRateLimiting (integer)
  
  Rate limiting of multicast downlink traffic (Mbps) on 6-GHz radio. The value should be not greater than 50% of BSS min rate.
- Added property multicastUplinkRateLimiting (integer)
  
  Rate limiting of multicast uplink traffic (Mbps) on 6-GHz radio.

`POST` /vlanPools/{vlanPoolId}/venues

`GET` /portalServiceProfiles/{portalServiceProfileId}

Return Type:

Changed response : 200 OK

OK

New content type : application/vnd.ruckus.v1.1+json
Changed content type : application/json
- Added property name (string)
- Deleted property id (string)
- Deleted property serviceName (string)
- Deleted property tags (string)
- Deleted property networkIds (array)
- Changed property content (object)
  - Added property bgImageChecksum (string)
  - Added property photoChecksum (string)
  - Added property logoChecksum (string)
  - Added property poweredImgChecksum (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property content (object)
  - Added property bgImageChecksum (string)
  - Added property photoChecksum (string)
  - Added property logoChecksum (string)
  - Added property poweredImgChecksum (string)

`PUT` /portalServiceProfiles/{portalServiceProfileId}

Request:

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Changed property content (object)
- Added property bgImageChecksum (string)
- Added property photoChecksum (string)
- Added property logoChecksum (string)
- Added property poweredImgChecksum (string)

Changed content type : application/vnd.ruckus.v1+json

Changed property content (object)
- Added property bgImageChecksum (string)
- Added property photoChecksum (string)
- Added property logoChecksum (string)
- Added property poweredImgChecksum (string)

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1.1+json
Changed content type : application/json
- Deleted property response (object)
Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Changed property content (object)
    - Added property bgImageChecksum (string)
    - Added property photoChecksum (string)
    - Added property logoChecksum (string)
    - Added property poweredImgChecksum (string)

`DELETE` /portalServiceProfiles

Request:

Changed content type : application/json

`GET` /portalServiceProfiles

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property content (array)
  
  Changed items (object):
  - Changed property content (object)
    - Added property bgImageChecksum (string)
    - Added property photoChecksum (string)
    - Added property logoChecksum (string)
    - Added property poweredImgChecksum (string)

`POST` /portalServiceProfiles

Request:

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Changed property content (object)
- Added property bgImageChecksum (string)
- Added property photoChecksum (string)
- Added property logoChecksum (string)
- Added property poweredImgChecksum (string)

Changed content type : application/vnd.ruckus.v1+json

Changed property content (object)
- Added property bgImageChecksum (string)
- Added property photoChecksum (string)
- Added property logoChecksum (string)
- Added property poweredImgChecksum (string)

Return Type:

Changed response : 201 Created

Created

New content type : application/vnd.ruckus.v1.1+json
Changed content type : application/json
- Changed property response (object)
  - Deleted property serviceName (string)
  - Deleted property content (object)
  - Deleted property tags (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Changed property content (object)
    - Added property bgImageChecksum (string)
    - Added property photoChecksum (string)
    - Added property logoChecksum (string)
    - Added property poweredImgChecksum (string)

`POST` /networks/{networkId}/guestUsers

Return Type:

Changed response : 201 Created

Created

Changed content type : application/json
- Changed property response (object)
  - Changed property data (array)
    
    Changed items (object):
    - Changed property guestUserType (string)
      
      This field is not editable after creation.
      
      Added enum value:
      - Directory

`POST` /venues/switches/aggregationDetails

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Added property stackMemberOrder (string)
    - Added property veCount (integer)
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property tags (string)
        
        Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
      - Added property portSpeedConfig (string)
      - Added property portConnectorType (string)
      - Added property authDefaultVlan (string)
      - Deleted property tag (string)
        
        Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
      - Changed property vsixIngressAclName (string)
        
        The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
      - Changed property vsixEgressAclName (string)
        
        The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Added property stackMemberOrder (string)
    - Added property veCount (integer)
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property tags (string)
        
        Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
      - Added property portSpeedConfig (string)
      - Added property portConnectorType (string)
      - Added property authDefaultVlan (string)
      - Deleted property tag (string)
        
        Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
      - Changed property vsixIngressAclName (string)
        
        The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
      - Changed property vsixEgressAclName (string)
        
        The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Added property stackMemberOrder (string)
    - Added property veCount (integer)
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property tags (string)
        
        Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
      - Added property portSpeedConfig (string)
      - Added property portConnectorType (string)
      - Added property authDefaultVlan (string)
      - Deleted property tag (string)
        
        Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
      - Changed property vsixIngressAclName (string)
        
        The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
      - Changed property vsixEgressAclName (string)
        
        The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Added property stackMemberOrder (string)
    - Added property veCount (integer)
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property tags (string)
        
        Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
      - Added property portSpeedConfig (string)
      - Added property portConnectorType (string)
      - Added property authDefaultVlan (string)
      - Deleted property tag (string)
        
        Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
      - Changed property vsixIngressAclName (string)
        
        The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
      - Changed property vsixEgressAclName (string)
        
        The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.

`POST` /switches/aggregationDetails

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Added property stackMemberOrder (string)
    - Added property veCount (integer)
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property tags (string)
        
        Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
      - Added property portSpeedConfig (string)
      - Added property portConnectorType (string)
      - Added property authDefaultVlan (string)
      - Deleted property tag (string)
        
        Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
      - Changed property vsixIngressAclName (string)
        
        The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
      - Changed property vsixEgressAclName (string)
        
        The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Added property stackMemberOrder (string)
    - Added property veCount (integer)
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property tags (string)
        
        Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
      - Added property portSpeedConfig (string)
      - Added property portConnectorType (string)
      - Added property authDefaultVlan (string)
      - Deleted property tag (string)
        
        Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
      - Changed property vsixIngressAclName (string)
        
        The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
      - Changed property vsixEgressAclName (string)
        
        The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Added property stackMemberOrder (string)
    - Added property veCount (integer)
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property tags (string)
        
        Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
      - Added property portSpeedConfig (string)
      - Added property portConnectorType (string)
      - Added property authDefaultVlan (string)
      - Deleted property tag (string)
        
        Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
      - Changed property vsixIngressAclName (string)
        
        The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
      - Changed property vsixEgressAclName (string)
        
        The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Added property stackMemberOrder (string)
    - Added property veCount (integer)
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property tags (string)
        
        Tags name for the port. The tags name is an administrator configured name for the port, e.g., nickname.
      - Added property portSpeedConfig (string)
      - Added property portConnectorType (string)
      - Added property authDefaultVlan (string)
      - Deleted property tag (string)
        
        Tag name for the port. The tag name is an administrator configured name for the port, e.g., nickname.
      - Changed property vsixIngressAclName (string)
        
        The v6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.
      - Changed property vsixEgressAclName (string)
        
        The v6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an v6 ACL.

`POST` /enhancedVlanPoolProfiles/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

`DELETE` /l3AclPolicies

Delete Layer-3 ACL Policies.

`GET` /l3AclPolicies

Get Layer-3 ACL Policies.

`POST` /l3AclPolicies

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`DELETE` /venues/apGroups

`GET` /venues/apGroups

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed items (object): > AP-Group per venue containing a list of AP.
- Changed property name (string)
- Changed property aps (array)
  
  Changed items (object): > AP (deep)
  - Added property bssColoring (object)
    
    BSS Coloring Setting of an AP.
  - Added property clientAdmissionControl (object)
    
    AP Client Admission Control Settings
  - Changed property tags (array)
    
    Changed items (string):
  - Changed property radio (object)
    
    AP radio customization
    - Changed property apRadioParams24G (object)
      
      AP radio customization for 2.4GHz.
      - Added property useVenueSettings (boolean)
    - Changed property apRadioParams50G (object)
      
      AP radio customization for 5GHz.
      - Added property useVenueSettings (boolean)
    - Changed property apRadioParams6G (object)
      
      AP radio customization for 6GHz.
      - Added property enableMulticastDownlinkRateLimiting (boolean)
        
        Enable rate limiting of multicast downlink traffic on 6-GHz radio.
      - Added property enableMulticastUplinkRateLimiting (boolean)
        
        Enable rate limiting of multicast uplink traffic on 6-GHz radio.
      - Added property multicastDownlinkRateLimiting (integer)
        
        Rate limiting of multicast downlink traffic (Mbps) on 6-GHz radio. The value should be not greater than 50% of BSS min rate.
      - Added property multicastUplinkRateLimiting (integer)
        
        Rate limiting of multicast uplink traffic (Mbps) on 6-GHz radio.
      - Added property useVenueSettings (boolean)
    - Changed property apRadioParamsDual5G (object)
      
      AP radio customization for dual 5GHz radios.
      - Added property useVenueEnabled (boolean)

`PUT` /venues/apGroups/{apGroupId}

Request:

Changed content type : application/json

Changed property name (string)

`DELETE` /venues/apGroups/{apGroupId}

`GET` /venues/apGroups/{apGroupId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property name (string)
- Changed property aps (array)
  
  Changed items (object): > AP (deep)
  - Added property bssColoring (object)
    
    BSS Coloring Setting of an AP.
  - Added property clientAdmissionControl (object)
    
    AP Client Admission Control Settings
  - Changed property tags (array)
    
    Changed items (string):
  - Changed property radio (object)
    
    AP radio customization
    - Changed property apRadioParams24G (object)
      
      AP radio customization for 2.4GHz.
      - Added property useVenueSettings (boolean)
    - Changed property apRadioParams50G (object)
      
      AP radio customization for 5GHz.
      - Added property useVenueSettings (boolean)
    - Changed property apRadioParams6G (object)
      
      AP radio customization for 6GHz.
      - Added property enableMulticastDownlinkRateLimiting (boolean)
        
        Enable rate limiting of multicast downlink traffic on 6-GHz radio.
      - Added property enableMulticastUplinkRateLimiting (boolean)
        
        Enable rate limiting of multicast uplink traffic on 6-GHz radio.
      - Added property multicastDownlinkRateLimiting (integer)
        
        Rate limiting of multicast downlink traffic (Mbps) on 6-GHz radio. The value should be not greater than 50% of BSS min rate.
      - Added property multicastUplinkRateLimiting (integer)
        
        Rate limiting of multicast uplink traffic (Mbps) on 6-GHz radio.
      - Added property useVenueSettings (boolean)
    - Changed property apRadioParamsDual5G (object)
      
      AP radio customization for dual 5GHz radios.
      - Added property useVenueEnabled (boolean)

`GET` /venues/wifiSettings

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed items (object): > Venue
- Added property bssColoring (object)
  
  BSS Coloring settings
  - Property bssColoringEnabled (boolean)
- Added property clientAdmissionControl (object)
  
  Venue Client Admission Control Settings
  - Property enable24G (boolean)
  - Property enable50G (boolean)
  - Property maxRadioLoad24G (integer)
  - Property maxRadioLoad50G (integer)
  - Property minClientCount24G (integer)
  - Property minClientCount50G (integer)
  - Property minClientThroughput24G (integer)
  - Property minClientThroughput50G (integer)
- Changed property mesh (object)
  
  Venue mesh
  - Added property passphrase (string)
  - Added property radioType (string)
  - Added property ssid (string)
- Changed property radioCustomization (object)
  
  Venue radio customization
  - Changed property radioParams6G (object)
    
    Radio customization for 6GHz.
    - Added property enableMulticastDownlinkRateLimiting (boolean)
      
      Enable rate limiting of multicast downlink traffic on 6-GHz radio.
    - Added property enableMulticastUplinkRateLimiting (boolean)
      
      Enable rate limiting of multicast uplink traffic on 6-GHz radio.
    - Added property multicastDownlinkRateLimiting (integer)
      
      Rate limiting of multicast downlink traffic (Mbps) on 6-GHz radio. The value should be not greater than 50% of BSS min rate.
    - Added property multicastUplinkRateLimiting (integer)
      
      Rate limiting of multicast uplink traffic (Mbps) on 6-GHz radio.

`POST` /venues/{venueId}/apGroups

Request:

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Changed property name (string)

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
New content type : application/vnd.ruckus.v1.1+json

`GET` /venues/{venueId}/apGroups

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed items (object): > AP-Group per venue containing a list of AP.
- Changed property name (string)
- Changed property aps (array)
  
  Changed items (object): > AP (deep)
  - Added property bssColoring (object)
    
    BSS Coloring Setting of an AP.
  - Added property clientAdmissionControl (object)
    
    AP Client Admission Control Settings
  - Changed property tags (array)
    
    Changed items (string):
  - Changed property radio (object)
    
    AP radio customization
    - Changed property apRadioParams24G (object)
      
      AP radio customization for 2.4GHz.
      - Added property useVenueSettings (boolean)
    - Changed property apRadioParams50G (object)
      
      AP radio customization for 5GHz.
      - Added property useVenueSettings (boolean)
    - Changed property apRadioParams6G (object)
      
      AP radio customization for 6GHz.
      - Added property enableMulticastDownlinkRateLimiting (boolean)
        
        Enable rate limiting of multicast downlink traffic on 6-GHz radio.
      - Added property enableMulticastUplinkRateLimiting (boolean)
        
        Enable rate limiting of multicast uplink traffic on 6-GHz radio.
      - Added property multicastDownlinkRateLimiting (integer)
        
        Rate limiting of multicast downlink traffic (Mbps) on 6-GHz radio. The value should be not greater than 50% of BSS min rate.
      - Added property multicastUplinkRateLimiting (integer)
        
        Rate limiting of multicast uplink traffic (Mbps) on 6-GHz radio.
      - Added property useVenueSettings (boolean)
    - Changed property apRadioParamsDual5G (object)
      
      AP radio customization for dual 5GHz radios.
      - Added property useVenueEnabled (boolean)

`GET` /venues/{venueId}/wifiSettings

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Added property bssColoring (object)
  
  BSS Coloring settings
- Added property clientAdmissionControl (object)
  
  Venue Client Admission Control Settings
- Changed property mesh (object)
  
  Venue mesh
  - Added property passphrase (string)
  - Added property radioType (string)
  - Added property ssid (string)
- Changed property radioCustomization (object)
  
  Venue radio customization
  - Changed property radioParams6G (object)
    
    Radio customization for 6GHz.
    - Added property enableMulticastDownlinkRateLimiting (boolean)
      
      Enable rate limiting of multicast downlink traffic on 6-GHz radio.
    - Added property enableMulticastUplinkRateLimiting (boolean)
      
      Enable rate limiting of multicast uplink traffic on 6-GHz radio.
    - Added property multicastDownlinkRateLimiting (integer)
      
      Rate limiting of multicast downlink traffic (Mbps) on 6-GHz radio. The value should be not greater than 50% of BSS min rate.
    - Added property multicastUplinkRateLimiting (integer)
      
      Rate limiting of multicast uplink traffic (Mbps) on 6-GHz radio.

`POST` /msps/{mspTenantId}/ecInventories/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property uplink (array)
    
    Changed items (object):
    - Added property switchPort (string)
  - Changed property downlink (array)
    
    Changed items (object):
    - Added property switchPort (string)
    - Changed property deviceDto (object)
      - Added property switchPort (string)
  - Changed property apStatusData (object)
    - Deleted property vxlanStatus (object)
    - Changed property APRadio (array)
      
      Changed items (object):
      - Added property actualTxPower (integer)
      - Added property calibrationTxPower (integer)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property uplink (array)
    
    Changed items (object):
    - Added property switchPort (string)
  - Changed property downlink (array)
    
    Changed items (object):
    - Added property switchPort (string)
    - Changed property deviceDto (object)
      - Added property switchPort (string)
  - Changed property apStatusData (object)
    - Deleted property vxlanStatus (object)
    - Changed property APRadio (array)
      
      Changed items (object):
      - Added property actualTxPower (integer)
      - Added property calibrationTxPower (integer)

Changed response : 501 Not Implemented

not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property uplink (array)
    
    Changed items (object):
    - Added property switchPort (string)
  - Changed property downlink (array)
    
    Changed items (object):
    - Added property switchPort (string)
    - Changed property deviceDto (object)
      - Added property switchPort (string)
  - Changed property apStatusData (object)
    - Deleted property vxlanStatus (object)
    - Changed property APRadio (array)
      
      Changed items (object):
      - Added property actualTxPower (integer)
      - Added property calibrationTxPower (integer)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property uplink (array)
    
    Changed items (object):
    - Added property switchPort (string)
  - Changed property downlink (array)
    
    Changed items (object):
    - Added property switchPort (string)
    - Changed property deviceDto (object)
      - Added property switchPort (string)
  - Changed property apStatusData (object)
    - Deleted property vxlanStatus (object)
    - Changed property APRadio (array)
      
      Changed items (object):
      - Added property actualTxPower (integer)
      - Added property calibrationTxPower (integer)

`POST` /aps/query

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Changed content type : application/vnd.ruckus.v1+json

Deleted property sortByCountField (string)

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property switchPort (string)
  - Changed property uplink (array)
    
    Changed items (object):
    - Added property switchPort (string)
  - Changed property apStatusData (object)
    - Deleted property vxlanStatus (object)
    - Changed property APRadio (array)
      
      Changed items (object):
      - Added property actualTxPower (integer)
      - Added property calibrationTxPower (integer)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property switchPort (string)
  - Changed property uplink (array)
    
    Changed items (object):
    - Added property switchPort (string)
  - Changed property apStatusData (object)
    - Deleted property vxlanStatus (object)
    - Changed property APRadio (array)
      
      Changed items (object):
      - Added property actualTxPower (integer)
      - Added property calibrationTxPower (integer)

`GET` /networks

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed items (object): > Wi-Fi network
- Added property tenantId (string)
- Changed property id (string)

`DELETE` /networks

`POST` /networks

Request:

Changed content type : application/json

Added 'Wi-Fi_API_and_Model_Documentation_Hotspot20Network' :

Property id (string)
Property name (string)
Property tenantId (string)
Property type (string)
Property accountingInterimUpdates (integer)
Property accountingRadius (object)

Primary and secondary radius servers.
- Property id (string)
- Property name (string)
- Property primary (object)
  
  RADIUS server
  - Property ip (string)
  - Property port (integer)
  - Property sharedSecret (string)
- Property secondary (object)
  
  RADIUS server
- Property type (string)
  
  Enum values:
  - AUTHENTICATION
  - ACCOUNTING
Property authRadius (object)

Primary and secondary radius servers.
Property description (string)
Property enableAccountingProxy (boolean)
Property enableAuthProxy (boolean)
Property hotspot20Settings (object)

Network Hotspot 2.0 settings
- Property accessNetworkType (string)
  
  Enum values:
  - PRIVATE
  - PRIVATE_WITH_GUEST
  - CHARGEABLE_PUBLIC
  - FREE_PUBLIC
  - PERSONAL_DEVICE
  - TEST
  - WILDCARD
- Property allowInternetAccess (boolean)
- Property connectionCapabilities (array)
  
  Items (object):
  - Property port (integer)
  - Property protocol (string)
  - Property protocolNumber (integer)
  - Property status (string)
    
    Enum values:
    - CLOSED
    - OPEN
    - UNKNOWN
- Property ipv4AddressType (string)
  
  Enum values:
  - UNAVAILABLE
  - PUBLIC
  - PORT_RESTRICTED
  - SINGLE_NATED_PRIVATE
  - DOUBLE_NATED_PRIVATE
  - PORT_RESTRICTED_AND_SINGLE_NATED
  - PORT_RESTRICTED_AND_DOUBLE_NATED
  - UNKNOWN
Property name (string)
Property venues (array)

Items (object): > Network venue association
Property wlan (object)

WLAN
- Property advancedCustomization (object)
  
  WLAN advanced customization
  - Property accessControlEnable (boolean)
  - Property accessControlProfileId (string)
  - Property applicationPolicyEnable (boolean)
  - Property applicationPolicyId (string)
  - Property applicationVisibilityEnabled (boolean)
  - Property arpRequestRateLimit (integer)
  - Property broadcastProbeResponseDelay (integer)
  - Property clientInactivityTimeout (integer)
  - Property clientIsolation (boolean)
  - Property clientIsolationOptions (object)
    
    Client isolation options
    - Property autoVrrp (boolean)
    - Property packetsType (string)
      
      Enum values:
      - UNICAST
      - MULTICAST
      - UNICAST_MULTICAST
  - Property clientLoadBalancingEnable (boolean)
  - Property devicePolicyId (string)
  - Property dhcpRequestRateLimit (integer)
  - Property directedThreshold (integer)
  - Property dnsProxy (object)
    
    DNS proxy
    - Property dnsProxyRules (array)
      
      Items (object): > DNS proxy rule
      - Property domainName (string)
      - Property ipList (array)
        
        Items (string):
  - Property dnsProxyEnabled (boolean)
  - Property enableAaaVlanOverride (boolean)
  - Property enableAdditionalRegulatoryDomains (boolean)
  - Property enableAirtimeDecongestion (boolean)
  - Property enableAntiSpoofing (boolean)
  - Property enableApHostNameAdvertisement (boolean)
  - Property enableArpRequestRateLimit (boolean)
  - Property enableBandBalancing (boolean)
  - Property enableDhcpRequestRateLimit (boolean)
  - Property enableFastRoaming (boolean)
  - Property enableGtkRekey (boolean)
  - Property enableJoinRSSIThreshold (boolean)
  - Property enableMulticastDownlinkRateLimiting (boolean)
    
    Enable rate limiting of multicast downlink traffic.
  - Property enableMulticastDownlinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast downlink traffic on 6-GHz radio.
  - Property enableMulticastUplinkRateLimiting (boolean)
    
    Enable rate limiting of multicast uplink traffic.
  - Property enableMulticastUplinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast uplink traffic on 6-GHz radio.
  - Property enableNeighborReport (boolean)
  - Property enableOptimizedConnectivityExperience (boolean)
  - Property enableSyslog (boolean)
  - Property enableTransientClientManagement (boolean)
  - Property forceMobileDeviceDhcp (boolean)
  - Property hideSsid (boolean)
  - Property joinExpireTime (integer)
  - Property joinRSSIThreshold (integer)
  - Property joinWaitThreshold (integer)
  - Property joinWaitTime (integer)
  - Property l2AclEnable (boolean)
  - Property l2AclPolicyId (string)
  - Property l3AclEnable (boolean)
  - Property l3AclPolicyId (string)
  - Property maxClientsOnWlanPerRadio (integer)
  - Property mobilityDomainId (integer)
  - Property multicastDownlinkRateLimiting (integer)
    
    Rate limiting of multicast downlink traffic (Mbps). The value should be not greater than 50% of BSS min rate.
  - Property multicastFilterEnabled (boolean)
  - Property multicastUplinkRateLimiting (integer)
    
    Rate limiting of multicast uplink traffic (Mbps).
  - Property proxyARP (boolean)
  - Property qosMapSetEnabled (boolean)
  - Property qosMapSetOptions (object)
    
    QoS map set options.
    - Property rules (array)
      
      Items (object): > QoS map rule.
      - Property dscpExceptionValues (array)
        
        Items (integer):
      - Property dscpHigh (integer)
      - Property dscpLow (integer)
      - Property enabled (boolean)
      - Property priority (integer)
  - Property radioCustomization (object)
    
    WLAN radio customization
    - Property bssMinimumPhyRate (string)
      
      Enum values:
      - 1
      - 2
      - 5.5
      - 12
      - 24
      - default
    - Property managementFrameMinimumPhyRate (string)
      
      Enum values:
      - 1
      - 2
      - 5.5
      - 6
      - 9
      - 11
      - 12
      - 18
      - 24
    - Property phyTypeConstraint (string)
      
      Enum values:
      - OFDM
      - NONE
    - Property rfBandUsage (string)
      
      Enum values:
      - 2.4GHZ
      - 5.0GHZ
      - BOTH
  - Property radiusOptions (object)
    
    RADIUS custom settings
    - Property calledStationIdType (string)
      
      Enum values:
      - BSSID
      - AP_MAC
      - NONE
      - AP_GROUP
    - Property nasIdDelimiter (string)
      
      Enum values:
      - DASH
      - COLON
    - Property nasIdType (string)
      
      Enum values:
      - USER
      - BSSID
      - AP_MAC
      - VENUE_NAME
    - Property nasMaxRetry (integer)
    - Property nasReconnectPrimaryMin (integer)
    - Property nasRequestTimeoutSec (integer)
    - Property singleSessionIdAccounting (boolean)
    - Property userDefinedNasId (string)
  - Property respectiveAccessControl (boolean)
  - Property rssiAssociationRejectionThreshold (integer)
  - Property totalDownlinkRateLimiting (integer)
  - Property totalUplinkRateLimiting (integer)
  - Property userDownlinkRateLimiting (integer)
  - Property userUplinkRateLimiting (integer)
  - Property vlanPool (object)
    
    VLAN pool
    - Property description (string)
    - Property id (string)
    - Property name (string)
    - Property tenantId (string)
    - Property vlanMembers (array)
      
      Items (string):
  - Property wifiCallingEnabled (boolean)
  - Property wifiCallingIds (array)
    
    Items (string):
- Property enabled (boolean)
- Property managementFrameProtection (string)
  
  Enum values:
  - Disabled
  - Optional
  - Required
- Property ssid (string)
- Property vlanId (integer)
- Property wlanSecurity (string)
  
  Enum values:
  - WPA2Enterprise
  - WPA23Mixed
  - WPA3

Updated Wi-Fi_API_and_Model_Documentation_PskNetwork :

Changed property wlan (object)

WLAN
- Added property macRegistrationListId (string)
- Changed property advancedCustomization (object)
  
  WLAN advanced customization
  - Added property applicationVisibilityEnabled (boolean)
  - Added property enableAdditionalRegulatoryDomains (boolean)
  - Added property enableApHostNameAdvertisement (boolean)
  - Added property enableGtkRekey (boolean)
  - Added property enableMulticastDownlinkRateLimiting (boolean)
    
    Enable rate limiting of multicast downlink traffic.
  - Added property enableMulticastDownlinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast downlink traffic on 6-GHz radio.
  - Added property enableMulticastUplinkRateLimiting (boolean)
    
    Enable rate limiting of multicast uplink traffic.
  - Added property enableMulticastUplinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast uplink traffic on 6-GHz radio.
  - Added property multicastDownlinkRateLimiting (integer)
    
    Rate limiting of multicast downlink traffic (Mbps). The value should be not greater than 50% of BSS min rate.
  - Added property multicastFilterEnabled (boolean)
  - Added property multicastUplinkRateLimiting (integer)
    
    Rate limiting of multicast uplink traffic (Mbps).
  - Added property qosMapSetEnabled (boolean)
  - Added property qosMapSetOptions (object)
    
    QoS map set options.
  - Changed property wifiCallingIds (array)
    
    Changed items (string):

Updated Wi-Fi_API_and_Model_Documentation_AAANetwork :

Changed property wlan (object)

WLAN
- Added property macAddressAuthenticationConfiguration (object)
  
  MAC address authentication configuration
  - Property macAddressAuthentication (boolean)
  - Property macAuthMacFormat (string)
    
    Enum values:
    - Lower
    - UpperDash
    - UpperColon
    - Upper
    - LowerDash
    - LowerColon
- Changed property advancedCustomization (object)
  
  WLAN advanced customization
  - Added property applicationVisibilityEnabled (boolean)
  - Added property enableAdditionalRegulatoryDomains (boolean)
  - Added property enableApHostNameAdvertisement (boolean)
  - Added property enableGtkRekey (boolean)
  - Added property enableMulticastDownlinkRateLimiting (boolean)
    
    Enable rate limiting of multicast downlink traffic.
  - Added property enableMulticastDownlinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast downlink traffic on 6-GHz radio.
  - Added property enableMulticastUplinkRateLimiting (boolean)
    
    Enable rate limiting of multicast uplink traffic.
  - Added property enableMulticastUplinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast uplink traffic on 6-GHz radio.
  - Added property multicastDownlinkRateLimiting (integer)
    
    Rate limiting of multicast downlink traffic (Mbps). The value should be not greater than 50% of BSS min rate.
  - Added property multicastFilterEnabled (boolean)
  - Added property multicastUplinkRateLimiting (integer)
    
    Rate limiting of multicast uplink traffic (Mbps).
  - Added property qosMapSetEnabled (boolean)
  - Added property qosMapSetOptions (object)
    
    QoS map set options.
  - Changed property wifiCallingIds (array)
    
    Changed items (string):

Updated Wi-Fi_API_and_Model_Documentation_DpskNetwork :

Changed property wlan (object)

WLAN
- Changed property advancedCustomization (object)
  
  WLAN advanced customization
  - Added property applicationVisibilityEnabled (boolean)
  - Added property enableAdditionalRegulatoryDomains (boolean)
  - Added property enableApHostNameAdvertisement (boolean)
  - Added property enableGtkRekey (boolean)
  - Added property enableMulticastDownlinkRateLimiting (boolean)
    
    Enable rate limiting of multicast downlink traffic.
  - Added property enableMulticastDownlinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast downlink traffic on 6-GHz radio.
  - Added property enableMulticastUplinkRateLimiting (boolean)
    
    Enable rate limiting of multicast uplink traffic.
  - Added property enableMulticastUplinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast uplink traffic on 6-GHz radio.
  - Added property multicastDownlinkRateLimiting (integer)
    
    Rate limiting of multicast downlink traffic (Mbps). The value should be not greater than 50% of BSS min rate.
  - Added property multicastFilterEnabled (boolean)
  - Added property multicastUplinkRateLimiting (integer)
    
    Rate limiting of multicast uplink traffic (Mbps).
  - Added property qosMapSetEnabled (boolean)
  - Added property qosMapSetOptions (object)
    
    QoS map set options.
  - Changed property wifiCallingIds (array)
    
    Changed items (string):

Updated Wi-Fi_API_and_Model_Documentation_OpenNetwork :

Changed property wlan (object)

WLAN
- Added property macAddressAuthentication (boolean)
- Added property macAuthMacFormat (string)
- Added property macRegistrationListId (string)
- Added property wlanSecurity (string)
  
  Enum values:
  - Open
  - OWE
  - OWETransition
- Changed property advancedCustomization (object)
  
  WLAN advanced customization
  - Added property applicationVisibilityEnabled (boolean)
  - Added property enableAaaVlanOverride (boolean)
  - Added property enableAdditionalRegulatoryDomains (boolean)
  - Added property enableApHostNameAdvertisement (boolean)
  - Added property enableGtkRekey (boolean)
  - Added property enableMulticastDownlinkRateLimiting (boolean)
    
    Enable rate limiting of multicast downlink traffic.
  - Added property enableMulticastDownlinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast downlink traffic on 6-GHz radio.
  - Added property enableMulticastUplinkRateLimiting (boolean)
    
    Enable rate limiting of multicast uplink traffic.
  - Added property enableMulticastUplinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast uplink traffic on 6-GHz radio.
  - Added property multicastDownlinkRateLimiting (integer)
    
    Rate limiting of multicast downlink traffic (Mbps). The value should be not greater than 50% of BSS min rate.
  - Added property multicastFilterEnabled (boolean)
  - Added property multicastUplinkRateLimiting (integer)
    
    Rate limiting of multicast uplink traffic (Mbps).
  - Added property qosMapSetEnabled (boolean)
  - Added property qosMapSetOptions (object)
    
    QoS map set options.
  - Changed property wifiCallingIds (array)
    
    Changed items (string):

Updated Wi-Fi_API_and_Model_Documentation_GuestNetwork :

Changed property guestPortal (object)

Network configuration of guest access including captive portal settings and authentication settings.
- Changed property guestNetworkType (string)
  
  Added enum value:
  - Directory
- Changed property macCredentialsDuration (integer)
  
  Keep supporting for a maximum value of 1440 until the enhancement feature is released.
- Changed property hostGuestConfig (object)
  
  Host guest configuration
  
  New optional properties:
  - hostDomains
  - Changed property hostDurationChoices (array)
    
    Changed items (integer):
Changed property wlan (object)

Guest WLAN
- Changed property advancedCustomization (object)
  
  WLAN advanced customization
  - Added property applicationVisibilityEnabled (boolean)
  - Added property enableAdditionalRegulatoryDomains (boolean)
  - Added property enableApHostNameAdvertisement (boolean)
  - Added property enableGtkRekey (boolean)
  - Added property enableMulticastDownlinkRateLimiting (boolean)
    
    Enable rate limiting of multicast downlink traffic.
  - Added property enableMulticastDownlinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast downlink traffic on 6-GHz radio.
  - Added property enableMulticastUplinkRateLimiting (boolean)
    
    Enable rate limiting of multicast uplink traffic.
  - Added property enableMulticastUplinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast uplink traffic on 6-GHz radio.
  - Added property multicastDownlinkRateLimiting (integer)
    
    Rate limiting of multicast downlink traffic (Mbps). The value should be not greater than 50% of BSS min rate.
  - Added property multicastFilterEnabled (boolean)
  - Added property multicastUplinkRateLimiting (integer)
    
    Rate limiting of multicast uplink traffic (Mbps).
  - Added property qosMapSetEnabled (boolean)
  - Added property qosMapSetOptions (object)
    
    QoS map set options.
  - Changed property wifiCallingIds (array)
    
    Changed items (string):
  - Changed property vlanPool (object)
    
    VLAN pool
    - Changed property vlanMembers (array)
      
      Changed items (string):
  - Changed property dnsProxy (object)
    
    DNS proxy
    - Changed property dnsProxyRules (array)
      
      Changed items (object): > DNS proxy rule
      - Changed property ipList (array)
        
        Changed items (string):

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property response (object)
  
  Wi-Fi network
  - Added property tenantId (string)
  - Changed property id (string)

`GET` /networks/wisprProviders

`GET` /networks/{networkId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Added property tenantId (string)
- Changed property id (string)

`DELETE` /networks/{networkId}

`PUT` /networks/{networkId}

Request:

Changed content type : application/json

Added 'Wi-Fi_API_and_Model_Documentation_Hotspot20Network' : Updated Wi-Fi_API_and_Model_Documentation_PskNetwork :

Changed property wlan (object)

WLAN
- Added property macRegistrationListId (string)
- Changed property advancedCustomization (object)
  
  WLAN advanced customization
  - Added property applicationVisibilityEnabled (boolean)
  - Added property enableAdditionalRegulatoryDomains (boolean)
  - Added property enableApHostNameAdvertisement (boolean)
  - Added property enableGtkRekey (boolean)
  - Added property enableMulticastDownlinkRateLimiting (boolean)
    
    Enable rate limiting of multicast downlink traffic.
  - Added property enableMulticastDownlinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast downlink traffic on 6-GHz radio.
  - Added property enableMulticastUplinkRateLimiting (boolean)
    
    Enable rate limiting of multicast uplink traffic.
  - Added property enableMulticastUplinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast uplink traffic on 6-GHz radio.
  - Added property multicastDownlinkRateLimiting (integer)
    
    Rate limiting of multicast downlink traffic (Mbps). The value should be not greater than 50% of BSS min rate.
  - Added property multicastFilterEnabled (boolean)
  - Added property multicastUplinkRateLimiting (integer)
    
    Rate limiting of multicast uplink traffic (Mbps).
  - Added property qosMapSetEnabled (boolean)
  - Added property qosMapSetOptions (object)
    
    QoS map set options.
  - Changed property wifiCallingIds (array)
    
    Changed items (string):

Updated Wi-Fi_API_and_Model_Documentation_AAANetwork :

Changed property wlan (object)

WLAN
- Added property macAddressAuthenticationConfiguration (object)
  
  MAC address authentication configuration
- Changed property advancedCustomization (object)
  
  WLAN advanced customization
  - Added property applicationVisibilityEnabled (boolean)
  - Added property enableAdditionalRegulatoryDomains (boolean)
  - Added property enableApHostNameAdvertisement (boolean)
  - Added property enableGtkRekey (boolean)
  - Added property enableMulticastDownlinkRateLimiting (boolean)
    
    Enable rate limiting of multicast downlink traffic.
  - Added property enableMulticastDownlinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast downlink traffic on 6-GHz radio.
  - Added property enableMulticastUplinkRateLimiting (boolean)
    
    Enable rate limiting of multicast uplink traffic.
  - Added property enableMulticastUplinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast uplink traffic on 6-GHz radio.
  - Added property multicastDownlinkRateLimiting (integer)
    
    Rate limiting of multicast downlink traffic (Mbps). The value should be not greater than 50% of BSS min rate.
  - Added property multicastFilterEnabled (boolean)
  - Added property multicastUplinkRateLimiting (integer)
    
    Rate limiting of multicast uplink traffic (Mbps).
  - Added property qosMapSetEnabled (boolean)
  - Added property qosMapSetOptions (object)
    
    QoS map set options.
  - Changed property wifiCallingIds (array)
    
    Changed items (string):

Updated Wi-Fi_API_and_Model_Documentation_DpskNetwork :

Changed property wlan (object)

WLAN
- Changed property advancedCustomization (object)
  
  WLAN advanced customization
  - Added property applicationVisibilityEnabled (boolean)
  - Added property enableAdditionalRegulatoryDomains (boolean)
  - Added property enableApHostNameAdvertisement (boolean)
  - Added property enableGtkRekey (boolean)
  - Added property enableMulticastDownlinkRateLimiting (boolean)
    
    Enable rate limiting of multicast downlink traffic.
  - Added property enableMulticastDownlinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast downlink traffic on 6-GHz radio.
  - Added property enableMulticastUplinkRateLimiting (boolean)
    
    Enable rate limiting of multicast uplink traffic.
  - Added property enableMulticastUplinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast uplink traffic on 6-GHz radio.
  - Added property multicastDownlinkRateLimiting (integer)
    
    Rate limiting of multicast downlink traffic (Mbps). The value should be not greater than 50% of BSS min rate.
  - Added property multicastFilterEnabled (boolean)
  - Added property multicastUplinkRateLimiting (integer)
    
    Rate limiting of multicast uplink traffic (Mbps).
  - Added property qosMapSetEnabled (boolean)
  - Added property qosMapSetOptions (object)
    
    QoS map set options.
  - Changed property wifiCallingIds (array)
    
    Changed items (string):

Updated Wi-Fi_API_and_Model_Documentation_OpenNetwork :

Changed property wlan (object)

WLAN
- Added property macAddressAuthentication (boolean)
- Added property macAuthMacFormat (string)
- Added property macRegistrationListId (string)
- Added property wlanSecurity (string)
- Changed property advancedCustomization (object)
  
  WLAN advanced customization
  - Added property applicationVisibilityEnabled (boolean)
  - Added property enableAaaVlanOverride (boolean)
  - Added property enableAdditionalRegulatoryDomains (boolean)
  - Added property enableApHostNameAdvertisement (boolean)
  - Added property enableGtkRekey (boolean)
  - Added property enableMulticastDownlinkRateLimiting (boolean)
    
    Enable rate limiting of multicast downlink traffic.
  - Added property enableMulticastDownlinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast downlink traffic on 6-GHz radio.
  - Added property enableMulticastUplinkRateLimiting (boolean)
    
    Enable rate limiting of multicast uplink traffic.
  - Added property enableMulticastUplinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast uplink traffic on 6-GHz radio.
  - Added property multicastDownlinkRateLimiting (integer)
    
    Rate limiting of multicast downlink traffic (Mbps). The value should be not greater than 50% of BSS min rate.
  - Added property multicastFilterEnabled (boolean)
  - Added property multicastUplinkRateLimiting (integer)
    
    Rate limiting of multicast uplink traffic (Mbps).
  - Added property qosMapSetEnabled (boolean)
  - Added property qosMapSetOptions (object)
    
    QoS map set options.
  - Changed property wifiCallingIds (array)
    
    Changed items (string):

Updated Wi-Fi_API_and_Model_Documentation_GuestNetwork :

Changed property guestPortal (object)

Network configuration of guest access including captive portal settings and authentication settings.
- Changed property guestNetworkType (string)
  
  Added enum value:
  - Directory
- Changed property macCredentialsDuration (integer)
  
  Keep supporting for a maximum value of 1440 until the enhancement feature is released.
- Changed property hostGuestConfig (object)
  
  Host guest configuration
  
  New optional properties:
  - hostDomains
  - Changed property hostDurationChoices (array)
    
    Changed items (integer):
Changed property wlan (object)

Guest WLAN
- Changed property advancedCustomization (object)
  
  WLAN advanced customization
  - Added property applicationVisibilityEnabled (boolean)
  - Added property enableAdditionalRegulatoryDomains (boolean)
  - Added property enableApHostNameAdvertisement (boolean)
  - Added property enableGtkRekey (boolean)
  - Added property enableMulticastDownlinkRateLimiting (boolean)
    
    Enable rate limiting of multicast downlink traffic.
  - Added property enableMulticastDownlinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast downlink traffic on 6-GHz radio.
  - Added property enableMulticastUplinkRateLimiting (boolean)
    
    Enable rate limiting of multicast uplink traffic.
  - Added property enableMulticastUplinkRateLimiting6G (boolean)
    
    Enable rate limiting of multicast uplink traffic on 6-GHz radio.
  - Added property multicastDownlinkRateLimiting (integer)
    
    Rate limiting of multicast downlink traffic (Mbps). The value should be not greater than 50% of BSS min rate.
  - Added property multicastFilterEnabled (boolean)
  - Added property multicastUplinkRateLimiting (integer)
    
    Rate limiting of multicast uplink traffic (Mbps).
  - Added property qosMapSetEnabled (boolean)
  - Added property qosMapSetOptions (object)
    
    QoS map set options.
  - Changed property wifiCallingIds (array)
    
    Changed items (string):
  - Changed property vlanPool (object)
    
    VLAN pool
    - Changed property vlanMembers (array)
      
      Changed items (string):
  - Changed property dnsProxy (object)
    
    DNS proxy
    - Changed property dnsProxyRules (array)
      
      Changed items (object): > DNS proxy rule
      - Changed property ipList (array)
        
        Changed items (string):

`POST` /aps/aggregationDetails

Request:

Changed content type : application/json

Deleted property sortByCountField (string)

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property groupedField (string)
  - Added property groupedValue (string)
  - Changed property deviceGroupId (string)
  - Changed property deviceGroupName (string)
  - Changed property deviceStatus (string)
  - Changed property venueId (string)
  - Changed property model (string)
  - Changed property members (integer)
  - Changed property incidents (integer)
  - Changed property clients (integer)
  - Changed property aps (array)
    
    Changed items (object):
    - Added property switchPort (string)
    - Changed property uplink (array)
      
      Changed items (object):
      - Added property switchPort (string)
    - Changed property apStatusData (object)
      - Deleted property vxlanStatus (object)
      - Changed property APRadio (array)
        
        Changed items (object):
        
        Added property actualTxPower (integer)
        
        Added property calibrationTxPower (integer)

`GET` /tenants/self

Return Type:

Changed response : 200 OK

OK

Changed content type : application/vnd.ruckus.v1+json
- Deleted property inMaintenance (boolean)
- Changed property authentications (array)
  
  Changed items (object):
  - Deleted property samlSignatureEnabled (boolean)
- Changed property admins (array)
  
  Changed items (object):
  - Deleted property specialRoles (array)
Changed content type : application/json
- Deleted property inMaintenance (boolean)
- Changed property authentications (array)
  
  Changed items (object):
  - Deleted property samlSignatureEnabled (boolean)
- Changed property admins (array)
  
  Changed items (object):
  - Deleted property specialRoles (array)

`PUT` /admins

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Deleted property specialRoles (array)
  - Changed property authentication (object)
    - Deleted property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Deleted property inMaintenance (boolean)
Changed content type : application/json
- Changed property response (object)
  - Deleted property specialRoles (array)
  - Changed property authentication (object)
    - Deleted property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Deleted property inMaintenance (boolean)

Changed response : 500 Internal Server Error

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Deleted property specialRoles (array)
  - Changed property authentication (object)
    - Deleted property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Deleted property inMaintenance (boolean)
Changed content type : application/json
- Changed property response (object)
  - Deleted property specialRoles (array)
  - Changed property authentication (object)
    - Deleted property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Deleted property inMaintenance (boolean)

`POST` /admins

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Deleted property specialRoles (array)
  - Changed property authentication (object)
    - Deleted property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Deleted property inMaintenance (boolean)
Changed content type : application/json
- Changed property response (object)
  - Deleted property specialRoles (array)
  - Changed property authentication (object)
    - Deleted property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Deleted property inMaintenance (boolean)

Changed response : 400 Bad Request

Bad/Malformed Request [TNT-10300: "Admin already invited to different account", TNT-10302: "Admin already registered to Ruckus Support", TNT-10303: "Admin already exists"]

Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Deleted property specialRoles (array)
  - Changed property authentication (object)
    - Deleted property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Deleted property inMaintenance (boolean)
Changed content type : application/json
- Changed property response (object)
  - Deleted property specialRoles (array)
  - Changed property authentication (object)
    - Deleted property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Deleted property inMaintenance (boolean)

Changed response : 500 Internal Server Error

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Deleted property specialRoles (array)
  - Changed property authentication (object)
    - Deleted property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Deleted property inMaintenance (boolean)
Changed content type : application/json
- Changed property response (object)
  - Deleted property specialRoles (array)
  - Changed property authentication (object)
    - Deleted property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Deleted property inMaintenance (boolean)

`GET` /venues/{venueId}/topologies

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property edges (array)
    
    Changed items (object):
    - Changed property connectionStatus (string)
      
      Removed enum value:
      - NoInformation
    - Changed property extraEdges (array)
      
      Changed items (object):
      - Changed property connectionStatus (string)
        
        Removed enum value:
        
        NoInformation
  - Changed property nodes (array)
    
    Changed items (object):
    - Changed property downlink (array)
      
      Changed items (object):
      - Added property switchPort (string)
    - Changed property uplink (array)
      
      Changed items (object):
      - Added property switchPort (string)
      - Changed property deviceDto (object)
        
        Added property switchPort (string)
      - Changed property apStatusData (object)
        
        Deleted property vxlanStatus (object)
        
        Changed property APRadio (array)
        
        Changed items (object):
        
        Added property actualTxPower (integer)
        
        Added property calibrationTxPower (integer)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property edges (array)
    
    Changed items (object):
    - Changed property connectionStatus (string)
      
      Removed enum value:
      - NoInformation
    - Changed property extraEdges (array)
      
      Changed items (object):
      - Changed property connectionStatus (string)
        
        Removed enum value:
        
        NoInformation
  - Changed property nodes (array)
    
    Changed items (object):
    - Changed property downlink (array)
      
      Changed items (object):
      - Added property switchPort (string)
    - Changed property uplink (array)
      
      Changed items (object):
      - Added property switchPort (string)
      - Changed property deviceDto (object)
        
        Added property switchPort (string)
      - Changed property apStatusData (object)
        
        Deleted property vxlanStatus (object)
        
        Changed property APRadio (array)
        
        Changed items (object):
        
        Added property actualTxPower (integer)
        
        Added property calibrationTxPower (integer)

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property edges (array)
    
    Changed items (object):
    - Changed property connectionStatus (string)
      
      Removed enum value:
      - NoInformation
    - Changed property extraEdges (array)
      
      Changed items (object):
      - Changed property connectionStatus (string)
        
        Removed enum value:
        
        NoInformation
  - Changed property nodes (array)
    
    Changed items (object):
    - Changed property downlink (array)
      
      Changed items (object):
      - Added property switchPort (string)
    - Changed property uplink (array)
      
      Changed items (object):
      - Added property switchPort (string)
      - Changed property deviceDto (object)
        
        Added property switchPort (string)
      - Changed property apStatusData (object)
        
        Deleted property vxlanStatus (object)
        
        Changed property APRadio (array)
        
        Changed items (object):
        
        Added property actualTxPower (integer)
        
        Added property calibrationTxPower (integer)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property edges (array)
    
    Changed items (object):
    - Changed property connectionStatus (string)
      
      Removed enum value:
      - NoInformation
    - Changed property extraEdges (array)
      
      Changed items (object):
      - Changed property connectionStatus (string)
        
        Removed enum value:
        
        NoInformation
  - Changed property nodes (array)
    
    Changed items (object):
    - Changed property downlink (array)
      
      Changed items (object):
      - Added property switchPort (string)
    - Changed property uplink (array)
      
      Changed items (object):
      - Added property switchPort (string)
      - Changed property deviceDto (object)
        
        Added property switchPort (string)
      - Changed property apStatusData (object)
        
        Deleted property vxlanStatus (object)
        
        Changed property APRadio (array)
        
        Changed items (object):
        
        Added property actualTxPower (integer)
        
        Added property calibrationTxPower (integer)

`GET` /venues/{venueId}/meshTopologies

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property edges (array)
    
    Changed items (object):
    - Changed property connectionStatus (string)
      
      Removed enum value:
      - NoInformation
    - Changed property extraEdges (array)
      
      Changed items (object):
      - Changed property connectionStatus (string)
        
        Removed enum value:
        
        NoInformation
  - Changed property nodes (array)
    
    Changed items (object):
    - Changed property downlink (array)
      
      Changed items (object):
      - Added property switchPort (string)
    - Changed property uplink (array)
      
      Changed items (object):
      - Added property switchPort (string)
      - Changed property deviceDto (object)
        
        Added property switchPort (string)
      - Changed property apStatusData (object)
        
        Deleted property vxlanStatus (object)
        
        Changed property APRadio (array)
        
        Changed items (object):
        
        Added property actualTxPower (integer)
        
        Added property calibrationTxPower (integer)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property edges (array)
    
    Changed items (object):
    - Changed property connectionStatus (string)
      
      Removed enum value:
      - NoInformation
    - Changed property extraEdges (array)
      
      Changed items (object):
      - Changed property connectionStatus (string)
        
        Removed enum value:
        
        NoInformation
  - Changed property nodes (array)
    
    Changed items (object):
    - Changed property downlink (array)
      
      Changed items (object):
      - Added property switchPort (string)
    - Changed property uplink (array)
      
      Changed items (object):
      - Added property switchPort (string)
      - Changed property deviceDto (object)
        
        Added property switchPort (string)
      - Changed property apStatusData (object)
        
        Deleted property vxlanStatus (object)
        
        Changed property APRadio (array)
        
        Changed items (object):
        
        Added property actualTxPower (integer)
        
        Added property calibrationTxPower (integer)

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property edges (array)
    
    Changed items (object):
    - Changed property connectionStatus (string)
      
      Removed enum value:
      - NoInformation
    - Changed property extraEdges (array)
      
      Changed items (object):
      - Changed property connectionStatus (string)
        
        Removed enum value:
        
        NoInformation
  - Changed property nodes (array)
    
    Changed items (object):
    - Changed property downlink (array)
      
      Changed items (object):
      - Added property switchPort (string)
    - Changed property uplink (array)
      
      Changed items (object):
      - Added property switchPort (string)
      - Changed property deviceDto (object)
        
        Added property switchPort (string)
      - Changed property apStatusData (object)
        
        Deleted property vxlanStatus (object)
        
        Changed property APRadio (array)
        
        Changed items (object):
        
        Added property actualTxPower (integer)
        
        Added property calibrationTxPower (integer)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property edges (array)
    
    Changed items (object):
    - Changed property connectionStatus (string)
      
      Removed enum value:
      - NoInformation
    - Changed property extraEdges (array)
      
      Changed items (object):
      - Changed property connectionStatus (string)
        
        Removed enum value:
        
        NoInformation
  - Changed property nodes (array)
    
    Changed items (object):
    - Changed property downlink (array)
      
      Changed items (object):
      - Added property switchPort (string)
    - Changed property uplink (array)
      
      Changed items (object):
      - Added property switchPort (string)
      - Changed property deviceDto (object)
        
        Added property switchPort (string)
      - Changed property apStatusData (object)
        
        Deleted property vxlanStatus (object)
        
        Changed property APRadio (array)
        
        Changed items (object):
        
        Added property actualTxPower (integer)
        
        Added property calibrationTxPower (integer)

2024-11-07

What's Deleted

`GET` /edgeFirewallServices/{firewallId}

Get Firewall

`PUT` /edgeFirewallServices/{firewallId}

Update Firewall

`DELETE` /edgeFirewallServices/{firewallId}

Delete Firewall

`PATCH` /edgeFirewallServices/{firewallId}

Partial Update Firewall

`GET` /edgeDhcpServices/{dhcpId}

Get DHCP

`PUT` /edgeDhcpServices/{dhcpId}

Update DHCP

`DELETE` /edgeDhcpServices/{dhcpId}

Delete DHCP

`PATCH` /edgeDhcpServices/{dhcpId}

Patch DHCP

`GET` /edgeFirewallServices

Get Firewalls

`POST` /edgeFirewallServices

Create Firewall

`DELETE` /edgeFirewallServices

Delete Firewalls

`POST` /edgeDhcpServices

Create DHCP

`DELETE` /edgeDhcpServices

Delete DHCPs

`GET` /edgeDhcpServices/edgeDhcpRelationships/{edgeId}

Get DHCP by Edge ID

`GET` /edgeDhcpServices/dhcps

Get DHCPs

2024-10-09

What's New

`PUT` /certificateTemplates/{templateId}/policySets/{policySetId}

Update Policy Set for a Template

`DELETE` /certificateTemplates/{templateId}/policySets/{policySetId}

Remove Policy Set from a Template

`GET` /certificates/{certId}

Get Specific Certificate

`POST` /certificates/{certId}

Download the Private KEY of Certificate

`PATCH` /certificates/{certId}

Update the Certificate

`POST` /certificates/query

Search for Certificates Matching Search String in Paged Result

`POST` /certificates

Upload the Certificate

`GET` /certificateTemplates/{templateId}/scepKeys

Get Simple Certificate Enrollment Protocol of Template

`POST` /certificateTemplates/{templateId}/scepKeys

Create Simple Certificate Enrollment Protocol for Template

`GET` /certificateTemplates/{templateId}/notifications

Get Notifications of Template

`POST` /certificateTemplates/{templateId}/notifications

Create Notification for Template

`GET` /certificateTemplates/{templateId}/msiPackages

Get Microsoft Software Installer Packages of Template

`POST` /certificateTemplates/{templateId}/msiPackages

Create Microsoft Software Installer Package for Template

`POST` /certificateTemplates/{templateId}/identities/{identityId}/certificates

Generate Certificate to a Specific Identity

`POST` /certificateTemplates/{templateId}/identities/{identityId}/certificates/query

Search for Certificates Associated with Identity in Paged Result

`POST` /certificateTemplates/{templateId}/certificates

Generate Certificate

`GET` /certificateTemplates/{templateId}/certificates/{certId}

Get Specific Certificate

`POST` /certificateTemplates/{templateId}/certificates/{certId}

Download the Private KEY of Certificate

`PATCH` /certificateTemplates/{templateId}/certificates/{certId}

Update the Certificate

`POST` /certificateTemplates/{templateId}/certificates/query

Search for Certificates in Specific Template Matching Search String in Paged Result

`POST` /certificateTemplates/query

Search for Certificate Templates Matching Search String in Paged Result

`POST` /certificateTemplates/certificates/query

Search for Certificates Matching Search String in Paged Result

`POST` /certificateAuthorities

Create New Certificate Authority

`GET` /certificateAuthorities/{caId}

Get Specific Certificate Authority

`POST` /certificateAuthorities/{caId}

Download the Private KEY of Certificate Authority

`DELETE` /certificateAuthorities/{caId}

Delete the Certificate Authority

`PATCH` /certificateAuthorities/{caId}

Update the Certificate Authority

`POST` /certificateAuthorities/{caId}/templates

Create New Certificate Template Belonging to a Specific Certificate Authority

`POST` /certificateAuthorities/{caId}/templates/query

Search for Templates Belonging to a Specific Certificate Authority That Match Search String in Paged Result

`POST` /certificateAuthorities/{caId}/subCas

Create New Sub Certificate Authority

`POST` /certificateAuthorities/{caId}/subCas/query

Search for Sub Certificate Authorities Matching Search String in Paged Result

`POST` /certificateAuthorities/{caId}/certificates/query

Search for Certificates Issued by Specific Certificate Authority Matching Search String in Paged Result

`POST` /certificateAuthorities/{caId}/certificates

Create Certificate

`POST` /certificateAuthorities/{caId}/privateKeys

Upload the Certificate Authority Private KEY

`DELETE` /certificateAuthorities/{caId}/privateKeys

Delete the Certificate Authority Private KEY

`POST` /certificateAuthorities/query

Search for Certificate Authorities Matching Search String in Paged Result

`GET` /certificateTemplates/{templateId}

Get Specific Certificate Template

`DELETE` /certificateTemplates/{templateId}

Delete the Certificate Template

`PATCH` /certificateTemplates/{templateId}

Update the Certificate Template

`GET` /certificateTemplates/{templateId}/scepKeys/{scepKeyId}

Get Specific Simple Certificate Enrollment Protocol of Template

`DELETE` /certificateTemplates/{templateId}/scepKeys/{scepKeyId}

Delete the Simple Certificate Enrollment Protocol

`PATCH` /certificateTemplates/{templateId}/scepKeys/{scepKeyId}

Update the Simple Certificate Enrollment Protocol of Template

`GET` /certificateTemplates/{templateId}/notifications/{notificationId}

Get Specific Notification

`DELETE` /certificateTemplates/{templateId}/notifications/{notificationId}

Delete the Notification

`PATCH` /certificateTemplates/{templateId}/notifications/{notificationId}

Update the Notification of Template

`GET` /certificateTemplates/{templateId}/msiPackages/{msiPackageId}

Get Specific Microsoft Software Installer Package

`DELETE` /certificateTemplates/{templateId}/msiPackages/{msiPackageId}

Delete the Microsoft Software Installer Package

`PATCH` /certificateTemplates/{templateId}/msiPackages/{msiPackageId}

Update the Microsoft Software Installer Package of Template

`GET` /certificateTemplates/{templateId}/certificates/{certId}/chains

Download Issued Certificate Chain

`GET` /certificateAuthorities/{caId}/chains

Download the Certificate Chain of Certificate Authority

`GET` /edgeFirewallServices/{firewallId}

Get Firewall

`PUT` /edgeFirewallServices/{firewallId}

Update Firewall

`DELETE` /edgeFirewallServices/{firewallId}

Delete Firewall

`PATCH` /edgeFirewallServices/{firewallId}

Partial Update Firewall

`GET` /edgeDhcpServices/{dhcpId}

Get DHCP

`PUT` /edgeDhcpServices/{dhcpId}

Update DHCP

`DELETE` /edgeDhcpServices/{dhcpId}

Delete DHCP

`PATCH` /edgeDhcpServices/{dhcpId}

Patch DHCP

`GET` /edgeFirewallServices

Get Firewalls

`POST` /edgeFirewallServices

Create Firewall

`DELETE` /edgeFirewallServices

Delete Firewalls

`POST` /edgeDhcpServices

Create DHCP

`DELETE` /edgeDhcpServices

Delete DHCPs

`GET` /edgeDhcpServices/edgeDhcpRelationships/{edgeId}

Get DHCP by Edge ID

`GET` /edgeDhcpServices/dhcps

Get DHCPs

`PUT` /dpskServices/{poolId}/policySets/{policySetId}

Update Policy Set for a DPSK Pool

`DELETE` /dpskServices/{poolId}/policySets/{policySetId}

Remove Policy Set from a DPSK Pool

`POST` /dpskServices/{poolId}/passphrases/query/csvFiles

DPSK Passphrase to CSV

`POST` /dpskServices/{poolId}/passphrases/csvFiles

Import Passphrase from CSV

`GET` /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

Get Link Aggregation Group

`PUT` /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

Update Link Aggregation Group

`DELETE` /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

Delete Link Aggregation Group

`PATCH` /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

Partial Update Link Aggregation Group

`GET` /edgeSdLanServices/{sdLanServiceId}

Get SD-LAN Service

`PUT` /edgeSdLanServices/{sdLanServiceId}

Update SD-LAN Service

`DELETE` /edgeSdLanServices/{sdLanServiceId}

Delete SD-LAN Service

`PATCH` /edgeSdLanServices/{sdLanServiceId}

Partial SD-LAN Service

`PUT` /edgeSdLanServices/{sdLanServiceId}/wifiNetworks/{wifiNetworkId}

Activate Network in SD-LAN

`DELETE` /edgeSdLanServices/{sdLanServiceId}/wifiNetworks/{wifiNetworkId}

Deactivate Network in SD-LAN

`PUT` /edgeSdLanServices/{sdLanServiceId}/guestSettings/venues/{venueId}/edgeClusters/{edgeClusterId}

Activate Guest SmartEdge Cluster

`DELETE` /edgeSdLanServices/{sdLanServiceId}/guestSettings/venues/{venueId}/edgeClusters/{edgeClusterId}

Deactivate Guest SmartEdge Cluster

`PUT` /edgeSdLanServices/{sdLanServiceId}/guestSettings/tunnelProfiles/{tunnelProfileId}

Activate Guest Tunnel

`DELETE` /edgeSdLanServices/{sdLanServiceId}/guestSettings/tunnelProfiles/{tunnelProfileId}

Deactivate Guest Tunnel

`GET` /venues/{venueId}/edgeClusters

Get SmartEdge Clusters

`POST` /venues/{venueId}/edgeClusters

Create SmartEdge Cluster

`POST` /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags

Create Link Aggregation Group

`POST` /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces

Create Sub-Interface

`POST` /venues/{venueId}/edgeClusters/{clusterId}/edges

Add Device

`GET` /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces

Get Sub-Interfaces

`POST` /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces

Create Multiple Sub-Interfaces

`POST` /edgeSdLanServices

Create SD-LAN Service

`GET` /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

Get Sub-Interface

`DELETE` /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

Delete Sub-Interface

`PATCH` /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

Partial Update Sub-Interface

`GET` /venues/{venueId}/edgeClusters/{clusterId}

Get SmartEdge Cluster

`DELETE` /venues/{venueId}/edgeClusters/{clusterId}

Delete a SmartEdge Cluster

`PATCH` /venues/{venueId}/edgeClusters/{clusterId}

Update SmartEdge Cluster

`GET` /venues/{venueId}/edgeClusters/{clusterId}/networkSettings

Get SmartEdge Cluster Network

`PATCH` /venues/{venueId}/edgeClusters/{clusterId}/networkSettings

Update SmartEdge Cluster Network

`GET` /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}

Get Device

`DELETE` /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}

Delete Device

`PATCH` /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}

Update Device

`GET` /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/staticRouteConfigs

Get Static Route Configuration

`PATCH` /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/staticRouteConfigs

Update Static Route Configuration

`DELETE` /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces/{subInterfaceId}

Delete Sub-Interface

`PATCH` /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces/{subInterfaceId}

Update Sub-Interface

`GET` /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/portConfigs

Get Physical Port Configuration

`PATCH` /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/portConfigs

Update Physical Port Configuration

`PATCH` /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/hostDetails

Trigger EDGE Action

`GET` /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/dnsServers

Get DNS Configuration

`PATCH` /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/dnsServers

Update DNS Configuration

`GET` /edgeSdLanServices/{sdLanServiceId}/guestSettings

Get Guest Settings

`PATCH` /edgeSdLanServices/{sdLanServiceId}/guestSettings

Update Guest Settings

`POST` /dpskServices/{poolId}/passphrases/{passphraseId}/devices

Create Devices for a Specific Passphrase

What's Deleted

`POST` /token

Request Authentication

`PATCH` /dpskServices/{poolId}/passphrases/{passphraseId}/devices

Update Devices for Passphrase

What's Deprecated

`GET` /dpskServices

Get DPSK Pools

What's Changed

`GET` /dpskServices/{poolId}/passphrases/{passphraseId}/devices

Get Devices for a Specific Passphrase

Return Type:

Changed response : 200 OK

Get Passphrase Devices

New content type : application/vnd.ruckus.v2+json
New content type : application/vnd.ruckus.v1.1+json
Changed content type : application/json

Changed response : 404 Not Found

DPSK passphrase not found

Deleted content type : application/json

`DELETE` /dpskServices/{poolId}/passphrases/{passphraseId}/devices

Delete Devices Associated with a Specific Passphrase

Parameters:

Changed: passphraseId in path

DPSK passphrase ID

Changed: poolId in path

DPSK pool ID

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Return Type:

Deleted response : 404 Not Found

DPSK passphrase not found

Changed response : 202 Accepted

The request to delete devices associated with the specified passphrase has been accepted.

New content type : application/vnd.ruckus.v2+json
New content type : application/vnd.ruckus.v1.1+json
Changed content type : application/json

`PATCH` /dpskServices/{poolId}/passphrases/{id}

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Added property passphrase (string)

The actual passphrase.
Added property username (string)

Username for the passphrase.
Added property vlanId (integer)

VLAN associated with passphrase.
Added property numberOfDevices (integer)

Number of devices. Must be between 1 and 50. Inputs outside this range will be adjusted.
Added property expirationDate (string)

Expiration date of passphrase.
Added property email (string)

Email associated with passphrase.
Added property phoneNumber (string)

Phone associated with passphrase.
Added property revocationReason (string)

Reason for revocation of passphrase.

Return Type:

New response : 202 Accepted

The passphrase update request is in progress

Deleted response : 200 OK

DPSK passphrase updated

Deleted response : 404 Not Found

DPSK passphrase not found

`GET` /dpskServices/{poolId}/passphrases/{id}

Return Type:

Changed response : 404 Not Found

DPSK passphrase not found

Deleted content type : application/json

Changed response : 200 OK

DPSK passphrase

New content type : application/vnd.ruckus.v2+json
New content type : application/vnd.ruckus.v1.1+json
Changed content type : application/json
- Added property lastModifiedDate (string)
- Added property devices (array)
  
  The devices configured or connected to the passphrase.
  
  Items (object): > The devices configured or connected to the passphrase.
  - Property mac (string)
  - Property lastConnectedNetwork (string)
  - Property lastConnectedNetworkId (string)
  - Property lastConnectedTime (string)
  - Property deviceConnectivity (string)
  - Property devicePassphrase (string)
  - Property lastConnected (string)
  - Property online (boolean)
- Added property isReferenced (boolean)
  
  If this entity is referenced by an identity and cannot be deleted.
- Deleted property mac (string)
  
  Mac address of client.
- Deleted property lastUpdationDate (string)
- Deleted property identityId (string)
  
  Associated identity of passphrase.
- Deleted property requestId (string)
  
  Returned request ID after processing.
- Changed property id (string)
- Changed property numberOfDevices (integer)
  
  Number of devices. Must be between 1 and 50. Inputs outside this range will be adjusted.
- Changed property email (string)
  
  Email associated with passphrase.
- Changed property revocationDate (string)
- Changed property revocationReason (string)
  
  Reason for revocation of passphrase.

`PUT` /dpskServices/{poolId}/passphrases/{id}

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Deleted property mac (string)

Mac address of client.
Deleted property lastUpdationDate (string)
Changed property id (string)
Changed property numberOfDevices (integer)

Number of devices. Must be between 1 and 50. Inputs outside this range will be adjusted.
Changed property email (string)

Email associated with passphrase.
Changed property revocationDate (string)
Changed property revocationReason (string)

Reason for revocation of passphrase.

Return Type:

New response : 202 Accepted

The passphrase update request is in progress

Deleted response : 200 OK

DPSK passphrase updated

Deleted response : 404 Not Found

DPSK passphrase not found

`DELETE` /dpskServices/{poolId}

Delete the DPSK Pool

Return Type:

New response : 202 Accepted

The delete request has been accepted and is in progress.

Deleted response : 200 OK

DPSK pool deleted

`PATCH` /dpskServices/{poolId}

Update the DPSK Pool

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

New required properties:

name
passphraseFormat
passphraseLength

Added property name (string)
Added property passphraseFormat (string)

Passphrase format.

Enum values:
- MOST_SECURED
- KEYBOARD_FRIENDLY
- NUMBERS_ONLY
Added property passphraseLength (integer)

Generated passphrase length.
Added property policyDefaultAccess (boolean)
Added property deviceCountLimit (integer)
Added property expirationType (string)

Expiration date rule.

Enum values:
- SPECIFIED_DATE
- HOURS_AFTER_TIME
- DAYS_AFTER_TIME
- WEEKS_AFTER_TIME
- MONTHS_AFTER_TIME
- YEARS_AFTER_TIME
Added property expirationOffset (integer)

Date of expiration offset.
Added property expirationDate (string)

Expiration date of pool.

Return Type:

New response : 202 Accepted

The update request has been accepted and is in progress.

Deleted response : 200 OK

DPSK pool updated

Deleted response : 404 Not Found

DPSK pool not found

`GET` /dpskServices/{poolId}

Get Specific DPSK Pool

Return Type:

Changed response : 404 Not Found

DPSK pool not found

New content type : application/vnd.ruckus.v2+json
New content type : application/vnd.ruckus.v1.1+json

Changed response : 200 OK

DPSK pool

New content type : application/vnd.ruckus.v2+json
New content type : application/vnd.ruckus.v1.1+json
Changed content type : application/json
- Added property createdDate (string)
- Added property lastModifiedDate (string)
- Added property isReferenced (boolean)
  
  If this entity is referenced by an identity group and cannot be deleted.
- Added property networkCount (integer)
  
  Number of networks associated with this pool.
- Deleted property networkIds (array)
- Deleted property policySetId (string)
- Deleted property identityId (string)
  
  Identifier of linked service.
- Deleted property creationDate (string)
- Deleted property lastUpdationDate (string)
- Deleted property requestId (string)
- Changed property id (string)
  
  Unique identifier for pool.

`PUT` /dpskServices/{poolId}

Update the DPSK Pool

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Deleted property networkIds (array)
Deleted property policySetId (string)
Deleted property identityId (string)

Identifier of linked service.
Deleted property creationDate (string)
Deleted property lastUpdationDate (string)
Deleted property requestId (string)
Changed property id (string)

Unique identifier for pool.

Return Type:

New response : 202 Accepted

The update request has been accepted and is in progress.

Deleted response : 200 OK

DPSK pool updated

Deleted response : 404 Not Found

DPSK pool not found

`POST` /dpskServices/{poolId}/passphrases/query

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Changed property filters (object)
- Deleted property includeExpired (array)

Return Type:

Changed response : 200 OK

Passphrases

New content type : application/vnd.ruckus.v2+json
New content type : application/vnd.ruckus.v1.1+json
Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property lastModifiedDate (string)
  - Added property devices (array)
    
    The devices configured or connected to the passphrase.
  - Added property isReferenced (boolean)
    
    If this entity is referenced by an identity and cannot be deleted.
  - Deleted property organization (string)
  - Deleted property mac (string)
  - Deleted property expiration (string)
  - Deleted property identityId (string)
  - Deleted property networkId (string)
  - Deleted property networkSsid (string)
  - Changed property id (string)
  - Changed property passphrase (string)
    
    The actual passphrase.
  - Changed property username (string)
    
    Username for the passphrase.
  - Changed property vlanId (integer)
    
    VLAN associated with passphrase.
  - Changed property numberOfDevices (integer)
    
    Number of devices. Must be between 1 and 50. Inputs outside this range will be adjusted.
  - Changed property createdDate (string)
    
    Passphrase creation date.
  - Changed property expirationDate (string)
    
    Expiration date of passphrase.
  - Changed property email (string)
    
    Email associated with passphrase.
  - Changed property phoneNumber (string)
    
    Phone associated with passphrase.
  - Changed property revocationDate (string)
  - Changed property revocationReason (string)
    
    Reason for revocation of passphrase.

`DELETE` /dpskServices/{poolId}/passphrases

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Return Type:

New response : 202 Accepted

The passphrase(s) delete request is in progress

Deleted response : 200 OK

The DPSK passphrases were deleted

`POST` /dpskServices/{poolId}/passphrases

Create DPSK Passphrase

Parameters:

Deleted: usernamePrefix in query

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Deleted content type : multipart/form-data

Changed content type : application/json

Added property vxlanId (integer)
Deleted property override (boolean)

Override true replaces value
Deleted property networkId (string)

The WLAN for passphrase.
Changed property passphrase (string)

Actual passphrase.
Changed property numberOfDevices (integer)

Number of devices. Must be between 1 and 50. Inputs outside this range will be adjusted.
Changed property email (string)

The email for passphrase.

Return Type:

New response : 202 Accepted

Create DPSK passphrase(s) accepted

Deleted response : 200 OK

Passphrases

Deleted response : 201 Created

DPSK passphrase(s) created

Changed response : 400 Bad Request

Invalid content supplied

New content type : application/vnd.ruckus.v2+json
New content type : application/vnd.ruckus.v1.1+json

`PATCH` /dpskServices/{poolId}/passphrases

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Changed property changes (object)

Changes to be applied to the passphrases.
- Added property passphrase (string)
  
  The actual passphrase.
- Added property username (string)
  
  Username for the passphrase.
- Added property vlanId (integer)
  
  VLAN associated with passphrase.
- Added property numberOfDevices (integer)
  
  Number of devices. Must be between 1 and 50. Inputs outside this range will be adjusted.
- Added property expirationDate (string)
  
  Expiration date of passphrase.
- Added property email (string)
  
  Email associated with passphrase.
- Added property phoneNumber (string)
  
  Phone associated with passphrase.
- Added property revocationReason (string)
  
  Reason for revocation of passphrase.

Return Type:

New response : 202 Accepted

DPSK passphrases updated

Deleted response : 200 OK

DPSK passphrases updated

Deleted response : 404 Not Found

DPSK passphrases not found

`GET` /dpskServices/{poolId}/passphrases

Parameters:

Deleted: timezone in query

If specified, the timezone will be used for date values. Default value is UTC.

Deleted: date-format in query

Format will be applied for date values. Default value is "dd/MM/yyyy HH:mm"

Return Type:

Deleted response : 400 Bad Request

Invalid timezone or date format supplied

Changed response : 200 OK

Passphrases

New content type : application/vnd.ruckus.v2+json
New content type : application/vnd.ruckus.v1.1+json
Deleted content type : text/csv

`POST` /dpskServices/query

Search for DPSK Pools Matching Search String in Paged Result

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Return Type:

Changed response : 200 OK

DPSK pools

New content type : application/vnd.ruckus.v2+json
New content type : application/vnd.ruckus.v1.1+json
Changed content type : application/json
- Changed property data (array)
  
  DPSK services in page.
  
  Changed items (object):
  - Added property createdDate (string)
  - Added property lastModifiedDate (string)
  - Added property isReferenced (boolean)
    
    If this entity is referenced by an identity group and cannot be deleted.
  - Added property networkCount (integer)
    
    Number of networks associated with this pool.
  - Deleted property networkIds (array)
  - Deleted property policySetId (string)
  - Deleted property identityId (string)
    
    Identifier of linked service.
  - Deleted property creationDate (string)
  - Deleted property lastUpdationDate (string)
  - Deleted property requestId (string)
  - Changed property id (string)
    
    Unique identifier for pool.

`POST` /dpskServices

Create New DPSK Pool

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Deleted property networkIds (array)
Deleted property policySetId (string)
Deleted property identityId (string)

Identifier of linked service.
Deleted property creationDate (string)
Deleted property lastUpdationDate (string)
Deleted property requestId (string)
Changed property id (string)

Unique identifier for pool.

Return Type:

New response : 202 Accepted

DPSK pool created

Deleted response : 201 Created

DPSK pool created

Changed response : 400 Bad Request

Invalid pool content

New content type : application/vnd.ruckus.v2+json
New content type : application/vnd.ruckus.v1.1+json

`GET` /dpskServices

Get DPSK Pools

Return Type:

Changed response : 200 OK

DPSK pools

New content type : application/vnd.ruckus.v2+json
New content type : application/vnd.ruckus.v1.1+json

`GET` /venues/{venueId}/propertyConfigs

Return Type:

Changed response : 200 OK

Ok

Changed content type : application/hal+json

New required properties:
- personaGroupId
- status
- venueName
- Added property venueId (string)
- Added property venueName (string)
  
  Venue name.
- Added property personaGroupId (string)
  
  Persona group identifier.
- Added property residentPortalId (string)
  
  Resident portal identifier.
- Added property status (string)
  
  Status of the property
  
  Enum values:
  - DISABLED
  - ENABLED
- Added property unitConfig (object)
  
  Basic configuration on property units
  - Property type (string)
  - Property residentPortalAllowed (boolean)
    
    Allow resident portal.
  - Property residentApiAllowed (boolean)
    
    Allow resident portal API.
  - Property useMaxUnitCount (boolean)
    
    Restrict unit count.
  - Property maxUnitCount (integer)
    
    Maximum allowed unit count.
  - Property guestAllowed (boolean)
    
    Allow separate guest for the unit.
- Added property communicationConfig (object)
  
  Configuration for communicating unit change events
  - Property type (string)
  - Property sendEmail (boolean)
    
    Enable email communication.
  - Property sendSms (boolean)
    
    Enable SMS communication.
  - Property unitAssignmentHtmlRegId (string)
    
    Unit assignment hyper text template.
  - Property unitAssignmentTextRegId (string)
    
    Unit assignment text template.
  - Property unitPassphraseChangeHtmlRegId (string)
    
    Unit passphrase change hyper text template.
  - Property unitPassphraseChangeTextRegId (string)
    
    Unit passphrase change text template.
  - Property guestPassphraseChangeHtmlRegId (string)
    
    Guest passphrase change hyper text template.
  - Property guestPassphraseChangeTextRegId (string)
    
    Guest passphrase change text template.
  - Property portalAccessResetHtmlRegId (string)
    
    Portal access reset hyper text template.
  - Property portalAccessResetTextRegId (string)
    
    Portal access reset text template.
  - Property portAssignmentHtmlRegId (string)
    
    Port assignment hyper text template.
  - Property portAssignmentTextRegId (string)
    
    Port assignment text template.
- Deleted property guid (string)
  
  Property identifier.
- Deleted property name (string)
  
  Property name.
- Deleted property managementName (string)
  
  Property management name.
- Deleted property managementPhone (string)
  
  Property management phone.
- Deleted property managementEmail (string)
  
  Property management email.
- Deleted property tenantPortalHelpText (string)
  
  Help text defined for the property.
- Deleted property tenantPortalAnnouncements (string)
  
  Announcement defined for the property.
- Deleted property allowSeparateGuestSecret (boolean)
  
  Allow separate secret for guest users.
- Deleted property enforceMaxUnits (boolean)
  
  Restrict number of units.
- Deleted property maxUnits (integer)
  
  Maximum units allowed.
- Deleted property sendEmail (boolean)
  
  Send email notification.
- Deleted property sendSms (boolean)
  
  Send SMS notification.
- Deleted property ssids (array)
  
  List of networks.
- Changed property address (string -> object)
  
  Venue address.
- Changed property description (string)

Changed response : 400 Bad Request

Bad request

Changed content type : application/hal+json

New required properties:
- personaGroupId
- status
- venueName
- Added property venueId (string)
- Added property venueName (string)
  
  Venue name.
- Added property personaGroupId (string)
  
  Persona group identifier.
- Added property residentPortalId (string)
  
  Resident portal identifier.
- Added property status (string)
  
  Status of the property
- Added property unitConfig (object)
  
  Basic configuration on property units
- Added property communicationConfig (object)
  
  Configuration for communicating unit change events
- Deleted property guid (string)
  
  Property identifier.
- Deleted property name (string)
  
  Property name.
- Deleted property managementName (string)
  
  Property management name.
- Deleted property managementPhone (string)
  
  Property management phone.
- Deleted property managementEmail (string)
  
  Property management email.
- Deleted property tenantPortalHelpText (string)
  
  Help text defined for the property.
- Deleted property tenantPortalAnnouncements (string)
  
  Announcement defined for the property.
- Deleted property allowSeparateGuestSecret (boolean)
  
  Allow separate secret for guest users.
- Deleted property enforceMaxUnits (boolean)
  
  Restrict number of units.
- Deleted property maxUnits (integer)
  
  Maximum units allowed.
- Deleted property sendEmail (boolean)
  
  Send email notification.
- Deleted property sendSms (boolean)
  
  Send SMS notification.
- Deleted property ssids (array)
  
  List of networks.
- Changed property address (string -> object)
  
  Venue address.
- Changed property description (string)

Changed response : 404 Not Found

Not found

Changed content type : application/hal+json

New required properties:
- personaGroupId
- status
- venueName
- Added property venueId (string)
- Added property venueName (string)
  
  Venue name.
- Added property personaGroupId (string)
  
  Persona group identifier.
- Added property residentPortalId (string)
  
  Resident portal identifier.
- Added property status (string)
  
  Status of the property
- Added property unitConfig (object)
  
  Basic configuration on property units
- Added property communicationConfig (object)
  
  Configuration for communicating unit change events
- Deleted property guid (string)
  
  Property identifier.
- Deleted property name (string)
  
  Property name.
- Deleted property managementName (string)
  
  Property management name.
- Deleted property managementPhone (string)
  
  Property management phone.
- Deleted property managementEmail (string)
  
  Property management email.
- Deleted property tenantPortalHelpText (string)
  
  Help text defined for the property.
- Deleted property tenantPortalAnnouncements (string)
  
  Announcement defined for the property.
- Deleted property allowSeparateGuestSecret (boolean)
  
  Allow separate secret for guest users.
- Deleted property enforceMaxUnits (boolean)
  
  Restrict number of units.
- Deleted property maxUnits (integer)
  
  Maximum units allowed.
- Deleted property sendEmail (boolean)
  
  Send email notification.
- Deleted property sendSms (boolean)
  
  Send SMS notification.
- Deleted property ssids (array)
  
  List of networks.
- Changed property address (string -> object)
  
  Venue address.
- Changed property description (string)

Changed response : 500 Internal Server Error

Internal server error

Changed content type : application/hal+json

New required properties:
- personaGroupId
- status
- venueName
- Added property venueId (string)
- Added property venueName (string)
  
  Venue name.
- Added property personaGroupId (string)
  
  Persona group identifier.
- Added property residentPortalId (string)
  
  Resident portal identifier.
- Added property status (string)
  
  Status of the property
- Added property unitConfig (object)
  
  Basic configuration on property units
- Added property communicationConfig (object)
  
  Configuration for communicating unit change events
- Deleted property guid (string)
  
  Property identifier.
- Deleted property name (string)
  
  Property name.
- Deleted property managementName (string)
  
  Property management name.
- Deleted property managementPhone (string)
  
  Property management phone.
- Deleted property managementEmail (string)
  
  Property management email.
- Deleted property tenantPortalHelpText (string)
  
  Help text defined for the property.
- Deleted property tenantPortalAnnouncements (string)
  
  Announcement defined for the property.
- Deleted property allowSeparateGuestSecret (boolean)
  
  Allow separate secret for guest users.
- Deleted property enforceMaxUnits (boolean)
  
  Restrict number of units.
- Deleted property maxUnits (integer)
  
  Maximum units allowed.
- Deleted property sendEmail (boolean)
  
  Send email notification.
- Deleted property sendSms (boolean)
  
  Send SMS notification.
- Deleted property ssids (array)
  
  List of networks.
- Changed property address (string -> object)
  
  Venue address.
- Changed property description (string)

`POST` /venues/propertyConfigs/query

Return Type:

Changed response : 400 Bad Request

Invalid query data supplied.

Changed content type : application/hal+json
- Changed property content (array)
  
  Changed items (object):
  
  New required properties:
  - personaGroupId
  - status
  - venueName
  - Added property venueId (string)
  - Added property venueName (string)
    
    Venue name.
  - Added property personaGroupId (string)
    
    Persona group identifier.
  - Added property residentPortalId (string)
    
    Resident portal identifier.
  - Added property status (string)
    
    Status of the property
  - Added property unitConfig (object)
    
    Basic configuration on property units
  - Added property communicationConfig (object)
    
    Configuration for communicating unit change events
  - Deleted property guid (string)
    
    Property identifier.
  - Deleted property name (string)
    
    Property name.
  - Deleted property managementName (string)
    
    Property management name.
  - Deleted property managementPhone (string)
    
    Property management phone.
  - Deleted property managementEmail (string)
    
    Property management email.
  - Deleted property tenantPortalHelpText (string)
    
    Help text defined for the property.
  - Deleted property tenantPortalAnnouncements (string)
    
    Announcement defined for the property.
  - Deleted property allowSeparateGuestSecret (boolean)
    
    Allow separate secret for guest users.
  - Deleted property enforceMaxUnits (boolean)
    
    Restrict number of units.
  - Deleted property maxUnits (integer)
    
    Maximum units allowed.
  - Deleted property sendEmail (boolean)
    
    Send email notification.
  - Deleted property sendSms (boolean)
    
    Send SMS notification.
  - Deleted property ssids (array)
    
    List of networks.
  - Changed property address (string -> object)
    
    Venue address.
  - Changed property description (string)

`GET` /venues/propertyConfigs

Return Type:

Changed response : 400 Bad Request

Invalid input supplied.

Changed content type : */*
- Changed property content (array)
  
  Changed items (object):
  
  New required properties:
  - personaGroupId
  - status
  - venueName
  - Added property venueId (string)
  - Added property venueName (string)
    
    Venue name.
  - Added property personaGroupId (string)
    
    Persona group identifier.
  - Added property residentPortalId (string)
    
    Resident portal identifier.
  - Added property status (string)
    
    Status of the property
  - Added property unitConfig (object)
    
    Basic configuration on property units
  - Added property communicationConfig (object)
    
    Configuration for communicating unit change events
  - Deleted property guid (string)
    
    Property identifier.
  - Deleted property name (string)
    
    Property name.
  - Deleted property managementName (string)
    
    Property management name.
  - Deleted property managementPhone (string)
    
    Property management phone.
  - Deleted property managementEmail (string)
    
    Property management email.
  - Deleted property tenantPortalHelpText (string)
    
    Help text defined for the property.
  - Deleted property tenantPortalAnnouncements (string)
    
    Announcement defined for the property.
  - Deleted property allowSeparateGuestSecret (boolean)
    
    Allow separate secret for guest users.
  - Deleted property enforceMaxUnits (boolean)
    
    Restrict number of units.
  - Deleted property maxUnits (integer)
    
    Maximum units allowed.
  - Deleted property sendEmail (boolean)
    
    Send email notification.
  - Deleted property sendSms (boolean)
    
    Send SMS notification.
  - Deleted property ssids (array)
    
    List of networks.
  - Changed property address (string -> object)
    
    Venue address.
  - Changed property description (string)

2024-05-28

What's Changed

`GET` /tenants/authentications

Return Type:

Changed response : 200 OK

OK

Changed content type : application/vnd.ruckus.v1+json

Changed items (object):
- Added property samlSignatureEnabled (boolean)
Changed content type : application/json

Changed items (object):
- Added property samlSignatureEnabled (boolean)

`POST` /tenants/authentications

Request:

Changed content type : application/vnd.ruckus.v1+json

Added property samlSignatureEnabled (boolean)

Changed content type : application/json

Added property samlSignatureEnabled (boolean)

Return Type:

Changed response : 200 OK

OK

Changed content type : application/vnd.ruckus.v1+json
- Added property samlSignatureEnabled (boolean)
Changed content type : application/json
- Added property samlSignatureEnabled (boolean)

`POST` /tenants/mobilePushNotifications

Add Mobile Push Notification

`GET` /tenants/userProfiles

Return Type:

Changed response : 200 OK

OK

Changed content type : application/vnd.ruckus.v1+json
- Added property customRoleType (string)
Changed content type : application/json
- Added property customRoleType (string)

`PUT` /tenants/userProfiles

Request:

Changed content type : application/vnd.ruckus.v1+json

Added property customRoleType (string)

Changed content type : application/json

Added property customRoleType (string)

Return Type:

Changed response : 200 OK

Accepted

Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Added property customRoleType (string)
Changed content type : application/json
- Changed property response (object)
  - Added property customRoleType (string)

Changed response : 500 Internal Server Error

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Added property customRoleType (string)
Changed content type : application/json
- Changed property response (object)
  - Added property customRoleType (string)

`GET` /tenants/self

Return Type:

Changed response : 200 OK

OK

Changed content type : application/vnd.ruckus.v1+json

Added property inMaintenance (boolean)
Changed property authentications (array)

Changed items (object):
- Added property samlSignatureEnabled (boolean)

Changed property admins (array)

Changed items (object):

Added property specialRoles (array)

Items (object):

Property id (string)
Property createdDate (string)
Property updatedDate (string)
Property roleName (string)

Property admin (object)

Property id (string)
Property createdDate (string)
Property updatedDate (string)
Property detailLevel (string)

Enum values:
- ba
- it
- su
- debug
Property externalId (string)

Property adminRoles (array)

Items (object):

Property id (string)
Property createdDate (string)
Property updatedDate (string)

Property role (string)

Enum Meaning
PRIME_ADMIN Role with the highest level of administrator privilege; all actions are permitted.
ADMIN Role permitting administrator to perform any action except personnel assignments (i.e., manage other administrators); for MSP's, this role is not permitted to manage (e.g., create or delete) MSP-ECs.
READ_ONLY Role permitting administrator to observe network configuration and operational data, but not the capability to change any configuration. Role can be appropriate for personnel training.
OFFICE_ADMIN Role permitting administrator the capability to manage guest Wi-Fi users.

Property delegated (string)
Property delegatedRoleType (string)

Enum values:
- RKS_EC
- MSP_EC

Property privilegeGroup (object)

Property id (string)
Property createdDate (string)
Property updatedDate (string)
Property name (string)
Property description (string)

Property roleObjectPermissions (array)

Items (object):

Property id (string)
Property createdDate (string)
Property updatedDate (string)
Property entityInstanceId (string)

Property customRole (object)

Property id (string)
Property createdDate (string)
Property updatedDate (string)
Property name (string)
Property description (string)
Property roleType (string)
Property policyBased (boolean)
Property frameworkRO (boolean)

Property tenant (object)

Property id (string)
Property createdDate (string)
Property updatedDate (string)
Property entitlementId (string)
Property externalModifiedDate (string)
Property maintenanceState (boolean)
Property maintenanceDate (string)
Property name (string)
Property externalId (string)
Property admins (array)

Items (object):

Property notificationRecipients (array)

Items (object):

Property id (string)
Property createdDate (string)
Property updatedDate (string)
Property description (string)

Property endpoints (array)

Items (object):

One of:

  * Property `id` (string)

  * Property `createdDate` (string)

  * Property `updatedDate` (string)

  * Property `destination` (string)
      > The email address to which notifications are sent.


  * Property `active` (boolean)

  * Property `status` (string)
      > This parameter is set to bounced when emails are not deliverable to the destination.


      Enum values:

      * `OK`
      * `BOUNCED`
  * Property `type` (string)

  * Property `parentId` (string)

  * Property `id` (string)

  * Property `createdDate` (string)

  * Property `updatedDate` (string)

  * Property `destination` (string)
      > The email address to which notifications are sent.


  * Property `active` (boolean)

  * Property `status` (string)
      > This parameter is set to bounced when emails are not deliverable to the destination.


  * Property `type` (string)

  * Property `parentId` (string)

  * Property `platform` (string)

  * Property `deviceToken` (string)

  * Property `deviceId` (string)
      > The email address to which notifications are sent.

Property parentId (string)

Property authentications (array)

Items (object):
- Property id (string)
- Property createdDate (string)
- Property updatedDate (string)
- Property clientID (string)
- Property clientSecret (string)
- Property scopes (string)
- Property tokenURL (string)
- Property authorizationURL (string)
- Property authenticationType (string)
  
  Enum values:
  - IDM
  - SAML
  - OATH2_OIDC
  - OAUTH2_CLIENT_CREDENTIALS
  - LDAP
  - GOOGLE_WORKSPACE
- Property samlFileURL (string)
- Property name (string)
- Property samlFileType (string)
  
  Enum values:
  - DIRECT_URL
  - FILE
- Property authDomains (array)
  
  Items (object):
  - Property id (string)
  - Property createdDate (string)
  - Property updatedDate (string)
  - Property domain (string)
  - Property authentication (object)
  - Property parentId (string)
- Property authScopes (array)
  
  Items (object):
  - Property id (string)
  - Property createdDate (string)
  - Property updatedDate (string)
  - Property authentication (object)
  - Property privilegeGroup (object)
  - Property parentId (string)
- Property clientIDStatus (string)
  
  Enum values:
  - ACTIVE
  - REVOKED
- Property accountBased (boolean)
- Property samlSignatureEnabled (boolean)
- Property parentId (string)
Property almActivated (boolean)
Property almActivationDate (string)
Property almSysAccountId (string)
Property almMigrationFlag (boolean)
Property almMigrationDate (string)
Property accountTier (string)
Property accountVertical (string)
Property obsolete (boolean)

Tenant is no longer used or active.
Property oemName (string)
Property upgradeGroup (string)
Property msp (object)
- Property mspLabel (string)
- Property mspFQDN (string)
- Property logoUUID (string)
- Property alarmNotificationLogoUUID (string)
- Property pingNotificationLogoUUID (string)
- Property mlisaLogoUUID (string)
- Property pingLoginLogoUUID (string)
- Property defaultLogoUUID (string)
- Property contactSupportUrl (string)
- Property contractSupportBehavior (string)
- Property openCaseUrl (string)
- Property openCaseBehavior (string)
- Property myOpenCaseUrl (string)
- Property myOpenCaseBehavior (string)
- Property changePasswordUrl (string)
- Property phone (string)
- Property email (string)
- Property website (string)
- Property isDisableNotification (boolean)
Property MspEcServiceDates (object)

MspEcServiceDates
- Property parentMspId (string)
- Property serviceExpirationDate (string)
- Property serviceEffectiveDate (string)
Property tenantMFA (object)
- Property mfaStatus (string)
  
  Flag indicating whether multi-factor authentication (MFA) is active.
- Property recoveryCodes (string)
Property serviceAccount (boolean)
Property mspPingOrgId (string)
Property aggregateNotifications (boolean)
Property excludeecforAggregation (boolean)
Property pingMigrated (boolean)
Property inMaintenance (boolean)
Property account (object)
- Property id (string)
- Property createdDate (string)
- Property updatedDate (string)
- Property streetAddress (string)
- Property state (string)
- Property country (string)
- Property postalCode (string)
- Property phoneNumber (string)
- Property faxNumber (string)
- Property city (string)
- Property type (string)
- Property mappingURL (string)
- Property parentId (string)
Property preferences (string)
Property isActivated (boolean)
Property ruckusUser (boolean)

Property delegationsTo (array)

Items (object):

Property id (string)
Property createdDate (string)
Property updatedDate (string)
Property delegatedTo (string)

Property type (string)

Enum Meaning
VAR Return delegations to this VAR.
SUPPORT Return delegations to RUCKUS customer support.
MSP Return the MSP's MSP-ECs.
SUPPORT_EC Return MSP-EC delegations to RUCKUS customer support.
MSP_INSTALLER Return the MSP's installers.
MSP_INTEGRATOR Return the MSP's integrators.
UNKNOWN Unknown.

Enum values:

VAR
SUPPORT
MSP
SUPPORT_EC
MSP_INSTALLER
MSP_INTEGRATOR
UNKNOWN

Property status (string)

Enum values:
- INVITED
- ACCEPTED
- REJECTED
- REVOKED
Property delegatedBy (string)
Property expiryDate (string)
Property delegatedToName (string)
Property delegatedToAdmin (string)
Property parentId (string)
Property isValid (boolean)

Property parentId (string)

Property status (string)

Enum Meaning
active The account is active.
suspended The account has been administratively suspended for an indefinite period of time; while in this state, logins are disabled.
maintenance The account is temporarily undergoing maintenance; while in this state, logins are disabled.
deleted The account has been deleted; although a record of the account exists, all other network management configuration and data has been deleted.

Enum values:

active
suspended
deleted
maintenance

Property tenantType (string)

Enum Meaning
REC RUCKUS end customer.
VAR Value-added reseller.
MSP Managed service provider.
MSP_EC MSP's end customer.
MSP_NON_VAR This value is reserved for RUCKUS purposes.
MSP_INSTALLER Installer organization which administratively reports to an MSP.
MSP_INTEGRATOR Installer organization which administratively reports to an MSP.
UNKNOWN Unknown.

Enum values:

REC
MSP
MSP_EC
VAR
MSP_NON_VAR
UNKNOWN
MSP_INSTALLER
MSP_INTEGRATOR
MSP_REC

Property scopes (array)

Items (object):
- Property id (string)
- Property createdDate (string)
- Property updatedDate (string)
- Property features (array)
  
  Items (object):
  - Property id (string)
  - Property createdDate (string)
  - Property updatedDate (string)
  - Property name (string)
  - Property description (string)
  - Property category (string)
  - Property scopes (array)
  - Property parentId (string)
- Property customRoles (array)
  
  Items (object):
- Property name (string)
- Property parentId (string)
Property preDefinedRole (string)
Property roleObjectPermissions (array)
Property parentId (string)

Property objectType (string)
Property privilegeGroup (object)
Property tenant (object)
Property roleEntity (object)
- Property id (string)
- Property createdDate (string)
- Property updatedDate (string)
- Property serviceName (string)
- Property objectType (string)
- Property roleObjectPermissions (array)
- Property parentId (string)
Property read (boolean)
Property update (boolean)
Property add (boolean)
Property delete (boolean)
Property apply (boolean)
Property conditions (string)
Property parentId (string)

Property delegatedBy (string)
Property readOnly (boolean)
Property tenant (object)
Property type (string)
Property memberCount (integer)
Property delegationDetails (string)
Property hasDelegations (boolean)
Property customRole (object)
Property parentPrivilegeGroupId (string)
Property mspCustomers (integer)
Property parentId (string)

Property parentId (string)

Property adminAppSettings (array)

Items (object):
- Property id (string)
- Property createdDate (string)
- Property updatedDate (string)
- Property appType (string)
  
  Enum values:
  - UI
  - MA
- Property productType (string)
  
  Enum values:
  - WIFI
  - SWITCH
  - LTE
  - COMMON
- Property value (string)
- Property parentId (string)
Property dateFormat (string)

Enum values:
- mm/dd/yyyy
- dd/mm/yyyy
- yyyy/mm/dd
Property username (string)
Property authentication (object)
Property firstName (string)
Property lastName (string)
Property specialRoles (array)
Property parentId (string)

Property parentId (string)

Changed content type : application/json
- Added property inMaintenance (boolean)
- Changed property authentications (array)
  
  Changed items (object):
  - Added property samlSignatureEnabled (boolean)
- Changed property admins (array)
  
  Changed items (object):
  - Added property specialRoles (array)

`PUT` /admins

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Added property specialRoles (array)
  - Changed property authentication (object)
    - Added property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Added property inMaintenance (boolean)
Changed content type : application/json
- Changed property response (object)
  - Added property specialRoles (array)
  - Changed property authentication (object)
    - Added property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Added property inMaintenance (boolean)

Changed response : 500 Internal Server Error

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Added property specialRoles (array)
  - Changed property authentication (object)
    - Added property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Added property inMaintenance (boolean)
Changed content type : application/json
- Changed property response (object)
  - Added property specialRoles (array)
  - Changed property authentication (object)
    - Added property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Added property inMaintenance (boolean)

`POST` /admins

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Added property specialRoles (array)
  - Changed property authentication (object)
    - Added property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Added property inMaintenance (boolean)
Changed content type : application/json
- Changed property response (object)
  - Added property specialRoles (array)
  - Changed property authentication (object)
    - Added property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Added property inMaintenance (boolean)

Changed response : 400 Bad Request

Bad/Malformed Request [TNT-10300: "Admin already invited to different account", TNT-10302: "Admin already registered to Ruckus Support", TNT-10303: "Admin already exists"]

Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Added property specialRoles (array)
  - Changed property authentication (object)
    - Added property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Added property inMaintenance (boolean)
Changed content type : application/json
- Changed property response (object)
  - Added property specialRoles (array)
  - Changed property authentication (object)
    - Added property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Added property inMaintenance (boolean)

Changed response : 500 Internal Server Error

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Added property specialRoles (array)
  - Changed property authentication (object)
    - Added property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Added property inMaintenance (boolean)
Changed content type : application/json
- Changed property response (object)
  - Added property specialRoles (array)
  - Changed property authentication (object)
    - Added property samlSignatureEnabled (boolean)
  - Changed property adminRoles (array)
    
    Changed items (object):
    - Changed property privilegeGroup (object)
      - Changed property tenant (object)
        
        Added property inMaintenance (boolean)

2024-05-22

What's Changed

`POST` /historicalClients/query

Request:

New content type : application/vnd.ruckus.v1+json

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 404 Not Found

tenant_id not found

Changed response : 501 Not Implemented

not implemented

Deleted content type : application/json

Changed response : 200 OK

successful operation

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Added property data (array)
  
  Event information.
  
  Items (object): > Event information.
- Added property fields (array)
  
  Relevant fields
  
  Items (string): > Relevant fields
- Added property totalCount (integer)
  
  Total count.
- Added property subsequentQueries (array)
  
  Subsequent queries.
  
  Items (object): > Subsequent queries.
- Added property message (string)
  
  Error message.

`POST` /events/query

Request:

New content type : application/vnd.ruckus.v1+json

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 404 Not Found

tenant_id not found

Changed response : 501 Not Implemented

not implemented

Deleted content type : application/json

Changed response : 200 OK

successful operation

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Added property data (array)
  
  Event information.
- Added property fields (array)
  
  Relevant fields
- Added property totalCount (integer)
  
  Total count.
- Added property subsequentQueries (array)
  
  Subsequent queries.
- Added property message (string)
  
  Error message.

`POST` /events/metas/query

Request:

New content type : application/vnd.ruckus.v1+json

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 404 Not Found

tenant_id not found

Changed response : 501 Not Implemented

not implemented

Deleted content type : application/json

Changed response : 200 OK

successful operation

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Added property data (array)
  
  Event information.
- Added property fields (array)
  
  Relevant fields
- Added property totalCount (integer)
  
  Total count.
- Added property subsequentQueries (array)
  
  Subsequent queries.
- Added property message (string)
  
  Error message.

`POST` /alarms/query

Request:

New content type : application/vnd.ruckus.v1+json

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 404 Not Found

tenant_id not found

Changed response : 501 Not Implemented

not implemented

Deleted content type : application/json

Changed response : 200 OK

successful operation

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Added property data (array)
  
  Alarm information.
  
  Items (object): > Alarm information.
- Added property fields (array)
  
  Relevant fields
- Added property totalCount (integer)
  
  Total count.
- Added property subsequentQueries (array)
  
  Subsequent queries.
- Added property message (string)
  
  Error message.
- Added property status (string)
  
  Status
- Added property mspEcAlarmCountList (array)
  
  MSP EC alarm count
  
  Items (object): > MSP EC alarm count
  - Property tenantId (string)
  - Property alarmCount (integer)

`POST` /alarms/metas/query

Request:

New content type : application/vnd.ruckus.v1+json

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 404 Not Found

tenant_id not found

Changed response : 400 Bad Request

Invalid payload supplied

Deleted content type : application/json

Changed response : 501 Not Implemented

not implemented

Deleted content type : application/json

Changed response : 200 OK

successful operation

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Added property data (array)
  
  Alarm information.
- Added property fields (array)
  
  Relevant fields
- Added property totalCount (integer)
  
  Total count.
- Added property subsequentQueries (array)
  
  Subsequent queries.
- Added property message (string)
  
  Error message.
- Added property status (string)
  
  Status
- Added property mspEcAlarmCountList (array)
  
  MSP EC alarm count

`PATCH` /alarms/{alarmId}

Request:

New content type : application/vnd.ruckus.v1+json

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 404 Not Found

tenant_id not found

Changed response : 501 Not Implemented

not implemented

Deleted content type : application/json

Changed response : 200 OK

successful operation

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Added property data (array)
  
  Alarm information.
- Added property fields (array)
  
  Relevant fields
- Added property totalCount (integer)
  
  Total count.
- Added property subsequentQueries (array)
  
  Subsequent queries.
- Added property message (string)
  
  Error message.
- Added property status (string)
  
  Status
- Added property mspEcAlarmCountList (array)
  
  MSP EC alarm count

`DELETE` /venues/{venueId}/alarms

Request:

New content type : application/vnd.ruckus.v1+json

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 404 Not Found

tenant_id not found

Changed response : 501 Not Implemented

not implemented

Deleted content type : application/json

Changed response : 200 OK

successful operation

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Added property data (array)
  
  Alarm information.
- Added property fields (array)
  
  Relevant fields
- Added property totalCount (integer)
  
  Total count.
- Added property subsequentQueries (array)
  
  Subsequent queries.
- Added property message (string)
  
  Error message.
- Added property status (string)
  
  Status
- Added property mspEcAlarmCountList (array)
  
  MSP EC alarm count

`DELETE` /switches/{switchSerial}/alarms

Request:

New content type : application/vnd.ruckus.v1+json

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 404 Not Found

tenant_id not found

Changed response : 501 Not Implemented

not implemented

Deleted content type : application/json

Changed response : 200 OK

successful operation

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Added property data (array)
  
  Alarm information.
- Added property fields (array)
  
  Relevant fields
- Added property totalCount (integer)
  
  Total count.
- Added property subsequentQueries (array)
  
  Subsequent queries.
- Added property message (string)
  
  Error message.
- Added property status (string)
  
  Status
- Added property mspEcAlarmCountList (array)
  
  MSP EC alarm count

`DELETE` /aps/{apSerial}/alarms

Request:

New content type : application/vnd.ruckus.v1+json

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 404 Not Found

tenant_id not found

Changed response : 501 Not Implemented

not implemented

Deleted content type : application/json

Changed response : 200 OK

successful operation

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Added property data (array)
  
  Alarm information.
- Added property fields (array)
  
  Relevant fields
- Added property totalCount (integer)
  
  Total count.
- Added property subsequentQueries (array)
  
  Subsequent queries.
- Added property message (string)
  
  Error message.
- Added property status (string)
  
  Status
- Added property mspEcAlarmCountList (array)
  
  MSP EC alarm count

`DELETE` /alarms

Request:

New content type : application/vnd.ruckus.v1+json

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Deleted response : 404 Not Found

tenant_id not found

Changed response : 501 Not Implemented

not implemented

Deleted content type : application/json

Changed response : 200 OK

successful operation

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Added property data (array)
  
  Alarm information.
- Added property fields (array)
  
  Relevant fields
- Added property totalCount (integer)
  
  Total count.
- Added property subsequentQueries (array)
  
  Subsequent queries.
- Added property message (string)
  
  Error message.
- Added property status (string)
  
  Status
- Added property mspEcAlarmCountList (array)
  
  MSP EC alarm count

`POST` /events/csvFiles

Request:

New content type : application/vnd.ruckus.v1+json

Return Type:

Deleted response : 404 Not Found

tenant_id not found

Changed response : 400 Bad Request

Invalid payload supplied

Changed content type : application/json

Changed response : 501 Not Implemented

not implemented

Deleted content type : application/json

Changed response : 200 OK

successful operation

New content type : application/vnd.ruckus.v1+json

`GET` /events/adminGroups/{adminGroupId}/latestLogins

Return Type:

New response : 500 Internal Server Error

Internal Server Error

Changed response : 400 Bad Request

Invalid payload supplied

Changed content type : application/json
Changed content type : application/vnd.ruckus.v1+json

Changed response : 501 Not Implemented

not implemented

Deleted content type : application/json
Deleted content type : application/vnd.ruckus.v1+json

2024-05-21

What's New

`POST` /mspCustomers/firmwareUpgradeSchedules

Firmware Upgrade Schedules

`PATCH` /mspCustomers/delegations

Update Integrator/Installer

What's Deprecated

`GET` /mspCustomers/{customerId}/activationStatus

Get Activation Status

What's Changed

`GET` /mspCustomers/{customerId}/mspadmins

`PUT` /mspCustomers/{customerId}/mspadmins

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/json

New required properties:
- requestId
- Added property tenantId (string)

`GET` /mspCustomers/{customerId}/admins/{adminId}

`PUT` /mspCustomers/{customerId}/admins/{adminId}

`DELETE` /mspCustomers/{customerId}/admins/{adminId}

`POST` /mspCustomers/{customerId}/invitations

`GET` /mspCustomers/{customerId}/delegations

`POST` /mspCustomers/{customerId}/delegations

`DELETE` /mspCustomers/{customerId}/delegations

`GET` /mspIntegrators/{integratorId}

`PATCH` /mspIntegrators/{integratorId}

Request:

Changed content type : application/json

Added property isManageAllEcs (boolean)

`GET` /mspLabels/{mspLabel}

`GET` /mspLabels/baseUrls

`GET` /mspCustomers/{customerId}/logoUrls

`GET` /mspCustomers/{customerId}/admins

`GET` /mspCustomers/{customerId}/activationStatus

`PUT` /mspCustomers/{customerId}/delegatorAdmins

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/json

New required properties:
- requestId
- Added property tenantId (string)

`GET` /mspCustomers/{customerId}

Return Type:

Changed response : 200 OK

Ok

Changed content type : application/json
- Added property tier (string)

`DELETE` /mspCustomers/{customerId}

Return Type:

Changed response : 202 Accepted

Ok

Changed content type : application/json

New required properties:
- requestId
- Added property tenantId (string)

`PATCH` /mspCustomers/{customerId}

Partial Update of the MSP-EC

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

Changed content type : application/json

New required properties:

operation

Added property operation (string)

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v2+json
Changed content type : application/json

Changed response : 400 Bad Request

Bad Request

New content type : application/vnd.ruckus.v2+json
Changed content type : application/json

Changed response : 500 Internal Server Error

Server Error

New content type : application/vnd.ruckus.v2+json
Changed content type : application/json

`PUT` /mspCustomers/{customerId}

Request:

Changed content type : application/json

Added property tier (string)

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/json

New required properties:
- requestId
- Added property tenantId (string)

`GET` /mspCustomers

Return Type:

Changed response : 200 OK

Ok

Changed content type : application/json

Changed items (object):
- Added property tier (string)

`POST` /mspCustomers

Request:

New content type : application/vnd.ruckus.v3+json

Changed content type : application/json

New optional properties:

name
service_effective_date
service_expiration_date
tenant_type

Added property account_id (string)
Added property tier (string)
Changed property name (string)

Changed content type : application/vnd.ruckus.v2+json

Changed property name (string)

Changed content type : application/vnd.ruckus.v1+json

Changed property name (string)

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v3+json

Changed response : 400 Bad Request

Bad Request

New content type : application/vnd.ruckus.v3+json

Changed response : 500 Internal Server Error

Server Error

New content type : application/vnd.ruckus.v3+json

`PATCH` /mspCustomers/mspAdmins/associations

Request:

Changed content type : application/json

Changed property associations (array)

Changed items (object):

New required properties:
- mspAdminRoles

`GET` /mspLabels

`PUT` /mspLabels

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/json

New required properties:
- requestId
- Added property tenantId (string)

`POST` /mspLabels

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/json

New required properties:
- requestId
- Added property tenantId (string)

2024-05-15

What's New

`POST` /venues/switches/switchPorts/query

Query SwitchPorts

`POST` /venues/switches/query

Get switch list of venue.

`POST` /venues/switches/query/csvFiles

Export Switch Inventory

`POST` /venues/switches/clients/query

Get Switch Clients

`POST` /venues/switches/aggregationDetails

Get Switches Aggregation Details

`POST` /venues/query

Get Venues

What's Changed

`POST` /switches/ports/query

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property vsixIngressAclName (string)
    
    The V6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an V6 ACL.
  - Added property vsixEgressAclName (string)
    
    The V6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an V6 ACL.
  - Added property spanningTreeStatus (string)
  - Added property neighborPortMacAddress (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property vsixIngressAclName (string)
    
    The V6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an V6 ACL.
  - Added property vsixEgressAclName (string)
    
    The V6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an V6 ACL.
  - Added property spanningTreeStatus (string)
  - Added property neighborPortMacAddress (string)

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property vsixIngressAclName (string)
    
    The V6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an V6 ACL.
  - Added property vsixEgressAclName (string)
    
    The V6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an V6 ACL.
  - Added property spanningTreeStatus (string)
  - Added property neighborPortMacAddress (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property vsixIngressAclName (string)
    
    The V6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an V6 ACL.
  - Added property vsixEgressAclName (string)
    
    The V6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an V6 ACL.
  - Added property spanningTreeStatus (string)
  - Added property neighborPortMacAddress (string)

`POST` /enhancedRogueApPolicyProfiles/query

`POST` /delegations

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property entitlements (array)
  
  Changed items (object):
  - Added property rwgDeviceCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property entitlements (array)
  
  Changed items (object):
  - Added property rwgDeviceCount (string)

Changed response : 501 Not Implemented

not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property rwgDeviceCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property rwgDeviceCount (string)

`POST` /techpartners/mspecs/query

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property rwgLicenses (integer)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property rwgDeviceCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property rwgLicenses (integer)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property rwgDeviceCount (string)

Changed response : 501 Not Implemented

not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property rwgLicenses (integer)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property rwgDeviceCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property rwgLicenses (integer)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property rwgDeviceCount (string)

`POST` /snmpAgents/query

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property v2Agents (object)

`POST` /mspecs/query

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property rwgLicenses (integer)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property rwgDeviceCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property rwgLicenses (integer)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property rwgDeviceCount (string)

Changed response : 501 Not Implemented

not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Added property rwgLicenses (integer)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property rwgDeviceCount (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Added property rwgLicenses (integer)
  - Changed property entitlements (array)
    
    Changed items (object):
    - Added property rwgDeviceCount (string)

`POST` /enhancedDhcpConfigServiceProfiles/query

`POST` /switches/aggregationDetails

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property vsixIngressAclName (string)
        
        The V6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an V6 ACL.
      - Added property vsixEgressAclName (string)
        
        The V6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an V6 ACL.
      - Added property spanningTreeStatus (string)
      - Added property neighborPortMacAddress (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property vsixIngressAclName (string)
        
        The V6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an V6 ACL.
      - Added property vsixEgressAclName (string)
        
        The V6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an V6 ACL.
      - Added property spanningTreeStatus (string)
      - Added property neighborPortMacAddress (string)

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property vsixIngressAclName (string)
        
        The V6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an V6 ACL.
      - Added property vsixEgressAclName (string)
        
        The V6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an V6 ACL.
      - Added property spanningTreeStatus (string)
      - Added property neighborPortMacAddress (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property switches (array)
    
    Changed items (object):
    - Changed property portStatuses (array)
      
      Changed items (object):
      - Added property vsixIngressAclName (string)
        
        The V6 ACL name for the ingress network interface. Note: this string parameter is non-empty only when the port is associated with an V6 ACL.
      - Added property vsixEgressAclName (string)
        
        The V6 ACL name for the egress network interface. Note: this string parameter is non-empty only when the port is associated with an V6 ACL.
      - Added property spanningTreeStatus (string)
      - Added property neighborPortMacAddress (string)

`POST` /aps/aggregationDetails

Return Type:

Changed response : 200 OK

successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property networks (object)

`GET` /venues/{venueId}/topologies

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property edges (array)
    
    Changed items (object):
    - Added property extraEdges (array)
      
      Items (object):
      - Property poeEnabled (boolean)
      - Property linkSpeed (string)
      - Property poeUsed (integer)
      - Property poeTotal (integer)
      - Property connectedPort (string)
      - Property correspondingPort (string)
      - Property connectionType (string)
        
        Enum values:
        
        Wired
        
        Mesh
      - Property connectionStatus (string)
        
        Enum values:
        
        Good
        
        Degraded
        
        Unknown
        
        Disconnected
        
        NoInformation
      - Property connectedPortUntaggedVlan (string)
      - Property correspondingPortUntaggedVlan (string)
      - Property connectedPortTaggedVlan (string)
      - Property correspondingPortTaggedVlan (string)
    - Changed property connectionStatus (string)
      
      Added enum value:
      - NoInformation
  - Changed property nodes (array)
    
    Changed items (object):
    - Added property taggedVlan (string)
    - Added property untaggedVlan (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property edges (array)
    
    Changed items (object):
    - Added property extraEdges (array)
    - Changed property connectionStatus (string)
      
      Added enum value:
      - NoInformation
  - Changed property nodes (array)
    
    Changed items (object):
    - Added property taggedVlan (string)
    - Added property untaggedVlan (string)

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property edges (array)
    
    Changed items (object):
    - Added property extraEdges (array)
    - Changed property connectionStatus (string)
      
      Added enum value:
      - NoInformation
  - Changed property nodes (array)
    
    Changed items (object):
    - Added property taggedVlan (string)
    - Added property untaggedVlan (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property edges (array)
    
    Changed items (object):
    - Added property extraEdges (array)
    - Changed property connectionStatus (string)
      
      Added enum value:
      - NoInformation
  - Changed property nodes (array)
    
    Changed items (object):
    - Added property taggedVlan (string)
    - Added property untaggedVlan (string)

`GET` /venues/{venueId}/meshTopologies

Return Type:

Changed response : 200 OK

Successful operation

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property edges (array)
    
    Changed items (object):
    - Added property extraEdges (array)
    - Changed property connectionStatus (string)
      
      Added enum value:
      - NoInformation
  - Changed property nodes (array)
    
    Changed items (object):
    - Added property taggedVlan (string)
    - Added property untaggedVlan (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property edges (array)
    
    Changed items (object):
    - Added property extraEdges (array)
    - Changed property connectionStatus (string)
      
      Added enum value:
      - NoInformation
  - Changed property nodes (array)
    
    Changed items (object):
    - Added property taggedVlan (string)
    - Added property untaggedVlan (string)

Changed response : 501 Not Implemented

Not implemented

Changed content type : application/json
- Changed property data (array)
  
  Changed items (object):
  - Changed property edges (array)
    
    Changed items (object):
    - Added property extraEdges (array)
    - Changed property connectionStatus (string)
      
      Added enum value:
      - NoInformation
  - Changed property nodes (array)
    
    Changed items (object):
    - Added property taggedVlan (string)
    - Added property untaggedVlan (string)
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (array)
  
  Changed items (object):
  - Changed property edges (array)
    
    Changed items (object):
    - Added property extraEdges (array)
    - Changed property connectionStatus (string)
      
      Added enum value:
      - NoInformation
  - Changed property nodes (array)
    
    Changed items (object):
    - Added property taggedVlan (string)
    - Added property untaggedVlan (string)

2024-04-22

What's Changed

`GET` /tenants/userProfiles

Return Type:

Changed response : 200 OK

OK

Changed content type : application/vnd.ruckus.v1+json
- Added property customRoleName (string)
- Added property scopes (array)
  
  Items (string):
Changed content type : application/json
- Added property customRoleName (string)
- Added property scopes (array)

`PUT` /tenants/userProfiles

Request:

Changed content type : application/vnd.ruckus.v1+json

Added property customRoleName (string)
Added property scopes (array)

Changed content type : application/json

Added property customRoleName (string)
Added property scopes (array)

Return Type:

Changed response : 200 OK

Accepted

Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Added property customRoleName (string)
  - Added property scopes (array)
Changed content type : application/json
- Changed property response (object)
  - Added property customRoleName (string)
  - Added property scopes (array)

Changed response : 500 Internal Server Error

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  - Added property customRoleName (string)
  - Added property scopes (array)
Changed content type : application/json
- Changed property response (object)
  - Added property customRoleName (string)
  - Added property scopes (array)

2024-04-12

What's Deprecated

`GET` /portalServiceProfiles/tags

Get Tags Filter of Portal Service Profiles

`GET` /portalServiceProfiles/networks

Get Network Filter of Portal Service Profiles

`DELETE` /guestUsers

Delete Guest Users

`GET` /guestUsers

Get Guest Users

`POST` /guestUsers

Add Guest Users

`GET` /guestUsers/{guestUserId}

Get Guest User by ID

`DELETE` /guestUsers/{guestUserId}

Delete Guest User by ID

`PATCH` /guestUsers/{guestUserId}

Update Guest User

`DELETE` /portalServiceProfiles

Delete Portal Service Profile

`GET` /portalServiceProfiles

Get Portal Service Profiles

`POST` /portalServiceProfiles/query

Query Portal Service Profiles

`POST` /networks/{networkId}/guestUsers

Import Guest Users by Network ID

What's Changed

`GET` /portalServiceProfiles/tags

`GET` /portalServiceProfiles/networks

`DELETE` /guestUsers

`GET` /guestUsers

`POST` /guestUsers

`GET` /guestUsers/{guestUserId}

`DELETE` /guestUsers/{guestUserId}

`PATCH` /guestUsers/{guestUserId}

`DELETE` /portalServiceProfiles

`GET` /portalServiceProfiles

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property content (array)
  
  Changed items (object):
  - Changed property content (object)
    - Added property welcomeText (string)
    - Added property welcomeColor (string)
    - Added property bgImage (string)
    - Added property bgColor (string)
    - Added property welcomeSize (integer)
    - Added property photo (string)
    - Added property photoRatio (integer)
    - Added property logo (string)
    - Added property logoRatio (integer)
    - Added property secondaryText (string)
    - Added property secondaryColor (string)
    - Added property secondarySize (integer)
    - Added property buttonColor (string)
    - Added property poweredBgColor (string)
    - Added property poweredColor (string)
    - Added property poweredSize (integer)
    - Added property poweredImg (string)
    - Added property poweredImgRatio (integer)
    - Added property wifi4EUNetworkId (string)
    - Added property termsCondition (string)
    - Added property componentDisplay (object)
      - Property logo (boolean)
      - Property welcome (boolean)
      - Property photo (boolean)
      - Property secondaryText (boolean)
      - Property termsConditions (boolean)
      - Property poweredBy (boolean)
      - Property wifi4eu (boolean)
    - Added property displayLangCode (string)
    - Deleted property array (boolean)
    - Deleted property null (boolean)
    - Deleted property float (boolean)
    - Deleted property number (boolean)
    - Deleted property valueNode (boolean)
    - Deleted property floatingPointNumber (boolean)
    - Deleted property containerNode (boolean)
    - Deleted property missingNode (boolean)
    - Deleted property object (boolean)
    - Deleted property nodeType (string)
    - Deleted property pojo (boolean)
    - Deleted property integralNumber (boolean)
    - Deleted property short (boolean)
    - Deleted property int (boolean)
    - Deleted property long (boolean)
    - Deleted property double (boolean)
    - Deleted property bigDecimal (boolean)
    - Deleted property bigInteger (boolean)
    - Deleted property textual (boolean)
    - Deleted property boolean (boolean)
    - Deleted property binary (boolean)

`POST` /portalServiceProfiles

Request:

New content type : application/vnd.ruckus.v1+json

Changed content type : application/json

Changed property content (object)
- Added property welcomeText (string)
- Added property welcomeColor (string)
- Added property bgImage (string)
- Added property bgColor (string)
- Added property welcomeSize (integer)
- Added property photo (string)
- Added property photoRatio (integer)
- Added property logo (string)
- Added property logoRatio (integer)
- Added property secondaryText (string)
- Added property secondaryColor (string)
- Added property secondarySize (integer)
- Added property buttonColor (string)
- Added property poweredBgColor (string)
- Added property poweredColor (string)
- Added property poweredSize (integer)
- Added property poweredImg (string)
- Added property poweredImgRatio (integer)
- Added property wifi4EUNetworkId (string)
- Added property termsCondition (string)
- Added property componentDisplay (object)
- Added property displayLangCode (string)
- Deleted property array (boolean)
- Deleted property null (boolean)
- Deleted property float (boolean)
- Deleted property number (boolean)
- Deleted property valueNode (boolean)
- Deleted property floatingPointNumber (boolean)
- Deleted property containerNode (boolean)
- Deleted property missingNode (boolean)
- Deleted property object (boolean)
- Deleted property nodeType (string)
- Deleted property pojo (boolean)
- Deleted property integralNumber (boolean)
- Deleted property short (boolean)
- Deleted property int (boolean)
- Deleted property long (boolean)
- Deleted property double (boolean)
- Deleted property bigDecimal (boolean)
- Deleted property bigInteger (boolean)
- Deleted property textual (boolean)
- Deleted property boolean (boolean)
- Deleted property binary (boolean)

Return Type:

Changed response : 201 Created

Created

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Changed property response (object)
  - Changed property content (object)
    - Added property welcomeText (string)
    - Added property welcomeColor (string)
    - Added property bgImage (string)
    - Added property bgColor (string)
    - Added property welcomeSize (integer)
    - Added property photo (string)
    - Added property photoRatio (integer)
    - Added property logo (string)
    - Added property logoRatio (integer)
    - Added property secondaryText (string)
    - Added property secondaryColor (string)
    - Added property secondarySize (integer)
    - Added property buttonColor (string)
    - Added property poweredBgColor (string)
    - Added property poweredColor (string)
    - Added property poweredSize (integer)
    - Added property poweredImg (string)
    - Added property poweredImgRatio (integer)
    - Added property wifi4EUNetworkId (string)
    - Added property termsCondition (string)
    - Added property componentDisplay (object)
    - Added property displayLangCode (string)
    - Deleted property array (boolean)
    - Deleted property null (boolean)
    - Deleted property float (boolean)
    - Deleted property number (boolean)
    - Deleted property valueNode (boolean)
    - Deleted property floatingPointNumber (boolean)
    - Deleted property containerNode (boolean)
    - Deleted property missingNode (boolean)
    - Deleted property object (boolean)
    - Deleted property nodeType (string)
    - Deleted property pojo (boolean)
    - Deleted property integralNumber (boolean)
    - Deleted property short (boolean)
    - Deleted property int (boolean)
    - Deleted property long (boolean)
    - Deleted property double (boolean)
    - Deleted property bigDecimal (boolean)
    - Deleted property bigInteger (boolean)
    - Deleted property textual (boolean)
    - Deleted property boolean (boolean)
    - Deleted property binary (boolean)

`GET` /portalServiceProfiles/{serviceProfileId}

Return Type:

Changed response : 200 OK

OK

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Changed property content (object)
  - Added property welcomeText (string)
  - Added property welcomeColor (string)
  - Added property bgImage (string)
  - Added property bgColor (string)
  - Added property welcomeSize (integer)
  - Added property photo (string)
  - Added property photoRatio (integer)
  - Added property logo (string)
  - Added property logoRatio (integer)
  - Added property secondaryText (string)
  - Added property secondaryColor (string)
  - Added property secondarySize (integer)
  - Added property buttonColor (string)
  - Added property poweredBgColor (string)
  - Added property poweredColor (string)
  - Added property poweredSize (integer)
  - Added property poweredImg (string)
  - Added property poweredImgRatio (integer)
  - Added property wifi4EUNetworkId (string)
  - Added property termsCondition (string)
  - Added property componentDisplay (object)
  - Added property displayLangCode (string)
  - Deleted property array (boolean)
  - Deleted property null (boolean)
  - Deleted property float (boolean)
  - Deleted property number (boolean)
  - Deleted property valueNode (boolean)
  - Deleted property floatingPointNumber (boolean)
  - Deleted property containerNode (boolean)
  - Deleted property missingNode (boolean)
  - Deleted property object (boolean)
  - Deleted property nodeType (string)
  - Deleted property pojo (boolean)
  - Deleted property integralNumber (boolean)
  - Deleted property short (boolean)
  - Deleted property int (boolean)
  - Deleted property long (boolean)
  - Deleted property double (boolean)
  - Deleted property bigDecimal (boolean)
  - Deleted property bigInteger (boolean)
  - Deleted property textual (boolean)
  - Deleted property boolean (boolean)
  - Deleted property binary (boolean)

`DELETE` /portalServiceProfiles/{serviceProfileId}

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Deleted property response (object)

`PUT` /portalServiceProfiles/{serviceProfileId}

Request:

New content type : application/vnd.ruckus.v1+json

Changed content type : application/json

Changed property content (object)
- Added property welcomeText (string)
- Added property welcomeColor (string)
- Added property bgImage (string)
- Added property bgColor (string)
- Added property welcomeSize (integer)
- Added property photo (string)
- Added property photoRatio (integer)
- Added property logo (string)
- Added property logoRatio (integer)
- Added property secondaryText (string)
- Added property secondaryColor (string)
- Added property secondarySize (integer)
- Added property buttonColor (string)
- Added property poweredBgColor (string)
- Added property poweredColor (string)
- Added property poweredSize (integer)
- Added property poweredImg (string)
- Added property poweredImgRatio (integer)
- Added property wifi4EUNetworkId (string)
- Added property termsCondition (string)
- Added property componentDisplay (object)
- Added property displayLangCode (string)
- Deleted property array (boolean)
- Deleted property null (boolean)
- Deleted property float (boolean)
- Deleted property number (boolean)
- Deleted property valueNode (boolean)
- Deleted property floatingPointNumber (boolean)
- Deleted property containerNode (boolean)
- Deleted property missingNode (boolean)
- Deleted property object (boolean)
- Deleted property nodeType (string)
- Deleted property pojo (boolean)
- Deleted property integralNumber (boolean)
- Deleted property short (boolean)
- Deleted property int (boolean)
- Deleted property long (boolean)
- Deleted property double (boolean)
- Deleted property bigDecimal (boolean)
- Deleted property bigInteger (boolean)
- Deleted property textual (boolean)
- Deleted property boolean (boolean)
- Deleted property binary (boolean)

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Changed property response (object)
  - Changed property content (object)
    - Added property welcomeText (string)
    - Added property welcomeColor (string)
    - Added property bgImage (string)
    - Added property bgColor (string)
    - Added property welcomeSize (integer)
    - Added property photo (string)
    - Added property photoRatio (integer)
    - Added property logo (string)
    - Added property logoRatio (integer)
    - Added property secondaryText (string)
    - Added property secondaryColor (string)
    - Added property secondarySize (integer)
    - Added property buttonColor (string)
    - Added property poweredBgColor (string)
    - Added property poweredColor (string)
    - Added property poweredSize (integer)
    - Added property poweredImg (string)
    - Added property poweredImgRatio (integer)
    - Added property wifi4EUNetworkId (string)
    - Added property termsCondition (string)
    - Added property componentDisplay (object)
    - Added property displayLangCode (string)
    - Deleted property array (boolean)
    - Deleted property null (boolean)
    - Deleted property float (boolean)
    - Deleted property number (boolean)
    - Deleted property valueNode (boolean)
    - Deleted property floatingPointNumber (boolean)
    - Deleted property containerNode (boolean)
    - Deleted property missingNode (boolean)
    - Deleted property object (boolean)
    - Deleted property nodeType (string)
    - Deleted property pojo (boolean)
    - Deleted property integralNumber (boolean)
    - Deleted property short (boolean)
    - Deleted property int (boolean)
    - Deleted property long (boolean)
    - Deleted property double (boolean)
    - Deleted property bigDecimal (boolean)
    - Deleted property bigInteger (boolean)
    - Deleted property textual (boolean)
    - Deleted property boolean (boolean)
    - Deleted property binary (boolean)

`POST` /portalServiceProfiles/query

Request:

New content type : application/vnd.ruckus.v1+json

Return Type:

Changed response : 200 OK

OK

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Changed property content (array)
  
  Changed items (object):
  - Changed property content (object)
    - Added property welcomeText (string)
    - Added property welcomeColor (string)
    - Added property bgImage (string)
    - Added property bgColor (string)
    - Added property welcomeSize (integer)
    - Added property photo (string)
    - Added property photoRatio (integer)
    - Added property logo (string)
    - Added property logoRatio (integer)
    - Added property secondaryText (string)
    - Added property secondaryColor (string)
    - Added property secondarySize (integer)
    - Added property buttonColor (string)
    - Added property poweredBgColor (string)
    - Added property poweredColor (string)
    - Added property poweredSize (integer)
    - Added property poweredImg (string)
    - Added property poweredImgRatio (integer)
    - Added property wifi4EUNetworkId (string)
    - Added property termsCondition (string)
    - Added property componentDisplay (object)
    - Added property displayLangCode (string)
    - Deleted property array (boolean)
    - Deleted property null (boolean)
    - Deleted property float (boolean)
    - Deleted property number (boolean)
    - Deleted property valueNode (boolean)
    - Deleted property floatingPointNumber (boolean)
    - Deleted property containerNode (boolean)
    - Deleted property missingNode (boolean)
    - Deleted property object (boolean)
    - Deleted property nodeType (string)
    - Deleted property pojo (boolean)
    - Deleted property integralNumber (boolean)
    - Deleted property short (boolean)
    - Deleted property int (boolean)
    - Deleted property long (boolean)
    - Deleted property double (boolean)
    - Deleted property bigDecimal (boolean)
    - Deleted property bigInteger (boolean)
    - Deleted property textual (boolean)
    - Deleted property boolean (boolean)
    - Deleted property binary (boolean)

`POST` /networks/{networkId}/guestUsers

Request:

Changed content type : multipart/form-data

New required properties:

file

2024-04-04

What's Changed

`PUT` /tenants/self

Request:

Changed content type : application/vnd.ruckus.v1+json

Added property enableAlpha (boolean)

Changed content type : application/json

Added property enableAlpha (boolean)

View Activities

View platform information. Note: this group of endpoints is used to view activities data. They don't provide the means to manage configuration.

Get Activities

Get the list of activities.

Request Body schema: application/json
required

fields	Array of strings
	object
page	integer <int32> >= 1
pageSize	integer <int32> >= 1
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"property1": { },
"property2": { }
},
"page": 1,
"pageSize": 1,
"sortField": "string",
"sortOrder": "ASC"
}

Get Activity Details

Get activity details.

path Parameters

activityId

required

string

Responses

Get Activity Devices

Get the list of activity devices.

path Parameters

activityId

required

string

Request Body schema: application/json
required

fields	Array of strings
	object
page	integer <int32> >= 1
pageSize	integer <int32> >= 1
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"property1": { },
"property2": { }
},
"page": 1,
"pageSize": 1,
"sortField": "string",
"sortOrder": "ASC"
}

Update Activity Notification Options

Update activity notification options.

path Parameters

activityId

required

string

Request Body schema: application/json
required

enabled	boolean
endpoint	string
type	string Enum: "email" "sms" "push"

Responses

Request samples

Payload

Content type

application/json

{"enabled": true,
"endpoint": "string",
"type": "email"
}

deleteSchedule

Responses

Certificate Authority

APIs for Certificate Authority Management.

Create New Certificate Authority

Request Body schema:
application/json
required

algorithm required	string (Certificate_Template_API_AlgorithmEnum) Enum: "SHA_1" "SHA_256" "SHA_384" "SHA_512" SHA-256 - The SHA-2 hash using 256 bits. SHA-384 - The SHA-2 hash using 384 bits. SHA-512 - The SHA-2 hash using 512 bits.
commonName required	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The common name of this authority.
country	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The country where your organization is located.
description	string [ 0 .. 255 ] characters The description of this authority.
email	string [ 0 .. 255 ] characters ^[\w!#$%&’+/=?`{\|}~^-]+(?:\.[\w!#$%&’+/=?`{... The email address for the party responsible for the certificate authority.
expireDate required	string <date-time> The expires date of the certificate authority.
keyLength required	integer <int32> [ 2048 .. 4096 ] The key length for the certificate authority.
locality	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The city where your organization is located.
name required	string [ 2 .. 255 ] characters The name of this authority.
organization	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The organization for the certificate authority.
organizationUnit	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The division of your organization responsible for the certificate authority.
startDate required	string <date-time> The expires date of the certificate authority.
state	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The state or region where your organization is located.
title	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The title for the certificate authority.

Responses

Request samples

Payload

Content type

application/json

{"algorithm": "SHA_1",
"commonName": "string",
"country": "string",
"description": "string",
"email": "string",
"expireDate": "2019-08-24T14:15:22Z",
"keyLength": 2048,
"locality": "string",
"name": "string",
"organization": "string",
"organizationUnit": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"title": "string"
}

Response samples

202
400

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Search for Certificate Authorities Matching Search String in Paged Result

Request Body schema:
application/json
required

fields	Array of strings
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200

Content type

application/json

{"data": [{"algorithm": "SHA_1",
"chain": "string",
"commonName": "string",
"country": "string",
"description": "string",
"details": "string",
"email": "string",
"expireDate": "2019-08-24T14:15:22Z",
"id": "string",
"keyLength": 2048,
"keyUsages": ["string"
],
"locality": "string",
"name": "string",
"ocspHash": "string",
"ocspName": "string",
"organization": "string",
"organizationUnit": "string",
"privateKeyBase64": "string",
"publicKeyBase64": "string",
"publicKeyShaThumbprint": "string",
"serialNumber": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"templateCount": 0,
"templateNames": ["string"
],
"title": "string",
"usages": ["string"
]
}
],
"fields": ["string"
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Delete the Certificate Authority

path Parameters

caId

required

string

Certificate Authority id

Responses

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Get Specific Certificate Authority

path Parameters

caId

required

string

CA id

Responses

Response samples

200
404

Content type

application/json

{"algorithm": "SHA_1",
"chain": "string",
"commonName": "string",
"country": "string",
"description": "string",
"details": "string",
"email": "string",
"expireDate": "2019-08-24T14:15:22Z",
"id": "string",
"keyLength": 2048,
"keyUsages": ["string"
],
"locality": "string",
"name": "string",
"ocspHash": "string",
"ocspName": "string",
"organization": "string",
"organizationUnit": "string",
"privateKeyBase64": "string",
"publicKeyBase64": "string",
"publicKeyShaThumbprint": "string",
"serialNumber": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"templateCount": 0,
"templateNames": ["string"
],
"title": "string",
"usages": ["string"
]
}

Update the Certificate Authority

path Parameters

caId

required

string

Certificate Authority id

Request Body schema:
application/json
required

description	string [ 0 .. 255 ] characters The description of this authority.
name	string [ 2 .. 255 ] characters The name of this authority.

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string"
}

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Download the Private KEY of Certificate Authority

path Parameters

caId

required

string

Certificate id

Request Body schema: application/json
required

includeChain	boolean
password	string The password to use to encrypt the private key. If encryption is not required, please leave it blank.

Responses

Request samples

Payload

Content type

application/json

{"includeChain": true,
"password": "string"
}

Download the Certificate Chain of Certificate Authority

path Parameters

caId

required

string

Certificate id

Responses

Delete the Certificate Authority Private KEY

path Parameters

caId

required

string

Certificate Authority id

Responses

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Upload the Certificate Authority Private KEY

path Parameters

caId

required

string

Certificate Authority id

Request Body schema: multipart/form-data

password	string If upload private key is password-protected, specify the password. If not, leave the password blank.
privateKey required	string <binary> Upload the private key of the certificate authority in PEM format.

Responses

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Create New Sub Certificate Authority

path Parameters

caId

required

string

Root Certificate Authority id

Request Body schema:
application/json
required

algorithm required	string (Certificate_Template_API_AlgorithmEnum) Enum: "SHA_1" "SHA_256" "SHA_384" "SHA_512" SHA-256 - The SHA-2 hash using 256 bits. SHA-384 - The SHA-2 hash using 384 bits. SHA-512 - The SHA-2 hash using 512 bits.
commonName required	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The common name of this authority.
country	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The country where your organization is located.
description	string [ 0 .. 255 ] characters The description of this authority.
email	string [ 0 .. 255 ] characters ^[\w!#$%&’+/=?`{\|}~^-]+(?:\.[\w!#$%&’+/=?`{... The email address for the party responsible for the certificate authority.
expireDate required	string <date-time> The expires date of the certificate authority.
keyLength required	integer <int32> [ 2048 .. 4096 ] The key length for the certificate authority.
locality	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The city where your organization is located.
name required	string [ 2 .. 255 ] characters The name of this authority.
organization	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The organization for the certificate authority.
organizationUnit	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The division of your organization responsible for the certificate authority.
startDate required	string <date-time> The expires date of the certificate authority.
state	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The state or region where your organization is located.
title	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The title for the certificate authority.

Responses

Request samples

Payload

Content type

application/json

{"algorithm": "SHA_1",
"commonName": "string",
"country": "string",
"description": "string",
"email": "string",
"expireDate": "2019-08-24T14:15:22Z",
"keyLength": 2048,
"locality": "string",
"name": "string",
"organization": "string",
"organizationUnit": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"title": "string"
}

Response samples

202
400

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Search for Sub Certificate Authorities Matching Search String in Paged Result

path Parameters

caId

required

string

Certificate Authority id

Request Body schema:
application/json
required

fields	Array of strings
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200

Content type

application/json

{"data": [{"algorithm": "SHA_1",
"chain": "string",
"commonName": "string",
"country": "string",
"description": "string",
"details": "string",
"email": "string",
"expireDate": "2019-08-24T14:15:22Z",
"id": "string",
"keyLength": 2048,
"keyUsages": ["string"
],
"locality": "string",
"name": "string",
"ocspHash": "string",
"ocspName": "string",
"organization": "string",
"organizationUnit": "string",
"privateKeyBase64": "string",
"publicKeyBase64": "string",
"publicKeyShaThumbprint": "string",
"serialNumber": "string",
"startDate": "2019-08-24T14:15:22Z",
"state": "string",
"templateCount": 0,
"templateNames": ["string"
],
"title": "string",
"usages": ["string"
]
}
],
"fields": ["string"
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Create New Certificate Template Belonging to a Specific Certificate Authority

path Parameters

caId

required

string

Onboard Certificate Authority id

Request Body schema:
application/json
required

algorithm required	string (Certificate_Template_API_AlgorithmEnum) Enum: "SHA_1" "SHA_256" "SHA_384" "SHA_512" SHA-256 - The SHA-2 hash using 256 bits. SHA-384 - The SHA-2 hash using 384 bits. SHA-512 - The SHA-2 hash using 512 bits.
caType required	string Value: "ONBOARD" Which CA signs the certificates from the template.
	object (Certificate_Template_API_ChromebookDto) The configuration of the Chromebook.
defaultAccess	boolean Default RADIUS access response will either be accepted or rejected.
description	string [ 0 .. 255 ] characters The description identifier for this template.
keyLength required	integer <int32> [ 2048 .. 4096 ] The key length for certificates generated using this template.
name required	string [ 2 .. 255 ] characters The name for the certificate template.
	object (Certificate_Template_API_OnboardDto) The configuration of the onboard CA.
policySetId	string The policy set that is assigned to this template.

Responses

Request samples

Payload

Content type

application/json

{"algorithm": "SHA_1",
"caType": "ONBOARD",
"chromebook": {"accountCredential": "string",
"apiKey": "string",
"certRemovalType": "NONE",
"enabled": true,
"enrollmentType": "USER",
"notifyAppId": "string"
},
"defaultAccess": true,
"description": "string",
"keyLength": 2048,
"name": "string",
"onboard": {"certificateType": "CLIENT",
"commonNamePattern": "string",
"countryPattern": "string",
"emailPattern": "string",
"localityPattern": "string",
"notAfterDate": "2019-08-24T14:15:22Z",
"notAfterType": "SPECIFIED_DATE",
"notAfterValue": 0,
"notBeforeDate": "2019-08-24T14:15:22Z",
"notBeforeType": "SPECIFIED_DATE",
"notBeforeValue": 0,
"organizationPattern": "string",
"organizationUnitPattern": "string",
"statePattern": "string"
},
"policySetId": "string"
}

Response samples

202
400

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Search for Templates Belonging to a Specific Certificate Authority That Match Search String in Paged Result

path Parameters

caId

required

string

Certificate Authority id

Request Body schema:
application/json
required

fields	Array of strings
	object (Certificate_Template_API_TemplateFilters)
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"caId": ["string"
],
"networkId": "string"
},
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200

Content type

application/json

{"data": [{"algorithm": "SHA_1",
"caType": "ONBOARD",
"certificateCount": 0,
"certificateNames": ["string"
],
"chromebook": {"accountCredential": "string",
"apiKey": "string",
"authUri": "string",
"certRemovalType": "NONE",
"clientEmail": "string",
"clientId": "string",
"enabled": true,
"enrollmentType": "USER",
"enrollmentUrl": "string",
"notifyAppId": "string",
"privateKey": "string",
"privateKeyId": "string",
"projectId": "string",
"tokenUri": "string",
"type": "string"
},
"defaultAccess": true,
"description": "string",
"id": "string",
"keyLength": 2048,
"name": "string",
"networkCount": 0,
"onboard": {"certificateAuthorityName": "string",
"certificateType": "CLIENT",
"commonNamePattern": "string",
"countryPattern": "string",
"emailPattern": "string",
"localityPattern": "string",
"notAfterDate": "2019-08-24T14:15:22Z",
"notAfterType": "SPECIFIED_DATE",
"notAfterValue": 0,
"notBeforeDate": "2019-08-24T14:15:22Z",
"notBeforeType": "SPECIFIED_DATE",
"notBeforeValue": 0,
"organizationPattern": "string",
"organizationUnitPattern": "string",
"statePattern": "string"
},
"policySetId": "string",
"variables": ["string"
]
}
],
"fields": ["string"
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Server and Client Certificate

APIs for Server and Client Certificate Management.

Create Certificate

path Parameters

caId

required

string

Certificate Authority id

Request Body schema:
application/json
required

algorithm required	string (Certificate_Template_API_AlgorithmEnum) Enum: "SHA_1" "SHA_256" "SHA_384" "SHA_512" SHA-256 - The SHA-2 hash using 256 bits. SHA-384 - The SHA-2 hash using 384 bits. SHA-512 - The SHA-2 hash using 512 bits.
commonName required	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The common name of the certificate.
country	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The country included in the certificate.
csrString	string The certificate signing request that should be signed by the CA.
description	string The description of the certificate.
email	string [ 0 .. 255 ] characters ^[\w!#$%&’+/=?`{\|}~^-]+(?:\.[\w!#$%&’+/=?`{... The email of the certificate.
keyLength required	integer <int32> [ 2048 .. 4096 ] The length of the key.
locality	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The locality included in the certificate.
name	string The name of the certificate.
notAfterDate required	string <date-time> The expires date of the certificate.
notBeforeDate required	string <date-time> The start date of the certificate.
organization	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The organization of the certificate.
organizationUnit	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The organization unit of the certificate.
revocationReason	string Reason for revocation of certificate.
state	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The state included in the certificate.
title	string [ 0 .. 255 ] characters ^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(... The title for the certificate authority.

Responses

Request samples

Payload

Content type

application/json

{"algorithm": "SHA_1",
"commonName": "string",
"country": "string",
"csrString": "string",
"description": "string",
"email": "string",
"keyLength": 2048,
"locality": "string",
"name": "string",
"notAfterDate": "2019-08-24T14:15:22Z",
"notBeforeDate": "2019-08-24T14:15:22Z",
"organization": "string",
"organizationUnit": "string",
"revocationReason": "string",
"state": "string",
"title": "string"
}

Response samples

202
400

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Search for Certificates Issued by Specific Certificate Authority Matching Search String in Paged Result

path Parameters

caId

required

string

Certificate Authority id

Request Body schema: application/json
required

fields	Array of strings
	object (Certificate_Template_API_CertFilters)
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"status": "VALID"
},
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200

Content type

application/json

{"data": [{"algorithm": "SHA_1",
"certificateAuthoritiesName": "string",
"chain": "string",
"commonName": "string",
"country": "string",
"createDate": "2019-08-24T14:15:22Z",
"description": "string",
"details": "string",
"email": "string",
"id": "string",
"keyLength": 2048,
"keyUsage": ["string"
],
"locality": "string",
"name": "string",
"notAfterDate": "2019-08-24T14:15:22Z",
"notBeforeDate": "2019-08-24T14:15:22Z",
"organization": "string",
"organizationUnit": "string",
"privateKeyBase64": "string",
"publicKeyBase64": "string",
"revocationDate": "2019-08-24T14:15:22Z",
"revocationReason": "string",
"serialNumber": "string",
"shaThumbprint": "string",
"state": "string",
"title": "string"
}
],
"fields": ["string"
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Upload the Certificate

Request Body schema: multipart/form-data

p12File required	string <binary> The certificate in p12 format must be uploaded.
password	string If upload is password-protected, specify the password. If not, leave the password blank.

Responses

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Search for Certificates Matching Search String in Paged Result

Request Body schema:
application/json
required

fields	Array of strings
	object (Certificate_Template_API_CertFilters)
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"status": "VALID"
},
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200

Content type

application/json

{"data": [{"algorithm": "SHA_1",
"certificateAuthoritiesName": "string",
"chain": "string",
"commonName": "string",
"country": "string",
"createDate": "2019-08-24T14:15:22Z",
"description": "string",
"details": "string",
"email": "string",
"id": "string",
"keyLength": 2048,
"keyUsage": ["string"
],
"locality": "string",
"name": "string",
"notAfterDate": "2019-08-24T14:15:22Z",
"notBeforeDate": "2019-08-24T14:15:22Z",
"organization": "string",
"organizationUnit": "string",
"privateKeyBase64": "string",
"publicKeyBase64": "string",
"revocationDate": "2019-08-24T14:15:22Z",
"revocationReason": "string",
"serialNumber": "string",
"shaThumbprint": "string",
"state": "string",
"title": "string"
}
],
"fields": ["string"
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Get Specific Certificate

path Parameters

certId

required

string

Certificate id

Responses

Response samples

200
404

Content type

application/json

{"algorithm": "SHA_1",
"certificateAuthoritiesName": "string",
"chain": "string",
"commonName": "string",
"country": "string",
"createDate": "2019-08-24T14:15:22Z",
"description": "string",
"details": "string",
"email": "string",
"id": "string",
"keyLength": 2048,
"keyUsage": ["string"
],
"locality": "string",
"name": "string",
"notAfterDate": "2019-08-24T14:15:22Z",
"notBeforeDate": "2019-08-24T14:15:22Z",
"organization": "string",
"organizationUnit": "string",
"privateKeyBase64": "string",
"publicKeyBase64": "string",
"revocationDate": "2019-08-24T14:15:22Z",
"revocationReason": "string",
"serialNumber": "string",
"shaThumbprint": "string",
"state": "string",
"title": "string"
}

Update the Certificate

path Parameters

certId

required

string

Certificate id

Request Body schema:
application/json
required

revocationReason

string [ 0 .. 255 ] characters

The reason for revocation of passphrase. If not revoked, this field should be null.

Responses

Request samples

Payload

Content type

application/json

{"revocationReason": "string"
}

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Download the Private KEY of Certificate

path Parameters

certId

required

string

Certificate id

Request Body schema: application/json
required

includeChain	boolean
password	string The password to use to encrypt the private key. If encryption is not required, please leave it blank.

Responses

Request samples

Payload

Content type

application/json

{"includeChain": true,
"password": "string"
}

Device Certificate

APIs for Device Certificate Management.

Search for Certificates Matching Search String in Paged Result

Request Body schema:
application/json
required

fields	Array of strings
	object (Certificate_Template_API_CertFilters)
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"status": "VALID"
},
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200

Content type

application/json

{"data": [{"certificateAuthoritiesName": "string",
"certificateTemplateName": "string",
"chain": "string",
"commonName": "string",
"country": "string",
"createDate": "2019-08-24T14:15:22Z",
"description": "string",
"details": "string",
"email": "string",
"enrollmentType": "CHROMEBOOK",
"id": "string",
"keyLength": 0,
"keyUsage": ["string"
],
"locality": "string",
"notAfterDate": "2019-08-24T14:15:22Z",
"notBeforeDate": "2019-08-24T14:15:22Z",
"organization": "string",
"organizationUnit": "string",
"privateKeyBase64": "string",
"publicKeyBase64": "string",
"revocationDate": "2019-08-24T14:15:22Z",
"revocationReason": "string",
"serialNumber": "string",
"shaThumbprint": "string",
"state": "string"
}
],
"fields": ["string"
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Generate Certificate

path Parameters

templateId

required

string

Request Body schema:
application/json
required

csrString	string The certificate signing request that should be signed by the CA.
description	string [ 0 .. 255 ] characters Description of the item for reference.
userName	string [ 2 .. 255 ] characters The certificate template contains the variable. The value specified here will be used to replace the variable.
	object The values in this map will be used to replace the variables in the generated certificate.

Responses

Request samples

Payload

Content type

application/json

{"csrString": "string",
"description": "string",
"userName": "string",
"variableValues": {"property1": "string",
"property2": "string"
}
}

Response samples

202
400

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Search for Certificates in Specific Template Matching Search String in Paged Result

path Parameters

templateId

required

string

Request Body schema:
application/json
required

fields	Array of strings
	object (Certificate_Template_API_CertFilters)
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"status": "VALID"
},
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200

Content type

application/json

{"data": [{"certificateAuthoritiesName": "string",
"certificateTemplateName": "string",
"chain": "string",
"commonName": "string",
"country": "string",
"createDate": "2019-08-24T14:15:22Z",
"description": "string",
"details": "string",
"email": "string",
"enrollmentType": "CHROMEBOOK",
"id": "string",
"keyLength": 0,
"keyUsage": ["string"
],
"locality": "string",
"notAfterDate": "2019-08-24T14:15:22Z",
"notBeforeDate": "2019-08-24T14:15:22Z",
"organization": "string",
"organizationUnit": "string",
"privateKeyBase64": "string",
"publicKeyBase64": "string",
"revocationDate": "2019-08-24T14:15:22Z",
"revocationReason": "string",
"serialNumber": "string",
"shaThumbprint": "string",
"state": "string"
}
],
"fields": ["string"
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Get Specific Certificate

path Parameters

certId required	string Certificate id
templateId required	string Certificate template id

query Parameters

password	string Default: "" The password to use to encrypt the private key. To leave private key unencrypted, leave blank
includeChain	boolean Default: true

Responses

Response samples

200
404

Content type

application/json

{"certificateAuthoritiesName": "string",
"certificateTemplateName": "string",
"chain": "string",
"commonName": "string",
"country": "string",
"createDate": "2019-08-24T14:15:22Z",
"description": "string",
"details": "string",
"email": "string",
"enrollmentType": "CHROMEBOOK",
"id": "string",
"keyLength": 0,
"keyUsage": ["string"
],
"locality": "string",
"notAfterDate": "2019-08-24T14:15:22Z",
"notBeforeDate": "2019-08-24T14:15:22Z",
"organization": "string",
"organizationUnit": "string",
"privateKeyBase64": "string",
"publicKeyBase64": "string",
"revocationDate": "2019-08-24T14:15:22Z",
"revocationReason": "string",
"serialNumber": "string",
"shaThumbprint": "string",
"state": "string"
}

Update the Certificate

path Parameters

certId

required

string

Certificate id

Request Body schema:
application/json
required

revocationReason

string [ 0 .. 255 ] characters

The reason for revocation of passphrase. If not revoked, this field should be null.

Responses

Request samples

Payload

Content type

application/json

{"revocationReason": "string"
}

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Download the Private KEY of Certificate

path Parameters

certId required	string Certificate id
templateId required	string Certificate template id

Request Body schema: application/json
required

includeChain	boolean
password	string The password to use to encrypt the private key. If encryption is not required, please leave it blank.

Responses

Request samples

Payload

Content type

application/json

{"includeChain": true,
"password": "string"
}

Download Issued Certificate Chain

path Parameters

certId required	string Certificate id
templateId required	string Certificate template id

Responses

Generate Certificate to a Specific Identity

path Parameters

templateId required	string
identityId required	string

Request Body schema:
application/json
required

csrString	string The certificate signing request that should be signed by the CA.
description	string [ 0 .. 255 ] characters Description of the item for reference.
userName	string [ 2 .. 255 ] characters The certificate template contains the variable. The value specified here will be used to replace the variable.
	object The values in this map will be used to replace the variables in the generated certificate.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/certificateTemplates/{templateId}/identities/{identityId}/certificates

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/certificateTemplates/{templateId}/identities/{identityId}/certificates

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/certificateTemplates/{templateId}/identities/{identityId}/certificates

Request samples

Payload

Content type

application/json

{"csrString": "string",
"description": "string",
"userName": "string",
"variableValues": {"property1": "string",
"property2": "string"
}
}

Response samples

202
400

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Search for Certificates Associated with Identity in Paged Result

path Parameters

templateId required	string Certificate template id
identityId required	string Identity id

Request Body schema:
application/json
required

fields	Array of strings
	object (Certificate_Template_API_CertFilters)
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/certificateTemplates/{templateId}/identities/{identityId}/certificates/query

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/certificateTemplates/{templateId}/identities/{identityId}/certificates/query

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/certificateTemplates/{templateId}/identities/{identityId}/certificates/query

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"status": "VALID"
},
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200

Content type

application/json

{"data": [{"certificateAuthoritiesName": "string",
"certificateTemplateName": "string",
"chain": "string",
"commonName": "string",
"country": "string",
"createDate": "2019-08-24T14:15:22Z",
"description": "string",
"details": "string",
"email": "string",
"enrollmentType": "CHROMEBOOK",
"id": "string",
"keyLength": 0,
"keyUsage": ["string"
],
"locality": "string",
"notAfterDate": "2019-08-24T14:15:22Z",
"notBeforeDate": "2019-08-24T14:15:22Z",
"organization": "string",
"organizationUnit": "string",
"privateKeyBase64": "string",
"publicKeyBase64": "string",
"revocationDate": "2019-08-24T14:15:22Z",
"revocationReason": "string",
"serialNumber": "string",
"shaThumbprint": "string",
"state": "string"
}
],
"fields": ["string"
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Certificate Template

APIs for Certificate Template Management.

Search for Certificate Templates Matching Search String in Paged Result

Request Body schema:
application/json
required

fields	Array of strings
	object (Certificate_Template_API_TemplateFilters)
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"caId": ["string"
],
"networkId": "string"
},
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200

Content type

application/json

{"data": [{"algorithm": "SHA_1",
"caType": "ONBOARD",
"certificateCount": 0,
"certificateNames": ["string"
],
"chromebook": {"accountCredential": "string",
"apiKey": "string",
"authUri": "string",
"certRemovalType": "NONE",
"clientEmail": "string",
"clientId": "string",
"enabled": true,
"enrollmentType": "USER",
"enrollmentUrl": "string",
"notifyAppId": "string",
"privateKey": "string",
"privateKeyId": "string",
"projectId": "string",
"tokenUri": "string",
"type": "string"
},
"defaultAccess": true,
"description": "string",
"id": "string",
"keyLength": 2048,
"name": "string",
"networkCount": 0,
"onboard": {"certificateAuthorityName": "string",
"certificateType": "CLIENT",
"commonNamePattern": "string",
"countryPattern": "string",
"emailPattern": "string",
"localityPattern": "string",
"notAfterDate": "2019-08-24T14:15:22Z",
"notAfterType": "SPECIFIED_DATE",
"notAfterValue": 0,
"notBeforeDate": "2019-08-24T14:15:22Z",
"notBeforeType": "SPECIFIED_DATE",
"notBeforeValue": 0,
"organizationPattern": "string",
"organizationUnitPattern": "string",
"statePattern": "string"
},
"policySetId": "string",
"variables": ["string"
]
}
],
"fields": ["string"
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Delete the Certificate Template

path Parameters

templateId

required

string

Responses

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Get Specific Certificate Template

path Parameters

templateId

required

string

Certificate template id

Responses

Response samples

200
404

Content type

application/json

{"algorithm": "SHA_1",
"caType": "ONBOARD",
"certificateCount": 0,
"certificateNames": ["string"
],
"chromebook": {"accountCredential": "string",
"apiKey": "string",
"authUri": "string",
"certRemovalType": "NONE",
"clientEmail": "string",
"clientId": "string",
"enabled": true,
"enrollmentType": "USER",
"enrollmentUrl": "string",
"notifyAppId": "string",
"privateKey": "string",
"privateKeyId": "string",
"projectId": "string",
"tokenUri": "string",
"type": "string"
},
"defaultAccess": true,
"description": "string",
"id": "string",
"keyLength": 2048,
"name": "string",
"networkCount": 0,
"onboard": {"certificateAuthorityName": "string",
"certificateType": "CLIENT",
"commonNamePattern": "string",
"countryPattern": "string",
"emailPattern": "string",
"localityPattern": "string",
"notAfterDate": "2019-08-24T14:15:22Z",
"notAfterType": "SPECIFIED_DATE",
"notAfterValue": 0,
"notBeforeDate": "2019-08-24T14:15:22Z",
"notBeforeType": "SPECIFIED_DATE",
"notBeforeValue": 0,
"organizationPattern": "string",
"organizationUnitPattern": "string",
"statePattern": "string"
},
"policySetId": "string",
"variables": ["string"
]
}

Update the Certificate Template

path Parameters

templateId

required

string

Certificate template id

Request Body schema:
application/json
required

algorithm	string (Certificate_Template_API_AlgorithmEnum) Enum: "SHA_1" "SHA_256" "SHA_384" "SHA_512" SHA-256 - The SHA-2 hash using 256 bits. SHA-384 - The SHA-2 hash using 384 bits. SHA-512 - The SHA-2 hash using 512 bits.
	object (Certificate_Template_API_ChromebookDto) The configuration of the Chromebook.
defaultAccess	boolean Default RADIUS access response will either be accepted or rejected.
description	string [ 0 .. 255 ] characters The description identifier for this template.
keyLength	integer <int32> [ 2048 .. 4096 ] The key length for certificates generated using this template.
name	string [ 2 .. 255 ] characters The name for the certificate template.
	object (Certificate_Template_API_OnboardDto) The configuration of the onboard CA.

Responses

Request samples

Payload

Content type

application/json

{"algorithm": "SHA_1",
"chromebook": {"accountCredential": "string",
"apiKey": "string",
"certRemovalType": "NONE",
"enabled": true,
"enrollmentType": "USER",
"notifyAppId": "string"
},
"defaultAccess": true,
"description": "string",
"keyLength": 2048,
"name": "string",
"onboard": {"certificateType": "CLIENT",
"commonNamePattern": "string",
"countryPattern": "string",
"emailPattern": "string",
"localityPattern": "string",
"notAfterDate": "2019-08-24T14:15:22Z",
"notAfterType": "SPECIFIED_DATE",
"notAfterValue": 0,
"notBeforeDate": "2019-08-24T14:15:22Z",
"notBeforeType": "SPECIFIED_DATE",
"notBeforeValue": 0,
"organizationPattern": "string",
"organizationUnitPattern": "string",
"statePattern": "string"
}
}

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Get Microsoft Software Installer Packages of Template

path Parameters

templateId

required

string

Certificate template id

query Parameters

page	integer >= 0 Default: 0 Zero-based page index (0..N)
size	integer >= 1 Default: 20 The size of the page to be returned
sort	Array of strings Sorting criteria in the format: property,(asc\|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

200

Content type

application/json

{"content": [{ }
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Create Microsoft Software Installer Package for Template

path Parameters

templateId

required

string

Request Body schema:
application/json
required

allowedSubnets	string If populated, only the IP addresses or subnets specified are allowed to use this package.
blockedSubnets	string If populated, the IP addresses or subnets specified are blocked from using this package. Blocked subnets override the allowed subnets.
description	string [ 0 .. 255 ] characters Description of the package.
enabled	boolean Indicates whether this package should be used.
expirationDate required	string <date-time> The expire date for this package.
name	string [ 2 .. 255 ] characters The unique reference name of the package.
productId	string The product ID for the package.
productName required	string [ 2 .. 255 ] characters The product name for the package.
profileType required	string Enum: "USER_TYPE" "MACHINE_TYPE" The profile type for the package.
usernameVariableSource required	string Enum: "COMPUTER_NAME" "CURRENT_USER" Determines where the variable (usable in the certificate template) is derived from.

Responses

Request samples

Payload

Content type

application/json

{"allowedSubnets": "string",
"blockedSubnets": "string",
"description": "string",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"name": "string",
"productId": "string",
"productName": "string",
"profileType": "USER_TYPE",
"usernameVariableSource": "COMPUTER_NAME"
}

Response samples

202
400

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Delete the Microsoft Software Installer Package

path Parameters

templateId required	string Certificate template id
msiPackageId required	string MSI package id

Responses

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Get Specific Microsoft Software Installer Package

path Parameters

templateId required	string Certificate template id
msiPackageId required	string MSI package id

Responses

Response samples

200
404

Content type

application/json

{"allowedSubnets": "string",
"blockedSubnets": "string",
"description": "string",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"passphrase": "string",
"productId": "string",
"productName": "string",
"profileType": "USER_TYPE",
"usernameVariableSource": "COMPUTER_NAME"
}

Update the Microsoft Software Installer Package of Template

path Parameters

templateId required	string Certificate template id
msiPackageId required	string MSI Package id

Request Body schema:
application/json
required

allowedSubnets	string If populated, only the IP addresses or subnets specified are allowed to use this package.
blockedSubnets	string If populated, the IP addresses or subnets specified are blocked from using this package. Blocked subnets override the allowed subnets.
description	string [ 0 .. 255 ] characters Description of the package.
enabled	boolean Indicates whether this package should be used.
expirationDate required	string <date-time> The expire date for this package.
name	string [ 2 .. 255 ] characters The unique reference name of the package.
productId	string The product ID for the package.
productName required	string [ 2 .. 255 ] characters The product name for the package.
profileType required	string Enum: "USER_TYPE" "MACHINE_TYPE" The profile type for the package.
usernameVariableSource required	string Enum: "COMPUTER_NAME" "CURRENT_USER" Determines where the variable (usable in the certificate template) is derived from.

Responses

Request samples

Payload

Content type

application/json

{"allowedSubnets": "string",
"blockedSubnets": "string",
"description": "string",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"name": "string",
"productId": "string",
"productName": "string",
"profileType": "USER_TYPE",
"usernameVariableSource": "COMPUTER_NAME"
}

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Get Notifications of Template

path Parameters

templateId

required

string

Certificate template id

query Parameters

page	integer >= 0 Default: 0 Zero-based page index (0..N)
size	integer >= 1 Default: 20 The size of the page to be returned
sort	Array of strings Sorting criteria in the format: property,(asc\|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

200

Content type

application/json

{"content": [{ }
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Create Notification for Template

path Parameters

templateId

required

string

Request Body schema:
application/json
required

dateValue	string The number of hours/days/months/etc to be offset from the event date when calculating when to send the notification.
email	string [ 0 .. 255 ] characters ^[\w!#$%&’+/=?`{\|}~^-]+(?:\.[\w!#$%&’+/=?`{... Indicates whether this package should be used.
emailSubject	string [ 0 .. 255 ] characters The subject of the email to be sent for this notification.
emailTemplate	string [ 0 .. 255 ] characters The message of the email to be sent for this notification.
notificationEvent	string Enum: "ON_ISSUANCE" "ON_REVOCATION" "ON_EXPIRATION" "ON_REVOKED_USE" The event upon which to base the sending of the notification.
notificationMethod	string Enum: "EMAIL_ELSE_SMS" "SMS_ELSE_EMAIL" "EMAIL_AND_SMS" "EMAIL_ONLY" "SMS_ONLY" "EMAIL_ADMINISTRATOR" The method(s) to use to notify the user.
notificationMethodData	string The data of to use to notify the user.
smsSubject	string [ 0 .. 255 ] characters The subject of the SMS to be sent for this notification.
smsTemplate	string [ 0 .. 255 ] characters The message of the email to be sent for this notification.
staticDerivedDateType	string The basis for calculating the date to send the notification.

Responses

Request samples

Payload

Content type

application/json

{"dateValue": "string",
"email": "string",
"emailSubject": "string",
"emailTemplate": "string",
"notificationEvent": "ON_ISSUANCE",
"notificationMethod": "EMAIL_ELSE_SMS",
"notificationMethodData": "string",
"smsSubject": "string",
"smsTemplate": "string",
"staticDerivedDateType": "string"
}

Response samples

202
400

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Delete the Notification

path Parameters

templateId required	string Certificate template id
notificationId required	string Notification id

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/certificateTemplates/{templateId}/notifications/{notificationId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/certificateTemplates/{templateId}/notifications/{notificationId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/certificateTemplates/{templateId}/notifications/{notificationId}

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Get Specific Notification

path Parameters

templateId required	string Certificate template id
notificationId required	string Notification id

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/certificateTemplates/{templateId}/notifications/{notificationId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/certificateTemplates/{templateId}/notifications/{notificationId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/certificateTemplates/{templateId}/notifications/{notificationId}

Response samples

200
404

Content type

application/json

{"dateValue": "string",
"email": "string",
"emailSubject": "string",
"emailTemplate": "string",
"id": "string",
"notificationEvent": "ON_ISSUANCE",
"notificationMethod": "EMAIL_ELSE_SMS",
"notificationMethodData": "string",
"smsSubject": "string",
"smsTemplate": "string",
"staticDerivedDateType": "string"
}

Update the Notification of Template

path Parameters

templateId required	string Certificate template id
notificationId required	string Notification id

Request Body schema:
application/json
required

dateValue	string The number of hours/days/months/etc to be offset from the event date when calculating when to send the notification.
email	string [ 0 .. 255 ] characters ^[\w!#$%&’+/=?`{\|}~^-]+(?:\.[\w!#$%&’+/=?`{... Indicates whether this package should be used.
emailSubject	string [ 0 .. 255 ] characters The subject of the email to be sent for this notification.
emailTemplate	string [ 0 .. 255 ] characters The message of the email to be sent for this notification.
notificationEvent	string Enum: "ON_ISSUANCE" "ON_REVOCATION" "ON_EXPIRATION" "ON_REVOKED_USE" The event upon which to base the sending of the notification.
notificationMethod	string Enum: "EMAIL_ELSE_SMS" "SMS_ELSE_EMAIL" "EMAIL_AND_SMS" "EMAIL_ONLY" "SMS_ONLY" "EMAIL_ADMINISTRATOR" The method(s) to use to notify the user.
notificationMethodData	string The data of to use to notify the user.
smsSubject	string [ 0 .. 255 ] characters The subject of the SMS to be sent for this notification.
smsTemplate	string [ 0 .. 255 ] characters The message of the email to be sent for this notification.
staticDerivedDateType	string The basis for calculating the date to send the notification.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/certificateTemplates/{templateId}/notifications/{notificationId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/certificateTemplates/{templateId}/notifications/{notificationId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/certificateTemplates/{templateId}/notifications/{notificationId}

Request samples

Payload

Content type

application/json

{"dateValue": "string",
"email": "string",
"emailSubject": "string",
"emailTemplate": "string",
"notificationEvent": "ON_ISSUANCE",
"notificationMethod": "EMAIL_ELSE_SMS",
"notificationMethodData": "string",
"smsSubject": "string",
"smsTemplate": "string",
"staticDerivedDateType": "string"
}

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Remove Policy Set from a Template

path Parameters

templateId required	string Template id
policySetId required	string Policy set id

Responses

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Update Policy Set for a Template

path Parameters

templateId required	string Template id
policySetId required	string Policy set id

Responses

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Get Simple Certificate Enrollment Protocol of Template

path Parameters

templateId

required

string

Certificate template id

query Parameters

page	integer >= 0 Default: 0 Zero-based page index (0..N)
size	integer >= 1 Default: 20 The size of the page to be returned
sort	Array of strings Sorting criteria in the format: property,(asc\|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

200

Content type

application/json

{"content": [{ }
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Create Simple Certificate Enrollment Protocol for Template

path Parameters

templateId

required

string

Certificate template id

Request Body schema:
application/json
required

allowedSubnets	string If populated, only the IPs or subnets specified will be allowed to utilize the simple certificate enrollment protocol server using this key.
azureApplicationId	string The azure application client ID from the azure configuration portal.
azureApplicationKey	string The azure application key and client secret configured in the azure configuration portal.
blockedSubnets	string If populated, the IPs or subnets specified will be blocked from utilizing the simple certificate enrollment protocol server using this key.
challengePassword	string If checked, the client will need to provide this password during the exchange.
challengePasswordType required	string Enum: "NONE" "STATIC" "MICROSOFT_INTUNE" Optionally specify a challenge password which must be provided by the client during the simple certificate enrollment protocol key exchange.
cnValue1 required	string Enum: "IGNORE" "MAC_ADDRESS" "USERNAME" "DEVICE_NAME" "EMAIL" "LOCATION" The certificate signing requests created as part of the simple certificate enrollment protocol interaction will contain one or more common name values. The system will treat the first common name as the type of value specified.
cnValue2 required	string Enum: "IGNORE" "MAC_ADDRESS" "USERNAME" "DEVICE_NAME" "EMAIL" "LOCATION" The certificate signing requests created as part of the simple certificate enrollment protocol interaction will contain one or more common name values. The system will treat the second common name as the type of value specified.
cnValue3 required	string Enum: "IGNORE" "MAC_ADDRESS" "USERNAME" "DEVICE_NAME" "EMAIL" "LOCATION" The certificate signing requests created as part of the simple certificate enrollment protocol interaction will contain one or more common name values. The system will treat the third common name as the type of value specified.
description	string [ 0 .. 255 ] characters Description of the item for reference.
enabled	boolean Indicates whether this key should be used.
expirationDate required	string <date-time> The expire date for the key.
intuneTenantId	string The azure tenant ID from the azure configuration portal.
name required	string [ 2 .. 255 ] characters The reference name of the item.
overrideDays	integer <int32> If greater than 0, this overrides the expiration date in the certificate template for certificates generated using this key.
scepKey required	string The shared secret used as the key within the URL.

Responses

Request samples

Payload

Content type

application/json

{"allowedSubnets": "string",
"azureApplicationId": "string",
"azureApplicationKey": "string",
"blockedSubnets": "string",
"challengePassword": "string",
"challengePasswordType": "NONE",
"cnValue1": "IGNORE",
"cnValue2": "IGNORE",
"cnValue3": "IGNORE",
"description": "string",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"intuneTenantId": "string",
"name": "string",
"overrideDays": 0,
"scepKey": "string"
}

Response samples

202
400

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Delete the Simple Certificate Enrollment Protocol

path Parameters

templateId required	string Certificate template id
scepKeyId required	string SCEP key id

Responses

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Get Specific Simple Certificate Enrollment Protocol of Template

path Parameters

templateId required	string Certificate template id
scepKeyId required	string SCEP key id

Responses

Response samples

200
404

Content type

application/json

{"allowedSubnets": "string",
"azureApplicationId": "string",
"azureApplicationKey": "string",
"blockedSubnets": "string",
"challengePassword": "string",
"challengePasswordType": "NONE",
"cnValue1": "IGNORE",
"cnValue2": "IGNORE",
"cnValue3": "IGNORE",
"description": "string",
"enabled": true,
"enrollmentUrl": "string",
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"intuneTenantId": "string",
"name": "string",
"overrideDays": 0,
"scepKey": "string"
}

Update the Simple Certificate Enrollment Protocol of Template

path Parameters

templateId required	string Certificate template id
scepKeyId required	string ScepKey Id

Request Body schema:
application/json
required

allowedSubnets	string If populated, only the IPs or subnets specified will be allowed to utilize the simple certificate enrollment protocol server using this key.
azureApplicationId	string The azure application client ID from the azure configuration portal.
azureApplicationKey	string The azure application key and client secret configured in the azure configuration portal.
blockedSubnets	string If populated, the IPs or subnets specified will be blocked from utilizing the simple certificate enrollment protocol server using this key.
challengePassword	string If checked, the client will need to provide this password during the exchange.
challengePasswordType required	string Enum: "NONE" "STATIC" "MICROSOFT_INTUNE" Optionally specify a challenge password which must be provided by the client during the simple certificate enrollment protocol key exchange.
cnValue1 required	string Enum: "IGNORE" "MAC_ADDRESS" "USERNAME" "DEVICE_NAME" "EMAIL" "LOCATION" The certificate signing requests created as part of the simple certificate enrollment protocol interaction will contain one or more common name values. The system will treat the first common name as the type of value specified.
cnValue2 required	string Enum: "IGNORE" "MAC_ADDRESS" "USERNAME" "DEVICE_NAME" "EMAIL" "LOCATION" The certificate signing requests created as part of the simple certificate enrollment protocol interaction will contain one or more common name values. The system will treat the second common name as the type of value specified.
cnValue3 required	string Enum: "IGNORE" "MAC_ADDRESS" "USERNAME" "DEVICE_NAME" "EMAIL" "LOCATION" The certificate signing requests created as part of the simple certificate enrollment protocol interaction will contain one or more common name values. The system will treat the third common name as the type of value specified.
description	string [ 0 .. 255 ] characters Description of the item for reference.
enabled	boolean Indicates whether this key should be used.
expirationDate required	string <date-time> The expire date for the key.
intuneTenantId	string The azure tenant ID from the azure configuration portal.
name required	string [ 2 .. 255 ] characters The reference name of the item.
overrideDays	integer <int32> If greater than 0, this overrides the expiration date in the certificate template for certificates generated using this key.
scepKey required	string The shared secret used as the key within the URL.

Responses

Request samples

Payload

Content type

application/json

{"allowedSubnets": "string",
"azureApplicationId": "string",
"azureApplicationKey": "string",
"blockedSubnets": "string",
"challengePassword": "string",
"challengePasswordType": "NONE",
"cnValue1": "IGNORE",
"cnValue2": "IGNORE",
"cnValue3": "IGNORE",
"description": "string",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"intuneTenantId": "string",
"name": "string",
"overrideDays": 0,
"scepKey": "string"
}

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

APIs for DPSK Service Management

Get DPSK Pools Deprecated

query Parameters

name	string Filter by dpsk service name
networkId	string Filter by associated wifi network
locked	boolean Filter by association status. true if locked by other service
required	object (DPSK_API_&_Model_Documentation_Pageable) parameters for paging

Responses

Response samples

200

Content type

application/json

{"content": [{ }
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Create New DPSK Pool

Request Body schema:
application/json
required

deviceCountLimit	integer <int32>
expirationDate	string <date-time> Expiration date of pool.
expirationOffset	integer <int32> Date of expiration offset.
expirationType	string Enum: "SPECIFIED_DATE" "HOURS_AFTER_TIME" "DAYS_AFTER_TIME" "WEEKS_AFTER_TIME" "MONTHS_AFTER_TIME" "YEARS_AFTER_TIME" Expiration date rule.
name required	string [ 0 .. 255 ] characters
passphraseFormat required	string Enum: "MOST_SECURED" "KEYBOARD_FRIENDLY" "NUMBERS_ONLY" Passphrase format.
passphraseLength required	integer <int32> Generated passphrase length.
policyDefaultAccess	boolean

Responses

Request samples

Payload

Content type

application/json

{"deviceCountLimit": 0,
"expirationDate": "2019-08-24T14:15:22Z",
"expirationOffset": 0,
"expirationType": "SPECIFIED_DATE",
"name": "string",
"passphraseFormat": "MOST_SECURED",
"passphraseLength": 0,
"policyDefaultAccess": true
}

Response samples

202
400

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Search for DPSK Pools Matching Search String in Paged Result

Request Body schema:
application/json
required

fields	Array of strings
	object (DPSK_API_&_Model_Documentation_DpskPoolFilters)
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"passphraseFormat": ["string"
]
},
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200

Content type

application/json

{"data": [{"createdDate": "2019-08-24T14:15:22Z",
"deviceCountLimit": 0,
"expirationDate": "2019-08-24T14:15:22Z",
"expirationOffset": 0,
"expirationType": "SPECIFIED_DATE",
"id": "string",
"isReferenced": true,
"lastModifiedDate": "2019-08-24T14:15:22Z",
"name": "string",
"networkCount": 0,
"passphraseFormat": "MOST_SECURED",
"passphraseLength": 0,
"policyDefaultAccess": true
}
],
"fields": ["string"
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Delete the DPSK Pool

path Parameters

poolId

required

string

Responses

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Get Specific DPSK Pool

path Parameters

poolId

required

string

DPSK pool id

Responses

Response samples

200
404

Content type

application/json

{"createdDate": "2019-08-24T14:15:22Z",
"deviceCountLimit": 0,
"expirationDate": "2019-08-24T14:15:22Z",
"expirationOffset": 0,
"expirationType": "SPECIFIED_DATE",
"id": "string",
"isReferenced": true,
"lastModifiedDate": "2019-08-24T14:15:22Z",
"name": "string",
"networkCount": 0,
"passphraseFormat": "MOST_SECURED",
"passphraseLength": 0,
"policyDefaultAccess": true
}

Update the DPSK Pool

path Parameters

poolId

required

string

DPSK pool id

Request Body schema:
application/json
required

deviceCountLimit	integer <int32>
expirationDate	string <date-time> Expiration date of pool.
expirationOffset	integer <int32> Date of expiration offset.
expirationType	string Enum: "SPECIFIED_DATE" "HOURS_AFTER_TIME" "DAYS_AFTER_TIME" "WEEKS_AFTER_TIME" "MONTHS_AFTER_TIME" "YEARS_AFTER_TIME" Expiration date rule.
name required	string [ 0 .. 255 ] characters
passphraseFormat required	string Enum: "MOST_SECURED" "KEYBOARD_FRIENDLY" "NUMBERS_ONLY" Passphrase format.
passphraseLength required	integer <int32> Generated passphrase length.
policyDefaultAccess	boolean

Responses

Request samples

Payload

Content type

application/json

{"deviceCountLimit": 0,
"expirationDate": "2019-08-24T14:15:22Z",
"expirationOffset": 0,
"expirationType": "SPECIFIED_DATE",
"name": "string",
"passphraseFormat": "MOST_SECURED",
"passphraseLength": 0,
"policyDefaultAccess": true
}

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Update the DPSK Pool

path Parameters

poolId

required

string

DPSK pool id

Request Body schema:
application/json
required

deviceCountLimit	integer <int32>
expirationDate	string <date-time> Expiration date of pool.
expirationOffset	integer <int32> Date of expiration offset.
expirationType	string Enum: "SPECIFIED_DATE" "HOURS_AFTER_TIME" "DAYS_AFTER_TIME" "WEEKS_AFTER_TIME" "MONTHS_AFTER_TIME" "YEARS_AFTER_TIME" Expiration date rule.
name required	string [ 0 .. 255 ] characters
passphraseFormat required	string Enum: "MOST_SECURED" "KEYBOARD_FRIENDLY" "NUMBERS_ONLY" Passphrase format.
passphraseLength required	integer <int32> Generated passphrase length.
policyDefaultAccess	boolean

Responses

Request samples

Payload

Content type

application/json

{"deviceCountLimit": 0,
"expirationDate": "2019-08-24T14:15:22Z",
"expirationOffset": 0,
"expirationType": "SPECIFIED_DATE",
"name": "string",
"passphraseFormat": "MOST_SECURED",
"passphraseLength": 0,
"policyDefaultAccess": true
}

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Remove Policy Set from a DPSK Pool

path Parameters

poolId required	string DPSK passphrase id
policySetId required	string Policy set id

Responses

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Update Policy Set for a DPSK Pool

path Parameters

poolId required	string DPSK passphrase id
policySetId required	string Policy set id

Responses

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

APIs for DPSK Passphrase Management

Delete Passphrase

path Parameters

poolId

required

string

DPSK pool id

Request Body schema:
application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Get Passphrase

path Parameters

poolId

required

string

DPSK pool id

query Parameters

page	integer >= 0 Default: 0 Zero-based page index (0..N)
size	integer >= 1 Default: 20 The size of the page to be returned
sort	Array of strings Sorting criteria in the format: property,(asc\|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

200

Content type

application/json

{"content": [{ }
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Update Specific DPSK Passphrases

Update entities partially with provided attributes. Only the attributes provided in the request body will be updated.

path Parameters

poolId

required

string

DPSK pool id

Request Body schema:
application/json
required

required	object Changes to be applied to the passphrases.
ids required	Array of strings [ 1 .. 2147483647 ] items The passphrase IDs to be changed.

Responses

Request samples

Payload

Content type

application/json

{"changes": {"email": "abc@email.com",
"expirationDate": "2019-08-24T14:15:22Z",
"numberOfDevices": 0,
"passphrase": "stringst",
"phoneNumber": "string",
"revocationReason": "string",
"username": "string",
"vlanId": 0
},
"ids": ["string"
]
}

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Create DPSK Passphrase

path Parameters

poolId

required

string

DPSK pool id

Request Body schema:
application/json
required

email	string [ 0 .. 255 ] characters ^(?:[\w!#$%&’+/=?`{\|}~^-]+(?:\.[\w!#$%&’+/=... The email for passphrase.
expiration	string Enum: "UNLIMITED" "ONE_DAY" "TWO_DAYS" "ONE_WEEK" "TWO_WEEKS" "ONE_MONTH" "SIX_MONTHS" "ONE_YEAR" "TWO_YEARS" The expiration for passphrase.
expirationDate	string <date-time> The expiration for passphrase.
format	string Enum: "MOST_SECURED" "KEYBOARD_FRIENDLY" "NUMBERS_ONLY" The format for passphrase.
identityId	string
length	integer <int32> [ 8 .. 63 ] Passphrase length
mac	string^$\|^([0-9A-Fa-f]{2}[.:-]){5}([0-9A-Fa-f]{2})$... The mac for passphrase.
numberOfDevices	integer <int32> Number of devices. Must be between 1 and 50. Inputs outside this range will be adjusted.
numberOfDevicesType	string Enum: "UNLIMITED" "LIMITED" Number of devices type.
numberOfPassphrases	integer <int32> Passphrase limit.
passphrase	string [ 8 .. 63 ] characters Actual passphrase.
phoneNumber	string The number for passphrase.
username	string The username for passphrase.
vlanId	integer <int32> The VLAN for passphrase.
vxlanId	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"email": "abc@email.com",
"expiration": "UNLIMITED",
"expirationDate": "2019-08-24T14:15:22Z",
"format": "MOST_SECURED",
"identityId": "string",
"length": 8,
"mac": "11:22:33:44:55:66",
"numberOfDevices": 0,
"numberOfDevicesType": "UNLIMITED",
"numberOfPassphrases": 0,
"passphrase": "stringst",
"phoneNumber": "string",
"username": "string",
"vlanId": 0,
"vxlanId": 0
}

Response samples

202
400

Content type

application/json

"string"

Import Passphrase from CSV

path Parameters

poolId

required

string

query Parameters

usernamePrefix

string

Request Body schema: multipart/form-data

file

required

string <binary>

Responses

Response samples

200

Content type

application/json

"string"

Query Passphrases for Specified Pool

path Parameters

poolId

required

string

Request Body schema:
application/json
required

fields	Array of strings
	object (DPSK_API_&_Model_Documentation_DpskPassphraseFilters)
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"email": ["string"
],
"mac": ["string"
],
"networkId": ["string"
],
"passphrase": ["string"
],
"phoneNumber": ["string"
],
"status": ["ACTIVE"
],
"username": ["string"
],
"vlanId": [0
]
},
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200

Content type

application/json

{"data": [{"createdDate": "2019-08-24T14:15:22Z",
"devices": [{"deviceConnectivity": "string",
"devicePassphrase": "string",
"lastConnected": "2019-08-24T14:15:22Z",
"lastConnectedNetwork": "string",
"lastConnectedNetworkId": "string",
"lastConnectedTime": "2019-08-24T14:15:22Z",
"mac": "string",
"online": true
}
],
"email": "abc@email.com",
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isReferenced": true,
"lastModifiedDate": "2019-08-24T14:15:22Z",
"numberOfDevices": 0,
"passphrase": "stringst",
"phoneNumber": "string",
"revocationDate": "2019-08-24T14:15:22Z",
"revocationReason": "string",
"username": "string",
"vlanId": 0
}
],
"fields": ["string"
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

DPSK Passphrase to CSV

path Parameters

poolId

required

string

query Parameters

timezone	string Default: "UTC" If specified, the timezone will be used for date values. Default value is UTC.
date-format	string Default: "dd/MM/yyyy HH:mm" Format will be applied for date values. Default value is "dd/MM/yyyy HH:mm"

Request Body schema:
application/json
required

fields	Array of strings
	object (DPSK_API_&_Model_Documentation_DpskPassphraseFilters)
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"email": ["string"
],
"mac": ["string"
],
"networkId": ["string"
],
"passphrase": ["string"
],
"phoneNumber": ["string"
],
"status": ["ACTIVE"
],
"username": ["string"
],
"vlanId": [0
]
},
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "ASC"
}

Get Specific DPSK Passphrase

path Parameters

poolId required	string DPSK pool id
id required	string DPSK passphrase id

Responses

Response samples

200

Content type

application/json

{"createdDate": "2019-08-24T14:15:22Z",
"devices": [{"deviceConnectivity": "string",
"devicePassphrase": "string",
"lastConnected": "2019-08-24T14:15:22Z",
"lastConnectedNetwork": "string",
"lastConnectedNetworkId": "string",
"lastConnectedTime": "2019-08-24T14:15:22Z",
"mac": "string",
"online": true
}
],
"email": "abc@email.com",
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isReferenced": true,
"lastModifiedDate": "2019-08-24T14:15:22Z",
"numberOfDevices": 0,
"passphrase": "stringst",
"phoneNumber": "string",
"revocationDate": "2019-08-24T14:15:22Z",
"revocationReason": "string",
"username": "string",
"vlanId": 0
}

Update Specific DPSK Passphrase

Update an entity partially with provided attributes. Only the attributes provided in the request body will be updated.

path Parameters

poolId required	string DPSK pool id
id required	string DPSK passphrase id

Request Body schema:
application/json
required

email	string [ 0 .. 255 ] characters ^[\w!#$%&’+/=?`{\|}~^-]+(?:\.[\w!#$%&’+/=?`{... Email associated with passphrase.
expirationDate	string <date-time> Expiration date of passphrase.
numberOfDevices	integer <int32> Number of devices. Must be between 1 and 50. Inputs outside this range will be adjusted.
passphrase	string [ 8 .. 63 ] characters The actual passphrase.
phoneNumber	string Phone associated with passphrase.
revocationReason	string Reason for revocation of passphrase.
username	string Username for the passphrase.
vlanId	integer <int32> VLAN associated with passphrase.

Responses

Request samples

Payload

Content type

application/json

{"email": "abc@email.com",
"expirationDate": "2019-08-24T14:15:22Z",
"numberOfDevices": 0,
"passphrase": "stringst",
"phoneNumber": "string",
"revocationReason": "string",
"username": "string",
"vlanId": 0
}

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Update Specific DPSK Passphrase

path Parameters

poolId required	string DPSK pool id
id required	string DPSK passphrase id

Request Body schema:
application/json
required

email	string [ 0 .. 255 ] characters ^[\w!#$%&’+/=?`{\|}~^-]+(?:\.[\w!#$%&’+/=?`{... Email associated with passphrase.
expirationDate	string <date-time> Expiration date of passphrase.
numberOfDevices	integer <int32> Number of devices. Must be between 1 and 50. Inputs outside this range will be adjusted.
passphrase	string [ 8 .. 63 ] characters The actual passphrase.
phoneNumber	string Phone associated with passphrase.
revocationReason	string Reason for revocation of passphrase.
username	string Username for the passphrase.
vlanId	integer <int32> VLAN associated with passphrase.

Responses

Request samples

Payload

Content type

application/json

{"email": "abc@email.com",
"expirationDate": "2019-08-24T14:15:22Z",
"numberOfDevices": 0,
"passphrase": "stringst",
"phoneNumber": "string",
"revocationReason": "string",
"username": "string",
"vlanId": 0
}

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

APIs for DPSK Passphrase Device Management

Delete Devices Associated with a Specific Passphrase

path Parameters

passphraseId required	string DPSK passphrase ID
poolId required	string DPSK pool ID

Request Body schema:
application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["00:11:22:33:44:55",
"00:11:22:33:44:56"
]

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Get Devices for a Specific Passphrase

path Parameters

passphraseId required	string DPSK passphrase id
poolId required	string DPSK pool id

Responses

Response samples

200

Content type

application/json

{"deviceConnectivity": "string",
"devicePassphrase": "string",
"lastConnected": "2019-08-24T14:15:22Z",
"lastConnectedNetwork": "string",
"lastConnectedNetworkId": "string",
"lastConnectedTime": "2019-08-24T14:15:22Z",
"mac": "string",
"online": true
}

Create Devices for a Specific Passphrase

path Parameters

passphraseId required	string DPSK passphrase ID
poolId required	string DPSK pool ID

Request Body schema:
application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["00:11:22:33:44:55",
"00:11:22:33:44:56"
]

Response samples

202

Content type

application/json

{"requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

SmartEdge SD-LAN Service

Manage the SD-LAN services for SmartEdge devices

Create SD-LAN Service

Request Body schema:
application/json
required

edgeClusterId required	string The edge cluster identifier of the SD-LAN service.
name required	string [ 2 .. 32 ] characters Name of the SD-LAN service.
tunnelProfileId required	string [ 0 .. 255 ] characters The tunnel profile identifier of the SD-LAN service.

Responses

Request samples

Payload

Content type

application/json

{"edgeClusterId": "string",
"name": "string",
"tunnelProfileId": "string"
}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Delete SD-LAN Service

path Parameters

sdLanServiceId

required

string

The ID of SD-LAN Service.

Responses

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Get SD-LAN Service

path Parameters

sdLanServiceId

required

string

The ID of SD-LAN Service.

Responses

Response samples

200

Content type

application/json

{"edgeClusterId": "string",
"id": "string",
"name": "string",
"requestId": "string",
"tunnelProfileId": "string"
}

Partial SD-LAN Service

path Parameters

sdLanServiceId

required

string

The ID of SD-LAN Service.

Request Body schema:
application/json
required

edgeClusterId required	string The edge cluster identifier of the SD-LAN service.
name required	string [ 2 .. 32 ] characters Name of the SD-LAN service.
tunnelProfileId required	string [ 0 .. 255 ] characters The tunnel profile identifier of the SD-LAN service.

Responses

Request samples

Payload

Content type

application/json

{"edgeClusterId": "string",
"name": "string",
"tunnelProfileId": "string"
}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Update SD-LAN Service

path Parameters

sdLanServiceId

required

string

The ID of SD-LAN Service.

Request Body schema:
application/json
required

edgeClusterId required	string The edge cluster identifier of the SD-LAN service.
name required	string [ 2 .. 32 ] characters Name of the SD-LAN service.
tunnelProfileId required	string [ 0 .. 255 ] characters The tunnel profile identifier of the SD-LAN service.

Responses

Request samples

Payload

Content type

application/json

{"edgeClusterId": "string",
"name": "string",
"tunnelProfileId": "string"
}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Get Guest Settings

Get the guest settings in SD-LAN service.

path Parameters

sdLanServiceId

required

string

The ID of SD-LAN Service.

Responses

Response samples

202

Content type

application/json

{"isGuestTunnelEnabled": true
}

Update Guest Settings

Update guest settings in SD-LAN service.

path Parameters

sdLanServiceId

required

string

The ID of SD-LAN Service.

Request Body schema:
application/json
required

isGuestTunnelEnabled

boolean

Set true if guest tunnel is needed.

Responses

Request samples

Payload

Content type

application/json

{"isGuestTunnelEnabled": true
}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Deactivate Guest Tunnel

Deactivate the guest tunnel in SD-LAN service.

path Parameters

sdLanServiceId required	string The ID of SD-LAN Service.
tunnelProfileId required	string The ID of the guest tunnel profile.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/edgeSdLanServices/{sdLanServiceId}/guestSettings/tunnelProfiles/{tunnelProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/edgeSdLanServices/{sdLanServiceId}/guestSettings/tunnelProfiles/{tunnelProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/edgeSdLanServices/{sdLanServiceId}/guestSettings/tunnelProfiles/{tunnelProfileId}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Activate Guest Tunnel

Activate the guest tunnel in SD-LAN service.

path Parameters

sdLanServiceId required	string The ID of SD-LAN Service.
tunnelProfileId required	string The ID of the guest tunnel profile.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/edgeSdLanServices/{sdLanServiceId}/guestSettings/tunnelProfiles/{tunnelProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/edgeSdLanServices/{sdLanServiceId}/guestSettings/tunnelProfiles/{tunnelProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/edgeSdLanServices/{sdLanServiceId}/guestSettings/tunnelProfiles/{tunnelProfileId}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Deactivate Guest SmartEdge Cluster

Deactivate the guest SmartEdge cluster in SD-LAN service.

path Parameters

sdLanServiceId required	string The ID of SD-LAN Service.
venueId required	string The ID of Venue.
edgeClusterId required	string The ID of SmartEdge Cluster.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/edgeSdLanServices/{sdLanServiceId}/guestSettings/venues/{venueId}/edgeClusters/{edgeClusterId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/edgeSdLanServices/{sdLanServiceId}/guestSettings/venues/{venueId}/edgeClusters/{edgeClusterId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/edgeSdLanServices/{sdLanServiceId}/guestSettings/venues/{venueId}/edgeClusters/{edgeClusterId}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Activate Guest SmartEdge Cluster

Activate the guest SmartEdge cluster in SD-LAN service.

path Parameters

sdLanServiceId required	string The ID of SD-LAN Service.
venueId required	string The ID of Venue.
edgeClusterId required	string The ID of SmartEdge Cluster.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/edgeSdLanServices/{sdLanServiceId}/guestSettings/venues/{venueId}/edgeClusters/{edgeClusterId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/edgeSdLanServices/{sdLanServiceId}/guestSettings/venues/{venueId}/edgeClusters/{edgeClusterId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/edgeSdLanServices/{sdLanServiceId}/guestSettings/venues/{venueId}/edgeClusters/{edgeClusterId}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Deactivate Network in SD-LAN

Deactivate the network in SD-LAN service.

path Parameters

sdLanServiceId required	string The ID of SD-LAN Service.
wifiNetworkId required	string The ID of the tunneled network.

Responses

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Activate Network in SD-LAN

Activate the network in SD-LAN service.

path Parameters

sdLanServiceId required	string The ID of SD-LAN Service.
wifiNetworkId required	string The ID of the tunneled network.

Request Body schema:
application/json
required

isGuestTunnelUtilized

boolean

Is this network tunneled to guest edge.

Responses

Request samples

Payload

Content type

application/json

{"isGuestTunnelUtilized": true
}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

SmartEdge Device Management

Manage SmartEdge devices

Add Device

Add a new device.

path Parameters

venueId required	string
clusterId required	string

Request Body schema:
application/json
required

description	string The description of the device.
name required	string [ 1 .. 64 ] characters The name of the device.
serialNumber required	string The serial number of the device.

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"serialNumber": "string"
}

Response samples

201

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Delete Device

Delete the device by the serial number.

path Parameters

venueId required	string
clusterId required	string
serialNumber required	string

Responses

Response samples

200

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Get Device

Get device by the serial number.

path Parameters

venueId required	string
clusterId required	string
serialNumber required	string

Responses

Response samples

200

Content type

application/json

{"description": "string",
"name": "string"
}

Update Device

Patch the device configuration.

path Parameters

venueId required	string
clusterId required	string
serialNumber required	string

Request Body schema:
application/json
required

description	string The description of the device.
name required	string [ 1 .. 64 ] characters The name of the device.
otpState	string Value: "RENEW"

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"otpState": "RENEW"
}

Response samples

200

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

SmartEdge LAG Sub-Interface

Manage the sub-interface of a LAG

Create Sub-Interface

Create a sub-interfaces of a LAG.

path Parameters

venueId required	string
edgeClusterId required	string
serialNumber required	string Example: 966B4AF92A7B5711EDB27B000C29D14F2E The SN of the Edge device
lagId required	string Example: 0 ID of the LAG

Request Body schema:
application/json
required

ip	string The IP address to be assigned to the port.
ipMode	string Default: "DHCP" Enum: "DHCP" "STATIC"
portType required	string Enum: "WAN" "LAN" "CLUSTER" "UNCONFIGURED"
subnet	string The IP sub-mask to be assigned to the port.
vlan required	integer <int32> >= 1 The virtual LAN ID of the sub-interface.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces

Request samples

Payload

Content type

application/json

{"ip": "string",
"ipMode": "DHCP",
"portType": "WAN",
"subnet": "string",
"vlan": 1
}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Delete Sub-Interface

Delete a sub-interfaces of a LAG.

path Parameters

venueId required	string
edgeClusterId required	string
serialNumber required	string Example: 966B4AF92A7B5711EDB27B000C29D14F2E The SN of the Edge device
lagId required	string Example: 0 ID of the LAG
subInterfaceId required	string

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Get Sub-Interface

Get the sub-interface of a LAG.

path Parameters

venueId required	string
edgeClusterId required	string
serialNumber required	string Example: 966B4AF92A7B5711EDB27B000C29D14F2E The SN of the Edge device
lagId required	string Example: 0 ID of the LAG
subInterfaceId required	string

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

Response samples

200

Content type

application/json

{"id": "string",
"ip": "string",
"ipMode": "DHCP",
"portType": "WAN",
"subnet": "string",
"vlan": 1
}

Partial Update Sub-Interface

Partial update a sub-interface of a LAG.

path Parameters

venueId required	string
edgeClusterId required	string
serialNumber required	string Example: 966B4AF92A7B5711EDB27B000C29D14F2E The SN of the Edge device
lagId required	string Example: 0 ID of the LAG
subInterfaceId required	string

Request Body schema:
application/json
required

ip	string The IP address to be assigned to the port.
ipMode	string Default: "DHCP" Enum: "DHCP" "STATIC"
portType required	string Enum: "WAN" "LAN" "CLUSTER" "UNCONFIGURED"
subnet	string The IP sub-mask to be assigned to the port.
vlan required	integer <int32> >= 1 The virtual LAN ID of the sub-interface.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

Request samples

Payload

Content type

application/json

{"ip": "string",
"ipMode": "DHCP",
"portType": "WAN",
"subnet": "string",
"vlan": 1
}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

SmartEdge Port Configuration

Manage the port of a SmartEdge

Get Physical Port Configuration

Get the physical port configuration.

path Parameters

venueId required	string
clusterId required	string
serialNumber required	string Example: 966B4AF92A7B5711EDB27B000C29D14F2E The SN of the Edge device

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/portConfigs

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/portConfigs

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/portConfigs

Response samples

200

Content type

application/json

{"ports": [{"corePortEnabled": false,
"enabled": true,
"gateway": "string",
"id": "string",
"interfaceName": "string",
"ip": "string",
"ipMode": "DHCP",
"mac": "string",
"maxSpeedCapa": 0,
"name": "string",
"natEnabled": false,
"portType": "WAN",
"reportIp": "string",
"reportSubnet": "string",
"subnet": "string"
}
]
}

Update Physical Port Configuration

Patch the physical port configuration.

path Parameters

venueId required	string
clusterId required	string
serialNumber required	string Example: 966B4AF92A7B5711EDB27B000C29D14F2E The SN of the Edge device

Request Body schema:
application/json
required

Array of objects (Port configuration)

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/portConfigs

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/portConfigs

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/portConfigs

Request samples

Payload

Content type

application/json

{"ports": [{"corePortEnabled": false,
"enabled": true,
"gateway": "string",
"id": "string",
"ip": "string",
"ipMode": "DHCP",
"mac": "string",
"name": "string",
"natEnabled": false,
"portType": "WAN",
"subnet": "string"
}
]
}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

SmartEdge LAG Configuration

Manage the Link Aggregation Group for SmartEdge devices

Create Link Aggregation Group

Create the link aggregation groups.

path Parameters

venueId required	string
edgeClusterId required	string
serialNumber required	string

Request Body schema:
application/json
required

corePortEnabled	boolean Default: false Whether to mark this port as a core port.
description	string [ 0 .. 63 ] characters The description of the LAG.
gateway	string The gateway address of the port.
id required	integer <int32> [ 0 .. 3 ] The ID of the LAG, support from 0 to 3.
ip	string The IP address to be assigned to the port.
ipMode	string Default: "DHCP" Enum: "DHCP" "STATIC"
lacpMode required	string Enum: "ACTIVE" "PASSIVE"
lacpTimeout required	string Enum: "SHORT" "LONG"
lagEnabled required	boolean Whether to enable the LAG.
	Array of objects (SmartEdge_API_&_Model_Documentation_LagMemberDto)
natEnabled	boolean Default: false Whether to enable the network address translation on the wan port.
portType required	string Enum: "WAN" "LAN" "CLUSTER" "UNCONFIGURED"
subnet	string The IP sub-mask to be assigned to the port.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags

Request samples

Payload

Content type

application/json

{"corePortEnabled": false,
"description": "string",
"gateway": "string",
"id": 3,
"ip": "string",
"ipMode": "DHCP",
"lacpMode": "ACTIVE",
"lacpTimeout": "SHORT",
"lagEnabled": true,
"lagMembers": [{"portEnabled": true,
"portId": "string"
}
],
"natEnabled": false,
"portType": "WAN",
"subnet": "string"
}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Delete Link Aggregation Group

Delete the link aggregation group by unique identifier.

path Parameters

venueId required	string
edgeClusterId required	string
serialNumber required	string
lagId required	integer <int32>

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Get Link Aggregation Group

Get the link aggregation group by unique identifier.

path Parameters

venueId required	string
edgeClusterId required	string
serialNumber required	string
lagId required	integer <int32>

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

Response samples

200

Content type

application/json

{"corePortEnabled": false,
"description": "string",
"gateway": "string",
"id": 3,
"ip": "string",
"ipMode": "DHCP",
"lacpMode": "ACTIVE",
"lacpTimeout": "SHORT",
"lagEnabled": true,
"lagMembers": [{"portEnabled": true,
"portId": "string"
}
],
"lagType": "STATIC",
"natEnabled": false,
"portType": "WAN",
"reportIp": "string",
"reportSubnet": "string",
"subnet": "string"
}

Partial Update Link Aggregation Group

Partial update of the link aggregation group by unique identifier.

path Parameters

venueId required	string
edgeClusterId required	string
serialNumber required	string
lagId required	integer <int32>

Request Body schema:
application/json
required

corePortEnabled	boolean Default: false Whether to mark this port as a core port.
description	string [ 0 .. 63 ] characters The description of the LAG.
gateway	string The gateway address of the port.
ip	string The IP address to be assigned to the port.
ipMode	string Default: "DHCP" Enum: "DHCP" "STATIC"
lacpMode required	string Enum: "ACTIVE" "PASSIVE"
lacpTimeout required	string Enum: "SHORT" "LONG"
lagEnabled required	boolean Whether to enable the LAG.
	Array of objects (SmartEdge_API_&_Model_Documentation_LagMemberDto)
natEnabled	boolean Default: false Whether to enable the network address translation on the wan port.
portType required	string Enum: "WAN" "LAN" "CLUSTER" "UNCONFIGURED"
subnet	string The IP sub-mask to be assigned to the port.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

Request samples

Payload

Content type

application/json

{"corePortEnabled": false,
"description": "string",
"gateway": "string",
"ip": "string",
"ipMode": "DHCP",
"lacpMode": "ACTIVE",
"lacpTimeout": "SHORT",
"lagEnabled": true,
"lagMembers": [{"portEnabled": true,
"portId": "string"
}
],
"natEnabled": false,
"portType": "WAN",
"subnet": "string"
}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Update Link Aggregation Group

Updates the link aggregation group by unique identifier.

path Parameters

venueId required	string
edgeClusterId required	string
serialNumber required	string
lagId required	integer <int32>

Request Body schema:
application/json
required

corePortEnabled	boolean Default: false Whether to mark this port as a core port.
description	string [ 0 .. 63 ] characters The description of the LAG.
gateway	string The gateway address of the port.
ip	string The IP address to be assigned to the port.
ipMode	string Default: "DHCP" Enum: "DHCP" "STATIC"
lacpMode required	string Enum: "ACTIVE" "PASSIVE"
lacpTimeout required	string Enum: "SHORT" "LONG"
lagEnabled required	boolean Whether to enable the LAG.
	Array of objects (SmartEdge_API_&_Model_Documentation_LagMemberDto)
natEnabled	boolean Default: false Whether to enable the network address translation on the wan port.
portType required	string Enum: "WAN" "LAN" "CLUSTER" "UNCONFIGURED"
subnet	string The IP sub-mask to be assigned to the port.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

Request samples

Payload

Content type

application/json

{"corePortEnabled": false,
"description": "string",
"gateway": "string",
"ip": "string",
"ipMode": "DHCP",
"lacpMode": "ACTIVE",
"lacpTimeout": "SHORT",
"lagEnabled": true,
"lagMembers": [{"portEnabled": true,
"portId": "string"
}
],
"natEnabled": false,
"portType": "WAN",
"subnet": "string"
}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

SmartEdge Sub-Interface Configuration

Manage the sub-interface of a physical port

Get Sub-Interfaces

Get sub-interfaces of a physical port.

path Parameters

venueId required	string
clusterId required	string
serialNumber required	string Example: 966B4AF92A7B5711EDB27B000C29D14F2E The SN of the Edge device
portId required	string Example: 3f21d371-35b6-4288-a70b-2dd6b83e7419 The ID of the physical port

query Parameters

page	integer <int32> Default: 1
pageSize	integer <int32> Default: 20

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces

Response samples

200

Content type

application/vnd.ruckus.v1+json

{"content": [{"id": "string",
"ip": "string",
"ipMode": "DHCP",
"portType": "WAN",
"subnet": "string",
"vlan": 0
}
],
"page": 0,
"pageSize": 0,
"totalCount": 0
}

Create Multiple Sub-Interfaces

Create multiple sub-interfaces of a physical port from CSV file.

path Parameters

venueId required	string
clusterId required	string
serialNumber required	string Example: 966B4AF92A7B5711EDB27B000C29D14F2E The SN of the Edge device
portId required	string Example: 3f21d371-35b6-4288-a70b-2dd6b83e7419 The ID of the physical port

Request Body schema:
application/json
required

ip	string The IP address to be assigned to the port.
ipMode	string Default: "DHCP" Enum: "DHCP" "STATIC"
portType required	string Enum: "WAN" "LAN" "CLUSTER" "UNCONFIGURED"
subnet	string The IP sub-mask to be assigned to the port.
vlan required	integer <int32> The virtual LAN ID of the sub-interface.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces

Request samples

Payload

Content type

application/json

{"ip": "string",
"ipMode": "DHCP",
"portType": "WAN",
"subnet": "string",
"vlan": 0
}

Response samples

202

Content type

application/vnd.ruckus.v1+json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Delete Sub-Interface

Delete a sub-interfaces of a physical port.

path Parameters

venueId required	string
clusterId required	string
serialNumber required	string Example: 966B4AF92A7B5711EDB27B000C29D14F2E The SN of the Edge device
portId required	string Example: 3f21d371-35b6-4288-a70b-2dd6b83e7419 The ID of the physical port
subInterfaceId required	string

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces/{subInterfaceId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces/{subInterfaceId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces/{subInterfaceId}

Response samples

202

Content type

application/vnd.ruckus.v1+json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Update Sub-Interface

Update a sub-interface of a physical port.

path Parameters

venueId required	string
clusterId required	string
serialNumber required	string Example: 966B4AF92A7B5711EDB27B000C29D14F2E The SN of the Edge device
portId required	string Example: 3f21d371-35b6-4288-a70b-2dd6b83e7419 The ID of the physical port
subInterfaceId required	string

Request Body schema: application/vnd.ruckus.v1+json
required

ip	string The IP address to be assigned to the port.
ipMode	string Default: "DHCP" Enum: "DHCP" "STATIC"
portType required	string Enum: "WAN" "LAN" "CLUSTER" "UNCONFIGURED"
subnet	string The IP sub-mask to be assigned to the port.
vlan required	integer <int32> The virtual LAN ID of the sub-interface.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces/{subInterfaceId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces/{subInterfaceId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces/{subInterfaceId}

Request samples

Payload

Content type

application/vnd.ruckus.v1+json

{"ip": "string",
"ipMode": "DHCP",
"portType": "WAN",
"subnet": "string",
"vlan": 0
}

Response samples

202

Content type

application/vnd.ruckus.v1+json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

SmartEdge DNS Configuration

Manage the DNS server for a SmartEdge

Get DNS Configuration

Get the DNS configuration.

path Parameters

venueId required	string
clusterId required	string
serialNumber required	string

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/dnsServers

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/dnsServers

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/dnsServers

Response samples

200

Content type

application/json

{"primary": "string",
"secondary": "string"
}

Update DNS Configuration

Patch the DNS configuration.

path Parameters

venueId required	string
clusterId required	string
serialNumber required	string

Request Body schema:
application/json
required

primary	string
secondary	string

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/dnsServers

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/dnsServers

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/dnsServers

Request samples

Payload

Content type

application/json

{"primary": "string",
"secondary": "string"
}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

SmartEdge Static Route Configuration

Manage the static routes for a SmartEdge

Get Static Route Configuration

Get static routes configuration.

path Parameters

venueId required	string
clusterId required	string
serialNumber required	string Example: 966B4AF92A7B5711EDB27B000C29D14F2E The SN of the Edge device

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/staticRouteConfigs

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/staticRouteConfigs

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/staticRouteConfigs

Response samples

200

Content type

application/json

{"routes": [{"destIp": "string",
"destSubnet": "string",
"id": "string",
"nextHop": "string"
}
]
}

Update Static Route Configuration

Patch static route configuration.

path Parameters

venueId required	string
clusterId required	string
serialNumber required	string Example: 966B4AF92A7B5711EDB27B000C29D14F2E The SN of the Edge device

Request Body schema:
application/json
required

Array of objects (SmartEdge_API_&_Model_Documentation_StaticRouteDto)

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/staticRouteConfigs

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/staticRouteConfigs

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/staticRouteConfigs

Request samples

Payload

Content type

application/json

{"routes": [{"destIp": "string",
"destSubnet": "string",
"id": "string",
"nextHop": "string"
}
]
}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

SmartEdge Troubleshooting

Manage troubleshooting operations for the devices

Trigger EDGE Action

Trigger edge action.

path Parameters

venueId required	string
clusterId required	string
serialNumber required	string The serial number of the EDGE.

Request Body schema: application/json
required

action required	string
targetHost	string(^((22[0-3]\|2[0-1][0-9]\|1[0-9][0-9]\|[1-9][0-9...

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/hostDetails

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/hostDetails

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/hostDetails

Request samples

Payload

Content type

application/json

{"action": "string",
"targetHost": "string"
}

Response samples

200

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

SmartEdge Cluster Configuration

Manage the SmartEdge cluster

Get SmartEdge Clusters

Get a list of SmartEdge clusters.

path Parameters

venueId

required

string

query Parameters

page	integer <int32> >= 1 Default: 1 Page index
pageSize	integer <int32> Default: 20 The size of the page to be returned

Responses

Response samples

200

Content type

application/json

{"content": [{"description": "string",
"highAvailabilityMode": "ACTIVE_STANDBY",
"id": "string",
"name": "string",
"smartEdges": [{"description": "string",
"name": "string",
"serialNumber": "string"
}
],
"virtualIpSettings": {"virtualIps": [{"ports": [{"portName": "string",
"serialNumber": "string"
}
],
"timeoutSeconds": 3,
"virtualIp": "string"
}
]
}
}
],
"paging": {"page": 0,
"pageSize": 0,
"totalCount": 0
}
}

Create SmartEdge Cluster

Create a SmartEdge cluster.

path Parameters

venueId

required

string

Request Body schema:
application/json
required

description	string [ 0 .. 255 ] characters The description of the cluster.
highAvailabilityMode	string Enum: "ACTIVE_STANDBY" "ACTIVE_ACTIVE" The high availability mode.
name	string [ 1 .. 64 ] characters The name of the cluster.
	Array of objects (SmartEdge Cluster Member Configuration) A list of SmartEdge devices to be in the cluster.

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"highAvailabilityMode": "ACTIVE_STANDBY",
"name": "string",
"smartEdges": [{"description": "string",
"name": "string",
"serialNumber": "string"
}
]
}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Delete a SmartEdge Cluster

Delete a SmartEdge cluster.

path Parameters

venueId required	string
clusterId required	string

Responses

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Get SmartEdge Cluster

Get the SmartEdge cluster by unique identifier.

path Parameters

venueId required	string
clusterId required	string

Responses

Response samples

200

Content type

application/json

{"description": "string",
"highAvailabilityMode": "ACTIVE_STANDBY",
"id": "string",
"name": "string",
"smartEdges": [{"description": "string",
"name": "string",
"serialNumber": "string"
}
],
"virtualIpSettings": {"virtualIps": [{"ports": [{"portName": "string",
"serialNumber": "string"
}
],
"timeoutSeconds": 3,
"virtualIp": "string"
}
]
}
}

Update SmartEdge Cluster

Update SmartEdge cluster.

path Parameters

venueId required	string
clusterId required	string

Request Body schema:
application/json
required

description	string [ 0 .. 255 ] characters The description of the cluster.
name	string [ 1 .. 64 ] characters The name of the cluster.
	Array of objects (SmartEdge Cluster Member Configuration) A list of SmartEdge devices to be in the cluster.
	object (Cluster Virtual IP Configuration) The virtual IP settings of the cluster.

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"smartEdges": [{"description": "string",
"name": "string",
"serialNumber": "string"
}
],
"virtualIpSettings": {"virtualIps": [{"ports": [{"portName": "string",
"serialNumber": "string"
}
],
"timeoutSeconds": 3,
"virtualIp": "string"
}
]
}
}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Get SmartEdge Cluster Network

Get SmartEdge cluster network settings.

path Parameters

venueId required	string
clusterId required	string

Responses

Response samples

200

Content type

application/json

{"highAvailabilitySettings": {"loadDistribution": "RANDOM"
},
"lagSettings": [{"lags": [{"corePortEnabled": false,
"description": "string",
"gateway": "string",
"id": 3,
"ip": "string",
"ipMode": "DHCP",
"lacpMode": "ACTIVE",
"lacpTimeout": "SHORT",
"lagEnabled": true,
"lagMembers": [{"portEnabled": true,
"portId": "string"
}
],
"lagType": "STATIC",
"natEnabled": false,
"portType": "WAN",
"reportIp": "string",
"reportSubnet": "string",
"subnet": "string"
}
],
"serialNumber": "string"
}
],
"portSettings": [{"ports": [{"corePortEnabled": false,
"enabled": true,
"gateway": "string",
"id": "string",
"interfaceName": "string",
"ip": "string",
"ipMode": "DHCP",
"mac": "string",
"maxSpeedCapa": 0,
"name": "string",
"natEnabled": false,
"portType": "WAN",
"reportIp": "string",
"reportSubnet": "string",
"subnet": "string"
}
],
"serialNumber": "string"
}
],
"virtualIpSettings": [{"ports": [{"portName": "string",
"serialNumber": "string"
}
],
"timeoutSeconds": 3,
"virtualIp": "string"
}
]
}

Update SmartEdge Cluster Network

Update SmartEdge cluster network settings.

path Parameters

venueId required	string
clusterId required	string

Request Body schema:
application/json
required

	object (SmartEdge Cluster High Availability Settings) High availability settings for active-active clusters.
	Array of objects (SmartEdge Link Aggregation Group Settings) [ 1 .. 4 ] items
	Array of objects (SmartEdge Port Settings) [ 0 .. 4 ] items
	Array of objects (Virtual IP Configuration) [ 0 .. 2 ] items List of cluster virtual IP settings for active-standby clusters.

Responses

Request samples

Payload

Content type

application/json

{"highAvailabilitySettings": {"loadDistribution": "RANDOM"
},
"lagSettings": [{"lags": [{"corePortEnabled": false,
"description": "string",
"gateway": "string",
"id": 3,
"ip": "string",
"ipMode": "DHCP",
"lacpMode": "ACTIVE",
"lacpTimeout": "SHORT",
"lagEnabled": true,
"lagMembers": [{"portEnabled": true,
"portId": "string"
}
],
"natEnabled": false,
"portType": "WAN",
"subnet": "string"
}
],
"serialNumber": "string"
}
],
"portSettings": [{"ports": [{"corePortEnabled": false,
"enabled": true,
"gateway": "string",
"id": "string",
"ip": "string",
"ipMode": "DHCP",
"mac": "string",
"name": "string",
"natEnabled": false,
"portType": "WAN",
"subnet": "string"
}
],
"serialNumber": "string"
}
],
"virtualIpSettings": [{"ports": [{"portName": "string",
"serialNumber": "string"
}
],
"timeoutSeconds": 3,
"virtualIp": "string"
}
]
}

Response samples

202

Content type

application/json

{"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"requestId": "string",
"response": { }
}

Entitlement

Endpoints for Managing Entitlements

Get Banners Deprecated

Retrieve entitlement banner data. Banners provide information about entitlements that are either near their expiry or have expired.Please note that this API will be retired on 4/2024 and will be fully removed no earlier than 10/2024. For updated functionality, refer to '/entitlements/banners/query'.

query Parameters

type	string Enum: "UNASSIGNED_DEVICE_TYPE" "WIFI" "LTE" "SWITCH" "ANALYTICS" "RWG" "EDGE" "VIRTUAL_EDGE" "APSW" "EDGE_SECS" "EDGE_SECL" Filter by device type (Optional). If device agnostic sku feature is enabled, all device types will be treated as APSW except ANALYTICS.
licenseType	string Enum: "UNKNOWN" "APSW" "URLF" "EDGE_SECS" "EDGE_SECL" Filter by license type (optional)

Responses

Response samples

200

Content type

application/json

[{"alm": true,
"almExtraInfo": {"activeApCount": 0,
"activeEdgeCount": 0,
"activeSwitchCount": 0,
"licenseType": "UNKNOWN",
"remainingQuantity": 0,
"soEntQuantity": 0
},
"deviceCount": 0,
"deviceSubType": "string",
"deviceType": "UNASSIGNED_DEVICE_TYPE",
"effectDate": "2019-08-24T14:15:22Z",
"effectDays": 0,
"licenseType": "UNKNOWN",
"multipleLicense": true,
"totalActiveDevices": 0,
"totalRALicense": 0,
"type": "INITIAL"
}
]

Get Entitlements Deprecated

Get the list of device entitlements.Please note that this API will be retired on 04/2024 and will be fully removed no earlier than 10/2024. For updated functionality, refer to '/entitlements/query'

query Parameters

type	string Enum: "UNASSIGNED_DEVICE_TYPE" "WIFI" "LTE" "SWITCH" "ANALYTICS" "RWG" "EDGE" "VIRTUAL_EDGE" "APSW" "EDGE_SECS" "EDGE_SECL" Filter by device type (optional). If device agnostic sku feature is enabled, all device types will be treated as APSW except ANALYTICS.
licenseType	string Enum: "UNKNOWN" "APSW" "URLF" "EDGE_SECS" "EDGE_SECL" Filter by license type (optional)

Responses

Response samples

200
404
417

Content type

application/json

[{"alm": true,
"almActivationId": "string",
"almLicenseType": "UNKNOWN",
"almSoEntQuantity": 0,
"almUsedQuantity": 0,
"assignedLicense": true,
"createdDate": "2019-08-24T14:15:22Z",
"deviceSubType": "string",
"deviceType": "UNASSIGNED_DEVICE_TYPE",
"effectiveDate": "2019-08-24T14:15:22Z",
"emailStage": "string",
"expirationDate": "2019-08-24T14:15:22Z",
"extendedLicensesAssignment": true,
"externalId": "string",
"graceEndDate": "2019-08-24T14:15:22Z",
"historical": true,
"id": "string",
"licenseDesc": "string",
"licenseName": "string",
"parentId": "string",
"quantity": 0,
"r1Sku": true,
"sku": "string",
"tempLicense": true,
"updatedDate": "2019-08-24T14:15:22Z"
}
]

Update Entitlements

Sync entitlements.

Request Body schema:
application/json
required

status	string
usageType	string

Responses

Request samples

Payload

Content type

application/json

{"status": "string",
"usageType": "string"
}

Response samples

202
404
417
500

Content type

application/json

{"desc": "string",
"link": "http://example.com",
"requestId": "string"
}

Get Entitlements Banners

Retrieve entitlement banner data. Banners provide information about entitlements that are either near their expiry or have expired.

Request Body schema:
application/json
required

object (Manage_Entitlements_API_Filters)

Responses

Request samples

Payload

Content type

application/json

{"filters": {"licenseType": ["string"
],
"usageType": "string"
}
}

Response samples

200
404
500

Content type

application/json

{"data": [{"effectDate": "string",
"effectiveDays": 0,
"licenseCount": 0,
"licenseType": "string",
"multipleLicense": true,
"type": "string",
"usageType": "string"
}
]
}

Get Compliance

Retrieve entitlement compliance data.

Request Body schema:
application/json
required

object (Manage_Entitlements_API_LicenseComplianceFilter)

Responses

Request samples

Payload

Content type

application/json

{"filters": {"complianceType": "SELF",
"licenseType": ["string"
]
}
}

Response samples

200
404
500

Content type

application/json

{"compliances": [{"licenseType": "UNKNOWN",
"mspEcSummary": {"deviceCompliances": [{"deviceType": "UNASSIGNED_DEVICE_TYPE",
"installedDeviceCount": 0,
"usedLicenseCount": 0
}
],
"licenseGap": 0,
"licenseType": "UNKNOWN",
"licensesUsed": 0,
"nextPaidExpirationDate": "2019-08-24",
"nextTotalPaidExpiringLicenseCount": 0,
"nextTotalTrialExpiringLicenseCount": 0,
"nextTrialExpirationDate": "2019-08-24",
"tenantId": "string",
"tenantName": "string",
"totalActivePaidAssignedLicenseCount": 0,
"totalActivePaidLicenseCount": 0,
"totalActiveTrialAssignedLicenseCount": 0,
"totalActiveTrialLicenseCount": 0
},
"self": {"deviceCompliances": [{"deviceType": "UNASSIGNED_DEVICE_TYPE",
"installedDeviceCount": 0,
"usedLicenseCount": 0
}
],
"licenseGap": 0,
"licenseType": "UNKNOWN",
"licensesUsed": 0,
"nextPaidExpirationDate": "2019-08-24",
"nextTotalPaidExpiringLicenseCount": 0,
"nextTotalTrialExpiringLicenseCount": 0,
"nextTrialExpirationDate": "2019-08-24",
"tenantId": "string",
"tenantName": "string",
"totalActivePaidAssignedLicenseCount": 0,
"totalActivePaidLicenseCount": 0,
"totalActiveTrialAssignedLicenseCount": 0,
"totalActiveTrialLicenseCount": 0
}
}
]
}

Get Entitlements

Retrieve all purchased entitlements.

query Parameters

excludeContent

boolean

Request Body schema:
application/json
required

defaultPageSize	integer <int32>
fields	Array of strings unique
	object (Manage_Entitlements_API_DynamicQueryPayloadFilterDto) The query filters
page	integer <int32>
pageSize	integer <int32>
sortField	string
sortOrder	string

Responses

Request samples

Payload

Content type

application/json

{"defaultPageSize": 0,
"fields": ["string"
],
"filters": {"isAssignedLicense": false,
"isTrial": false,
"licenseType": ["APSW"
],
"status": ["VALID"
],
"usageType": "Self"
},
"page": 0,
"pageSize": 0,
"sortField": "string",
"sortOrder": "string"
}

Response samples

200
404
417
500

Content type

application/json

{"data": [{ }
],
"errors": [{"error": {"code": "string",
"message": "string"
},
"requestId": "string"
}
],
"fields": ["string"
],
"objectId": "string",
"page": 0,
"pageSize": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Entitlement Summaries Deprecated

Get summaries of the device entitlements.Please note that this API will be retired on 4/2024 and will be fully removed no earlier than 10/2024. For updated functionality, refer to '/entitlements/utilizations/query'.

query Parameters

refresh	boolean
type	string Enum: "UNASSIGNED_DEVICE_TYPE" "WIFI" "LTE" "SWITCH" "ANALYTICS" "RWG" "EDGE" "VIRTUAL_EDGE" "APSW" "EDGE_SECS" "EDGE_SECL" Filter by device type (optional). If device agnostic sku feature is enabled, all device types will be treated as APSW except ANALYTICS.
licenseType	string Enum: "UNKNOWN" "APSW" "URLF" "EDGE_SECS" "EDGE_SECL" Filter by license type (optional)

Responses

Response samples

200
202
404
417

Content type

application/json

{"banners": [{"alm": true,
"almExtraInfo": {"activeApCount": 0,
"activeEdgeCount": 0,
"activeSwitchCount": 0,
"licenseType": "UNKNOWN",
"remainingQuantity": 0,
"soEntQuantity": 0
},
"deviceCount": 0,
"deviceSubType": "string",
"deviceType": "UNASSIGNED_DEVICE_TYPE",
"effectDate": "2019-08-24T14:15:22Z",
"effectDays": 0,
"licenseType": "UNKNOWN",
"multipleLicense": true,
"totalActiveDevices": 0,
"totalRALicense": 0,
"type": "INITIAL"
}
],
"entitlements": [{"alm": true,
"almActivationId": "string",
"almLicenseType": "UNKNOWN",
"almSoEntQuantity": 0,
"almUsedQuantity": 0,
"assignedLicense": true,
"createdDate": "2019-08-24T14:15:22Z",
"deviceSubType": "string",
"deviceType": "UNASSIGNED_DEVICE_TYPE",
"effectiveDate": "2019-08-24T14:15:22Z",
"emailStage": "string",
"expirationDate": "2019-08-24T14:15:22Z",
"extendedLicensesAssignment": true,
"externalId": "string",
"graceEndDate": "2019-08-24T14:15:22Z",
"historical": true,
"id": "string",
"licenseDesc": "string",
"licenseName": "string",
"parentId": "string",
"quantity": 0,
"r1Sku": true,
"sku": "string",
"tempLicense": true,
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"summary": [{"alm": true,
"almExtraInfo": {"activeApCount": 0,
"activeEdgeCount": 0,
"activeSwitchCount": 0,
"licenseType": "UNKNOWN",
"remainingQuantity": 0,
"soEntQuantity": 0
},
"assignedLicenses": 0,
"closestLicenseQuantity": 0,
"closestLiceseQtty": 0,
"deviceCount": 0,
"deviceSubType": "string",
"deviceType": "UNASSIGNED_DEVICE_TYPE",
"edgeDeviceCount": 0,
"effectiveDate": "2019-08-24T14:15:22Z",
"errorCode": "string",
"expirationDate": "2019-08-24T14:15:22Z",
"futureOfComplianceDate": "2019-08-24T14:15:22Z",
"futureOutOfComplianceDevices": 0,
"internalMessage": "string",
"licenseDesc": "string",
"licenseName": "string",
"outOfComplianceDevices": 0,
"purchasedLicenses": 0,
"quantity": 0,
"remainingDays": 0,
"remainingQuantity": 0,
"rwgDeviceCount": 0,
"sku": "string",
"switchDeviceCount": 0,
"tempLicense": true,
"toBeRemovedDeviceCount": 0,
"virtualEdgeDeviceCount": 0,
"wifiDeviceCount": 0
}
]
}

Get Entitlements Utilization Summaries

Retrieve entitlement usage details. Usage summaries provide information on the number of entitlements used and active devices.

Request Body schema:
application/json
required

object (Manage_Entitlements_API_DynamicQueryPayloadFilterDto)

The query filters

Responses

Request samples

Payload

Content type

application/json

{"filters": {"isAssignedLicense": false,
"isTrial": false,
"licenseType": ["APSW"
],
"status": ["VALID"
],
"usageType": "Self"
}
}

Response samples

200
404
417
500

Content type

application/json

Example

Manage_Entitlements_API_DataResponseDto

{"data": [{ }
],
"errors": [{"error": {"code": "string",
"message": "string"
},
"requestId": "string"
}
]
}

Assignment

Create a Self Assignment

This endpoint creates a self assignment, which can be used for own accounts.

Request Body schema:
application/json
required

effectiveDate required	string Effective date of the entitlement assignment.
expirationDate required	string Expiration date of the entitlement assignment.
licenseType required	string Type of entitlement
quantity required	integer <int32> Quantity of entitlements assigned.
trial	boolean

Responses

Request samples

Payload

Content type

application/json

{"effectiveDate": "2024-01-22 15:08:10Z",
"expirationDate": "2024-02-21 15:07:10Z",
"licenseType": "APSW",
"quantity": 5,
"trial": true
}

Response samples

201
400
500

Content type

application/json

{"data": {"createdBy": "rohitmsp.ruckusone5@email.com",
"createdDate": "2024-01-16T06:06:02.776Z",
"effectiveDate": "2024-01-22T15:08:10Z",
"expirationDate": "2024-02-21T15:07:10Z",
"id": 1234,
"isTrial": false,
"licenseType": "APSW",
"quantity": 5,
"revokedBy": "null",
"revokedDate": "null",
"status": "VALID"
},
"message": "Object created/updated successfully.",
"status": "success"
}

Get Self Entitlement Assignment

This endpoint retrieves entitlement assignments for own accounts.

Request Body schema:
application/json
required

fields	Array of strings unique A list of assignment data fields to be returned.
	object (Manage_Entitlements_API_QueryAssignmentFilters) The query filters.
page	integer <int32> The page number to be returned, 1 based, default 1.
pageSize	integer <int32> The page number to be returned, default 20.
sortField	string Enum: "expirationDate" "effectiveDate" The data filed name which will be used for sorting the query result.
sortOrder	string Enum: "ASC" "DESC" The sorting order, default is ascending order.

Responses

Request samples

Payload

Content type

application/json

{"fields": ["id",
"quantity"
],
"filters": {"createdBy": ["admin@test.com"
],
"isTrial": false,
"licenseType": ["APSW"
],
"status": ["VALID"
]
},
"page": 1,
"pageSize": 30,
"sortField": "expirationDate",
"sortOrder": "ASC"
}

Response samples

200
400
500

Content type

application/json

{"data": [{ }
],
"errors": [{"error": {"code": "string",
"message": "string"
},
"requestId": "string"
}
],
"fields": ["string"
],
"objectId": "string",
"page": 0,
"pageSize": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Delete Self Assignment

This endpoint deletes active assignments. When a license is deleted, it is not completely removed but instead marked as revoked and cannot be used.

path Parameters

id

required

integer <int64>

Responses

Response samples

400
409
500

Content type

application/json

{"error": {"code": "string",
"message": "string"
},
"requestId": "string"
}

Update a Self Assignment

This endpoint updates a self assignment. Quantity and expiry date can be updated for self assignments. When updating assignments, existing assignments will be revoked and new assignments will be created with updated fields.

path Parameters

id

required

integer <int64>

Request Body schema:
application/json
required

expirationDate required	string Expiration date of the entitlement assignment.
quantity required	integer <int32> Quantity of entitlements assigned.
valid	boolean

Responses

Request samples

Payload

Content type

application/json

{"expirationDate": "2024-02-21 15:07:10Z",
"quantity": 5,
"valid": true
}

Response samples

200
400
402
409
500

Content type

application/json

{"data": {"createdBy": "rohitmsp.ruckusone5@email.com",
"createdDate": "2024-01-16T06:06:02.776Z",
"effectiveDate": "2024-01-22T15:08:10Z",
"expirationDate": "2024-02-21T15:07:10Z",
"id": 1234,
"isTrial": false,
"licenseType": "APSW",
"quantity": 5,
"revokedBy": "null",
"revokedDate": "null",
"status": "VALID"
},
"message": "Object created/updated successfully.",
"status": "success"
}

Get Entitlements Assignments

path Parameters

tenantId

required

string

Request Body schema:
application/json
required

fields	Array of strings unique A list of assignment data fields to be returned.
	object (Manage_Entitlements_API_QueryAssignmentFilters) The query filters.
page	integer <int32> The page number to be returned, 1 based, default 1.
pageSize	integer <int32> The page number to be returned, default 20.
sortField	string Enum: "expirationDate" "effectiveDate" The data filed name which will be used for sorting the query result.
sortOrder	string Enum: "ASC" "DESC" The sorting order, default is ascending order.

Responses

Request samples

Payload

Content type

application/json

{"fields": ["id",
"quantity"
],
"filters": {"createdBy": ["admin@test.com"
],
"isTrial": false,
"licenseType": ["APSW"
],
"status": ["VALID"
]
},
"page": 1,
"pageSize": 30,
"sortField": "expirationDate",
"sortOrder": "ASC"
}

Response samples

200
400
500

Content type

application/json

{"data": [{ }
],
"errors": [{"error": {"code": "string",
"message": "string"
},
"requestId": "string"
}
],
"fields": ["string"
],
"objectId": "string",
"page": 0,
"pageSize": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

AvailabilityReport

Query Availability Reports

This endpoint allows you to query availability reports for entitlements.

Request Body schema:
application/json
required

effectiveDate required	string^\d{4}-\d{2}-\d{2}$ Start date from which the license is valid.
expirationDate	string^\d{4}-\d{2}-\d{2}$ End date until which the license is valid. Required if operator max quantity is selected.
required	object (Manage_Entitlements_API_CalculatorFilterRequestDto) Filter criteria for the request
operator required	string Enum: "MAX_QUANTITY" "MAX_PERIOD" Operator to be used.
quantity	integer <int32> Number of licenses available. Required if operator max period is selected.

Responses

Request samples

Payload

Content type

application/json

{"effectiveDate": "2024-01-22",
"expirationDate": "2025-02-21",
"filters": {"isTrial": true,
"licenseType": "APSW",
"usageType": "ASSIGNED"
},
"operator": "MAX_QUANTITY",
"quantity": 5
}

Response samples

200
403
500

Content type

application/json

{"data": {"effectiveDate": "2024-01-22",
"expirationDate": "2024-02-21",
"isTrial": false,
"licenseType": "APSW",
"quantity": 5
},
"message": "Object created/updated successfully.",
"status": "success"
}

Query License Mileage Report

This endpoint allows you to query license mileage reports for entitlements.

Request Body schema:
application/json
required

required	object (Manage_Entitlements_API_CalculatorFilterRequestDto) Filter criteria for the request
page	integer <int32> The page number to be returned, 1 based, default 1.
pageSize	integer <int32> The page number to be returned, default 20.

Responses

Request samples

Payload

Content type

application/json

{"filters": {"isTrial": true,
"licenseType": "APSW",
"usageType": "ASSIGNED"
},
"page": 1,
"pageSize": 30
}

Response samples

200
403
500

Content type

application/json

{"data": [{"availableBreakUp": [{"expirationDate": "2024-09-16",
"quantity": 20
}
],
"device": 350,
"isTrial": false,
"lastDate": "2024-09-30",
"licenseType": "APSW",
"quantity": 400,
"usedQuantity": 350
}
],
"message": "Object created/updated successfully.",
"page": 0,
"pageSize": 0,
"status": "success",
"totalCount": 0
}

AttentionNote

Query License Attention Notes

Query license attention notes.

query Parameters

excludeContent

boolean

Default: false

Request Body schema:
application/json
required

fields	Array of strings unique Items Enum: "id" "type" "tenantType" "enabled" "startDate" "endDate" "summary" "details" "createdDate" "updatedDate" "status" Fields to return, all fields will be returned if missing.
	object (Manage_Entitlements_API_AttentionNoteQueryFilterDto)
page	integer <int32> Page number, 1 based, default is 1 if missing.
pageSize	integer <int32> Page size, default is 20 if missing.
sortField	string Sorting field, it can be any of the fields of attention notes.
sortOrder	string Enum: "ASC" "DESC" Sorting order, default is ascending order if missing.

Responses

Request samples

Payload

Content type

application/json

{"fields": ["summary",
"details"
],
"filters": {"enabled": true,
"licenseCheck": true,
"status": ["VALID",
"FUTURE"
],
"tenantType": ["REC",
"MSP"
],
"type": ["STOP_COURTESY"
]
},
"page": 1,
"pageSize": 30,
"sortField": "startDate",
"sortOrder": "DESC"
}

Response samples

200
403
500

Content type

application/json

{"data": [{"property1": { },
"property2": { }
}
],
"errors": [{"error": {"code": "string",
"message": "string"
},
"requestId": "string"
}
],
"fields": ["string"
],
"objectId": "string",
"page": 0,
"pageSize": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Alarm

Alarm List API

Clear All Alarms

This Api is deprecated. Use latest Api. This deprecated api clears all alarms specified in the existing payload.

Request Body schema:
application/json

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200
400
500

Content type

application/json

{"data": [{"property1": { },
"property2": { }
}
],
"fields": ["string"
],
"message": "string",
"mspEcAlarmCountList": [{"alarmCount": 0,
"tenantId": "string"
}
],
"status": "string",
"subsequentQueries": [{"property1": { },
"property2": { }
}
],
"totalCount": 0
}

Get Alarms Venue,AP and Network Data

Get all alarms filtered by the query. Includes venue, access point and network data.

Request Body schema:
application/json
required

fields	Array of strings unique
	object Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"property1": { },
"property2": { }
}
}

Response samples

200
500

Content type

application/json

{"data": [{"property1": { },
"property2": { }
}
],
"fields": ["string"
],
"message": "string",
"mspEcAlarmCountList": [{"alarmCount": 0,
"tenantId": "string"
}
],
"status": "string",
"subsequentQueries": [{"property1": { },
"property2": { }
}
],
"totalCount": 0
}

Get Alarms

Returns the set of alarms. Added the support for MSP tenant. For MSP tenant need to pass tenant ids and sort order.

Request Body schema:
application/json
required

fields	Array of strings unique
	object
mspEcTenants	Array of strings
page	integer <int32>
pageSize	integer <int32>
sortField	string
sortOrder	string

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"mspEcTenants": ["string"
],
"page": 0,
"pageSize": 0,
"sortField": "string",
"sortOrder": "string"
}

Response samples

200
400
500

Content type

application/json

{"data": [{"property1": { },
"property2": { }
}
],
"fields": ["string"
],
"message": "string",
"mspEcAlarmCountList": [{"alarmCount": 0,
"tenantId": "string"
}
],
"status": "string",
"subsequentQueries": [{"property1": { },
"property2": { }
}
],
"totalCount": 0
}

Clear Alarm

Clear the alarm.

path Parameters

alarmId

required

string

Request Body schema:
application/json

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200
400
500

Content type

application/json

{"data": [{"property1": { },
"property2": { }
}
],
"fields": ["string"
],
"message": "string",
"mspEcAlarmCountList": [{"alarmCount": 0,
"tenantId": "string"
}
],
"status": "string",
"subsequentQueries": [{"property1": { },
"property2": { }
}
],
"totalCount": 0
}

Clear All WiFi AP Alarms

This Api is deprecated. Use latest Api. This deprecated api clears all alarms specified in the existing payload by a AP serial.

path Parameters

apSerial

required

string

Request Body schema:
application/json

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200
400
500

Content type

application/json

{"data": [{"property1": { },
"property2": { }
}
],
"fields": ["string"
],
"message": "string",
"mspEcAlarmCountList": [{"alarmCount": 0,
"tenantId": "string"
}
],
"status": "string",
"subsequentQueries": [{"property1": { },
"property2": { }
}
],
"totalCount": 0
}

Clear All Switch Alarms

This Api is deprecated. Use latest Api. This deprecated api clears all alarms specified in the existing payload by a switch.

path Parameters

switchSerial

required

string

Request Body schema:
application/json

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200
400
500

Content type

application/json

{"data": [{"property1": { },
"property2": { }
}
],
"fields": ["string"
],
"message": "string",
"mspEcAlarmCountList": [{"alarmCount": 0,
"tenantId": "string"
}
],
"status": "string",
"subsequentQueries": [{"property1": { },
"property2": { }
}
],
"totalCount": 0
}

Clear All Venue Alarms

This Api is deprecated. Use latest Api. This deprecated api clears all alarms specified in the existing payload by a venue.

path Parameters

venueId

required

string

Request Body schema:
application/json

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200
400
500

Content type

application/json

{"data": [{"property1": { },
"property2": { }
}
],
"fields": ["string"
],
"message": "string",
"mspEcAlarmCountList": [{"alarmCount": 0,
"tenantId": "string"
}
],
"status": "string",
"subsequentQueries": [{"property1": { },
"property2": { }
}
],
"totalCount": 0
}

Event

Event List API

Get Admin Members Last Logins

Get admin members last logins.

path Parameters

adminGroupId

required

string

Admin Group Id

Responses

Response samples

200
400
500

Content type

application/json

{"count": 0,
"errorMessage": "string",
"lastLoginList": [{"email": "string",
"lastLoginDate": "string"
}
]
}

Export Events Within a Date Range

Export specific events within a date range.

Request Body schema:
application/json
required

clientDateFormat	string
clientTimeZone	string
detailLevel	string
	object
fields	Array of strings unique
	object
isSupport	boolean
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
support	boolean
tenantId	string
	object (Events_and_Alarms_API_TermFieldDto)

Responses

Request samples

Payload

Content type

application/json

{"clientDateFormat": "string",
"clientTimeZone": "string",
"detailLevel": "string",
"eventsPeriodForExport": {"property1": "string",
"property2": "string"
},
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"isSupport": true,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"support": true,
"tenantId": "string",
"termField": {"field": "string",
"value": "string"
}
}

Response samples

200
400

Content type

application/json

{ }

Get Events Details Like Venue, AP and Network Data

Get events details with venue, access point and network data.

Request Body schema:
application/json
required

fields	Array of strings unique
	object Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"property1": { },
"property2": { }
}
}

Response samples

200
400
500

Content type

application/json

{"data": [{"property1": { },
"property2": { }
}
],
"fields": ["string"
],
"message": "string",
"subsequentQueries": [{"property1": { },
"property2": { }
}
],
"totalCount": 0
}

Get Events Venue,AP and Network Data

Get events with venue, access point and network data.

Request Body schema:
application/json
required

fields	Array of strings unique
	object Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"property1": { },
"property2": { }
}
}

Response samples

200
400
500

Content type

application/json

{"data": [{"property1": { },
"property2": { }
}
],
"fields": ["string"
],
"message": "string",
"subsequentQueries": [{"property1": { },
"property2": { }
}
],
"totalCount": 0
}

Get Events

Get event list information.

Request Body schema:
application/json
required

detailLevel	string
fields	Array of strings unique
	object Users need to pass a list of string or string as map values.
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings unique
sortField	string
sortOrder	string

Responses

Request samples

Payload

Content type

application/json

{"detailLevel": "string",
"fields": ["string"
],
"filters": {"property1": { },
"property2": { }
},
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string"
}

Response samples

200
400
500

Content type

application/json

{"data": [{"property1": { },
"property2": { }
}
],
"fields": ["string"
],
"message": "string",
"subsequentQueries": [{"property1": { },
"property2": { }
}
],
"totalCount": 0
}

Get Historical Clients

Get historical client list information grouped by client MAC address.

Request Body schema:
application/json
required

detailLevel	string
fields	Array of strings unique
	object Users need to pass a list of string or string as map values.
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings unique
sortField	string
sortOrder	string

Responses

Request samples

Payload

Content type

application/json

{"detailLevel": "string",
"fields": ["string"
],
"filters": {"property1": { },
"property2": { }
},
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string"
}

Response samples

200
400
500

Content type

application/json

{"data": [{"property1": { },
"property2": { }
}
],
"fields": ["string"
],
"message": "string",
"subsequentQueries": [{"property1": { },
"property2": { }
}
],
"totalCount": 0
}

Group Members Last login Event

Get Admin Members Last Logins

Get admin members last logins.

path Parameters

adminGroupId

required

string

Admin Group Id

Responses

Response samples

200
400
500

Content type

application/json

{"count": 0,
"errorMessage": "string",
"lastLoginList": [{"email": "string",
"lastLoginDate": "string"
}
]
}

File

Manage upload or download files.

Get Upload URL

Get a URL with which to upload a file.

Request Body schema: application/json
required

fileExtension

string

Responses

Request samples

Payload

Content type

application/json

{"fileExtension": "string"
}

Get Download URL

Get the URL from which to download this file.

path Parameters

fileId

required

string

Responses

Get File Download URL

Get the URL from which to download this file.

path Parameters

fileId

required

string

Responses

Guest User

Manage guest users.

Delete Guest Users Deprecated

Delete one or more guest users per their IDs as defined in the payload.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string",
"response": { }
}

Get Guest Users Deprecated

Get user details for the list of provisioned guest users.

query Parameters

page	integer <int32> Page index
size	integer <int32> The size of the page to be returned

Responses

Response samples

Content type

application/json

{"content": [{"createdDate": 0,
"deliveryMethods": ["MAIL"
],
"disabled": false,
"email": "string",
"expiration": {"activationType": "Creation",
"duration": 0,
"unit": "Minute"
},
"expirationDate": 0,
"guestUserType": "GuestPass",
"id": "string",
"lastModified": 0,
"macAddresses": ["string"
],
"maxDevices": 3,
"mobilePhoneNumber": "string",
"name": "string",
"networkId": "string",
"notes": "string",
"password": "string",
"ssid": "string"
}
],
"totalElements": 0
}

Add Guest Users Deprecated

Provision one or more guest users as defined in the payload.

Request Body schema: application/json
required

Array

deliveryMethods required	Array of strings unique Items Enum: "MAIL" "SMS" "STUB" "PRINT" At least one delivery method.
disabled	boolean If true, this guest user will not be permitted to join the guest network.
email	string
required	object (Guest_Service_API_&_Model_Documentation_GuestUserExpiration)
maxDevices required	integer <int32> Maximum number of devices the guest user can simultaneously connect to the guest network. If set to minus one, no limit is enforced.
mobilePhoneNumber required	string The mobile phone number associated to the guest user.
name required	string The name assigned to the guest user.
networkId required	string Network ID of the guest network.
notes	string [ 0 .. 180 ] characters

Responses

Request samples

Payload

Content type

application/json

[{"deliveryMethods": ["MAIL"
],
"disabled": false,
"email": "string",
"expiration": {"activationType": "Creation",
"duration": 0,
"unit": "Minute"
},
"maxDevices": 3,
"mobilePhoneNumber": "string",
"name": "string",
"networkId": "string",
"notes": "string"
}
]

Response samples

Content type

application/json

{"requestId": "string",
"response": [{"createdDate": 0,
"deliveryMethods": ["MAIL"
],
"disabled": false,
"email": "string",
"expiration": {"activationType": "Creation",
"duration": 0,
"unit": "Minute"
},
"expirationDate": 0,
"guestUserType": "GuestPass",
"id": "string",
"lastModified": 0,
"macAddresses": ["string"
],
"maxDevices": 3,
"mobilePhoneNumber": "string",
"name": "string",
"networkId": "string",
"notes": "string",
"password": "string",
"ssid": "string"
}
]
}

Delete Guest User by ID Deprecated

Delete a guest user.

path Parameters

guestUserId

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": { }
}

Get Guest User by ID Deprecated

Get a guest user.

path Parameters

guestUserId

required

string

Responses

Response samples

Content type

application/json

{"createdDate": 0,
"deliveryMethods": ["MAIL"
],
"disabled": false,
"email": "string",
"expiration": {"activationType": "Creation",
"duration": 0,
"unit": "Minute"
},
"expirationDate": 0,
"guestUserType": "GuestPass",
"id": "string",
"lastModified": 0,
"macAddresses": ["string"
],
"maxDevices": 3,
"mobilePhoneNumber": "string",
"name": "string",
"networkId": "string",
"notes": "string",
"password": "string",
"ssid": "string"
}

Update Guest User Deprecated

Update guest user enable/disable status or create new password for the guest user.

path Parameters

guestUserId

required

string

Request Body schema: application/json
required

Parameter combination option:

Option1: Enable or disable user by "action: enabled" or "action: disabled".

Option2: Regenerate guest user credential by "action: regenerate" + "deliveryMethods"

action required	string Action for updating guest user.
deliveryMethods	Array of strings unique Items Enum: "MAIL" "SMS" "STUB" "PRINT" At least one delivery method.

Responses

Request samples

Payload

Content type

application/json

{"action": "enabled",
"deliveryMethods": "MAIL"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"createdDate": 0,
"deliveryMethods": ["MAIL"
],
"disabled": false,
"email": "string",
"expiration": {"activationType": "Creation",
"duration": 0,
"unit": "Minute"
},
"expirationDate": 0,
"guestUserType": "GuestPass",
"id": "string",
"lastModified": 0,
"macAddresses": ["string"
],
"maxDevices": 3,
"mobilePhoneNumber": "string",
"name": "string",
"networkId": "string",
"notes": "string",
"password": "string",
"ssid": "string"
}
}

Import Guest Users by Network ID Deprecated

Import one or more guest pass users from the payload's CSV file.

path Parameters

networkId

required

string

Network ID of the guest network to which the guest user will connect.

query Parameters

expiration.activationType required	string Enum: "Creation" "Login" When activation type is set to creation, the guest pass is valid when it's created until the specified expiration duration, even if it's not being used; when set to login, the guest pass is valid starting from when the user first logs on until the specified expiration duration.
expiration.duration required	integer <int32> [ 1 .. 8760 ]
expiration.unit required	string Enum: "Minute" "Hour" "Day" "Week" "Month" "Year" "Never"
maxDevices required	integer <int32> Default: 3 Maximum number of devices the guest user can simultaneously connect to the guest network. If set to -1, no limit is enforced.
deliveryMethods	Array of strings unique Items Enum: "MAIL" "SMS" "STUB" "PRINT" At least one delivery method.

Request Body schema: multipart/form-data
required

file

required

string <binary>

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"data": [{"createdDate": 0,
"deliveryMethods": ["MAIL"
],
"disabled": false,
"email": "string",
"expiration": {"activationType": "Creation",
"duration": 0,
"unit": "Minute"
},
"expirationDate": 0,
"guestUserType": "GuestPass",
"id": "string",
"lastModified": 0,
"macAddresses": ["string"
],
"maxDevices": 3,
"mobilePhoneNumber": "string",
"name": "string",
"networkId": "string",
"notes": "string",
"password": "string",
"ssid": "string"
}
],
"downloadUrl": "string"
}
}

Guest User Action

Guest user action for the guest user.

path Parameters

wifiNetworkId

required

string

Request Body schema:
application/json
required

action required	string Value: "passwordValidation" Action for guest user.
password	string [ 6 .. 16 ] characters Manual password. The password must contain at least 6 characters (up to 16). The following characters are permitted: a-z, A-Z, 0-9, and other special characters !@#$%^&*()[]{}-_+=~`\|:;"'<>,./?.

Responses

Request samples

Payload

Content type

application/json

{"action": "passwordValidation",
"password": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Add Guest User

Create a new guest user.

path Parameters

wifiNetworkId

required

string

Network ID of the guest network to which the guest user will connect.

query Parameters

expiration.activationType required	string Enum: "Creation" "Login" When activation type is set to creation, the guest pass is valid when it's created until the specified expiration duration, even if it's not being used; when set to login, the guest pass is valid starting from when the user first logs on until the specified expiration duration.
expiration.duration required	integer <int32> [ 1 .. 8760 ]
expiration.unit required	string Enum: "Minute" "Hour" "Day" "Week" "Month" "Year" "Never"
maxDevices required	integer <int32> Default: 3 Maximum number of devices the guest user can simultaneously connect to the guest network. If set to -1, no limit is enforced.
deliveryMethods	Array of strings unique Items Enum: "MAIL" "SMS" "STUB" "PRINT" At least one delivery method.

Request Body schema:
application/json
required

deliveryMethods required	Array of strings unique Items Enum: "MAIL" "SMS" "STUB" "PRINT" At least one delivery method.
disabled	boolean If true, this guest user will not be permitted to join the guest network.
email	string
required	object (Guest_Service_API_&_Model_Documentation_GuestUserExpiration)
maxDevices required	integer <int32> Maximum number of devices the guest user can simultaneously connect to the guest network. If set to minus one, no limit is enforced.
mobilePhoneNumber required	string The mobile phone number associated to the guest user.
name required	string The name assigned to the guest user.
notes	string [ 0 .. 180 ] characters

Responses

Request samples

Payload

Content type

application/json

{"deliveryMethods": ["MAIL"
],
"disabled": false,
"email": "string",
"expiration": {"activationType": "Creation",
"duration": 0,
"unit": "Minute"
},
"maxDevices": 3,
"mobilePhoneNumber": "string",
"name": "string",
"notes": "string"
}

Response samples

Content type

application/json

Example

Guest_Service_API_&_Model_Documentation_OperationResponseListGuestUserImportResponseV1

{"requestId": "string",
"response": [{"data": [{"createdDate": 0,
"deliveryMethods": ["MAIL"
],
"disabled": false,
"email": "string",
"expiration": {"activationType": "Creation",
"duration": 0,
"unit": "Minute"
},
"expirationDate": 0,
"guestUserType": "GuestPass",
"id": "string",
"lastModified": 0,
"macAddresses": ["string"
],
"maxDevices": 3,
"mobilePhoneNumber": "string",
"name": "string",
"notes": "string",
"password": "string",
"ssid": "string"
}
],
"downloadUrl": "string"
}
]
}

Delete Guest User by ID

Delete a guest user.

path Parameters

wifiNetworkId required	string
guestUserId required	string

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Guest User by ID

Get a guest user.

path Parameters

wifiNetworkId required	string
guestUserId required	string

Responses

Response samples

Content type

application/json

{"createdDate": 0,
"deliveryMethods": ["MAIL"
],
"disabled": false,
"email": "string",
"expiration": {"activationType": "Creation",
"duration": 0,
"unit": "Minute"
},
"expirationDate": 0,
"guestUserType": "GuestPass",
"lastModified": 0,
"macAddresses": ["string"
],
"maxDevices": 3,
"mobilePhoneNumber": "string",
"name": "string",
"notes": "string",
"password": "string",
"ssid": "string"
}

Update Guest User

Update guest user enable/disable status or create new password for the guest user.

path Parameters

wifiNetworkId required	string
guestUserId required	string

Request Body schema:
application/json
required

Parameter combination option:

Option1: Enable or disable user by "disabled: false" or "disabled: true".

Option2: Regenerate guest user credential by "action: regeneratePassword" + "deliveryMethods"

action	string Enum: "regeneratePassword" "passwordValidation" Action for updating guest user.
deliveryMethods	Array of strings unique Items Enum: "MAIL" "SMS" "STUB" "PRINT" At least one delivery method.
disabled	boolean If true, this guest user will not be permitted to join the guest network.
password	string Manual password. The password must contain at least 6 characters (up to 16). The following characters are permitted: a-z, A-Z, 0-9, and other special characters !@#$%^&*()[]{}-_+=~`\|:;"'<>,./?.

Responses

Request samples

Payload

Content type

application/json

{"action": "regeneratePassword",
"deliveryMethods": ["MAIL",
"PRINT"
],
"disabled": false,
"password": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"createdDate": 0,
"deliveryMethods": ["MAIL"
],
"disabled": false,
"email": "string",
"expiration": {"activationType": "Creation",
"duration": 0,
"unit": "Minute"
},
"expirationDate": 0,
"guestUserType": "GuestPass",
"lastModified": 0,
"macAddresses": ["string"
],
"maxDevices": 3,
"mobilePhoneNumber": "string",
"name": "string",
"notes": "string",
"password": "string",
"ssid": "string"
}
}

Portal Service Profile

Manage Portal Service Profile.

Delete Portal Service Profile Deprecated

Delete portal service profile by ids.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string",
"response": { }
}

Get Portal Service Profiles Deprecated

Get portal service profile for the list.

query Parameters

serviceName	string Portal Service Profile Name
networkId	string NetworkId
tags	string Tags
page	integer <int32> Default: 1 Indicates the page to return, will be 1 based, and default to page 1
pageSize	integer <int32> Default: 256 Default is 256, indicates the page size to return
excludeContent	boolean Default: false Get the total count information from the query and NOT pull the data

Responses

Response samples

Content type

application/json

{"content": [{"content": {"bgColor": "string",
"bgImage": "string",
"bgImageChecksum": "string",
"buttonColor": "string",
"componentDisplay": {"logo": true,
"photo": true,
"poweredBy": true,
"secondaryText": true,
"termsConditions": true,
"welcome": true,
"wifi4eu": true
},
"displayLangCode": "string",
"logo": "string",
"logoChecksum": "string",
"logoRatio": 0,
"photo": "string",
"photoChecksum": "string",
"photoRatio": 0,
"poweredBgColor": "string",
"poweredColor": "string",
"poweredImg": "string",
"poweredImgChecksum": "string",
"poweredImgRatio": 0,
"poweredSize": 0,
"secondaryColor": "string",
"secondarySize": 0,
"secondaryText": "string",
"termsCondition": "string",
"welcomeColor": "string",
"welcomeSize": 0,
"welcomeText": "string",
"wifi4EUNetworkId": "string"
},
"id": "string",
"serviceName": "string",
"tags": "string"
}
],
"paging": {"page": 0,
"pageSize": 0,
"totalCount": 0
}
}

Add Portal Service Profile

Provision one portal service profile as defined in the payload.

Request Body schema:
application/json
required

	object (Guest_Service_API_&_Model_Documentation_PortalServiceProfileContentDto)
id	string
serviceName	string
tags	string

Responses

Request samples

Payload

Content type

application/json

{"content": {"bgColor": "string",
"bgImage": "string",
"bgImageChecksum": "string",
"buttonColor": "string",
"componentDisplay": {"logo": true,
"photo": true,
"poweredBy": true,
"secondaryText": true,
"termsConditions": true,
"welcome": true,
"wifi4eu": true
},
"displayLangCode": "string",
"logo": "string",
"logoChecksum": "string",
"logoRatio": 0,
"photo": "string",
"photoChecksum": "string",
"photoRatio": 0,
"poweredBgColor": "string",
"poweredColor": "string",
"poweredImg": "string",
"poweredImgChecksum": "string",
"poweredImgRatio": 0,
"poweredSize": 0,
"secondaryColor": "string",
"secondarySize": 0,
"secondaryText": "string",
"termsCondition": "string",
"welcomeColor": "string",
"welcomeSize": 0,
"welcomeText": "string",
"wifi4EUNetworkId": "string"
},
"id": "string",
"serviceName": "string",
"tags": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"id": "string"
}
}

Get Network Filter of Portal Service Profiles Deprecated

Get network filter for portal service profile lists.

Responses

Response samples

Content type

application/json

[{"id": "string",
"name": "string",
"tags": "string"
}
]

Get Tags Filter of Portal Service Profiles Deprecated

Get tags filter for portal service profile lists.

Responses

Response samples

Content type

application/json

[{"id": "string",
"name": "string",
"tags": "string"
}
]

Delete Portal Service Profile

Delete portal service profile by id.

path Parameters

portalServiceProfileId

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Portal Service Profile

Get a portal service profile.

path Parameters

portalServiceProfileId

required

string

Responses

Response samples

Content type

application/json

{"content": {"bgColor": "string",
"bgImage": "string",
"bgImageChecksum": "string",
"buttonColor": "string",
"componentDisplay": {"logo": true,
"photo": true,
"poweredBy": true,
"secondaryText": true,
"termsConditions": true,
"welcome": true,
"wifi4eu": true
},
"displayLangCode": "string",
"logo": "string",
"logoChecksum": "string",
"logoRatio": 0,
"photo": "string",
"photoChecksum": "string",
"photoRatio": 0,
"poweredBgColor": "string",
"poweredColor": "string",
"poweredImg": "string",
"poweredImgChecksum": "string",
"poweredImgRatio": 0,
"poweredSize": 0,
"secondaryColor": "string",
"secondarySize": 0,
"secondaryText": "string",
"termsCondition": "string",
"welcomeColor": "string",
"welcomeSize": 0,
"welcomeText": "string",
"wifi4EUNetworkId": "string"
},
"name": "string"
}

Update Portal Service Profile

Update portal service profile by id.

path Parameters

portalServiceProfileId

required

string

Request Body schema:
application/json
required

	object (Guest_Service_API_&_Model_Documentation_PortalServiceProfileContentDto)
id	string
serviceName	string
tags	string

Responses

Request samples

Payload

Content type

application/json

{"content": {"bgColor": "string",
"bgImage": "string",
"bgImageChecksum": "string",
"buttonColor": "string",
"componentDisplay": {"logo": true,
"photo": true,
"poweredBy": true,
"secondaryText": true,
"termsConditions": true,
"welcome": true,
"wifi4eu": true
},
"displayLangCode": "string",
"logo": "string",
"logoChecksum": "string",
"logoRatio": 0,
"photo": "string",
"photoChecksum": "string",
"photoRatio": 0,
"poweredBgColor": "string",
"poweredColor": "string",
"poweredImg": "string",
"poweredImgChecksum": "string",
"poweredImgRatio": 0,
"poweredSize": 0,
"secondaryColor": "string",
"secondarySize": 0,
"secondaryText": "string",
"termsCondition": "string",
"welcomeColor": "string",
"welcomeSize": 0,
"welcomeText": "string",
"wifi4EUNetworkId": "string"
},
"id": "string",
"serviceName": "string",
"tags": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Update Portal Service Profile Background Image

Update portal service profile background image by id.

path Parameters

portalServiceProfileId

required

string

Request Body schema:
application/json
required

image

string [ 0 .. 6990507 ] characters

A base 64 encoded string. Note that all images are saved as portable network graphics files.

Responses

Request samples

Payload

Content type

application/json

{"image": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAADCAIAAADUVFKvAAAAFklEQVR4AWP4TwABAAAAAcADfzEPFwAAAABJRU5ErkJggg=="
}

Response samples

Content type

application/json

{"requestId": "string"
}

Update Portal Service Profile Logo

Update portal service profile logo by id.

path Parameters

portalServiceProfileId

required

string

Request Body schema:
application/json
required

image

string [ 0 .. 6990507 ] characters

A base 64 encoded string. Note that all images are saved as portable network graphics files.

Responses

Request samples

Payload

Content type

application/json

{"image": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAADCAIAAADUVFKvAAAAFklEQVR4AWP4TwABAAAAAcADfzEPFwAAAABJRU5ErkJggg=="
}

Response samples

Content type

application/json

{"requestId": "string"
}

Update Portal Service Profile Photo

Update portal service profile photo by id.

path Parameters

portalServiceProfileId

required

string

Request Body schema:
application/json
required

image

string [ 0 .. 6990507 ] characters

A base 64 encoded string. Note that all images are saved as portable network graphics files.

Responses

Request samples

Payload

Content type

application/json

{"image": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAADCAIAAADUVFKvAAAAFklEQVR4AWP4TwABAAAAAcADfzEPFwAAAABJRU5ErkJggg=="
}

Response samples

Content type

application/json

{"requestId": "string"
}

Update Portal Service Profile Powered Image

Update portal service profile powered image by id.

path Parameters

portalServiceProfileId

required

string

Request Body schema:
application/json
required

image

string [ 0 .. 6990507 ] characters

A base 64 encoded string. Note that all images are saved as portable network graphics files.

Responses

Request samples

Payload

Content type

application/json

{"image": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAADCAIAAADUVFKvAAAAFklEQVR4AWP4TwABAAAAAcADfzEPFwAAAABJRU5ErkJggg=="
}

Response samples

Content type

application/json

{"requestId": "string"
}

MAC Registration

Delete the Specific MAC Registrations

path Parameters

poolId

required

string <uuid>

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

Registration pool id

Request Body schema: application/json
required

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

200
400

Content type

application/json

{ }

MAC Registrations in the Specified Registration Pool

path Parameters

poolId

required

string <uuid>

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

Registration pool id

query Parameters

page	integer >= 0 Default: 0 Zero-based page index (0..N)
size	integer >= 1 Default: 20 The size of the page to be returned
sort	Array of strings Sorting criteria in the format: property,(asc\|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

200

Content type

application/json

{"content": [{"createdDate": "2019-08-24T14:15:22Z",
"deviceName": "string",
"email": "dev@commscope.com",
"expirationDate": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"location": "string",
"macAddress": "string",
"revoked": true,
"username": "string"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Create a MAC Registration in the Specified Registration Pool

path Parameters

poolId

required

string <uuid>

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

Registration pool id

Request Body schema: application/json
required

createdDate	string <date-time> The created date of this device.
deviceName	string Device name
email	string^(?:[\w!#$%&’+/=?`{\|}~^-]+(?:\.[\w!#$%&’+/=... The email to associate with this device.
expirationDate	string <date-time> Indicates when this registration expires. Will derive from the pool setting if not specified.
id	string <uuid> The unique identifier for this MAC registration.
identityId	string Identifier of linked service.
location	string The location of this device.
macAddress required	string^([0-9A-F]{2}-){5}([0-9A-F]{2})$ The mac address for this registration. Must be provided on post, and may not be changed.
revoked required	boolean If this MAC registration is revoked or not.
username	string A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

Responses

Request samples

Payload

Content type

application/json

{"createdDate": "2019-08-24T14:15:22Z",
"deviceName": "string",
"email": "dev@commscope.com",
"expirationDate": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"location": "string",
"macAddress": "string",
"revoked": true,
"username": "string"
}

Response samples

201
400
419

Content type

application/json

{"createdDate": "2019-08-24T14:15:22Z",
"deviceName": "string",
"email": "dev@commscope.com",
"expirationDate": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"location": "string",
"macAddress": "string",
"revoked": true,
"username": "string"
}

Import MAC Registrations with the Specified Registration Pool

path Parameters

poolId

required

string <uuid>

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

Registration pool id

Request Body schema: multipart/form-data

file

required

string <binary>

Responses

Response samples

201
400
413
419

Content type

application/json

[{"createdDate": "2019-08-24T14:15:22Z",
"deviceName": "string",
"email": "dev@commscope.com",
"expirationDate": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"location": "string",
"macAddress": "string",
"revoked": true,
"username": "string"
}
]

Search for MAC Registrations with the Specified Criteria

path Parameters

poolId

required

string <uuid>

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

Registration pool id

query Parameters

page	integer >= 0 Default: 0 Zero-based page index (0..N)
size	integer >= 1 Default: 20 The size of the page to be returned
sort	Array of strings Sorting criteria in the format: property,(asc\|desc). Default sort order is ascending. Multiple sort criteria are supported.

Request Body schema: application/json
required

dataOption	string
	Array of objects (MAC_Registration_API_SearchCriteria)

Responses

Request samples

Payload

Content type

application/json

{"dataOption": "ALL",
"searchCriteriaList": [{"filterKey": "name",
"operation": "eq",
"value": "ruckus one"
}
]
}

Response samples

200

Content type

application/json

{"content": [{"createdDate": "2019-08-24T14:15:22Z",
"deviceName": "string",
"email": "dev@commscope.com",
"expirationDate": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"location": "string",
"macAddress": "string",
"revoked": true,
"username": "string"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Delete the Specific MAC Registration

path Parameters

registrationId required	string <uuid> Example: f1ae11f2-1390-47c1-b05e-8377180c2b27 MAC registration id
poolId required	string <uuid> Example: f1ae11f2-1390-47c1-b05e-8377180c2b27 Registration pool id

Responses

Response samples

200
400
404

Content type

application/json

{ }

Returns the Specific MAC Registration

path Parameters

registrationId required	string <uuid> Example: 28529868-9db0-4361-ba20-4d35fb402bc2 MAC registration id
poolId required	string <uuid> Example: f1ae11f2-1390-47c1-b05e-8377180c2b27 Registration pool id

Responses

Response samples

200
400
404

Content type

application/json

{"createdDate": "2019-08-24T14:15:22Z",
"deviceName": "string",
"email": "dev@commscope.com",
"expirationDate": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"location": "string",
"macAddress": "string",
"revoked": true,
"username": "string"
}

Update Properties in the Specific MAC Registration

path Parameters

registrationId required	string <uuid> Example: f1ae11f2-1390-47c1-b05e-8377180c2b27 MAC registration id
poolId required	string <uuid> Example: f1ae11f2-1390-47c1-b05e-8377180c2b27 Registration pool id

Request Body schema: application/json
required

property name*

additional property

object

Responses

Request samples

Payload

Content type

application/json

{"property1": { },
"property2": { }
}

Response samples

200
400
404

Content type

application/json

{"createdDate": "2019-08-24T14:15:22Z",
"deviceName": "string",
"email": "dev@commscope.com",
"expirationDate": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"location": "string",
"macAddress": "string",
"revoked": true,
"username": "string"
}

Registration Pool

Registration Pools That Contain MAC Registrations

query Parameters

page	integer >= 0 Default: 0 Zero-based page index (0..N)
size	integer >= 1 Default: 20 The size of the page to be returned
sort	Array of strings Sorting criteria in the format: property,(asc\|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

200

Content type

application/json

{"content": [{"associationIds": ["string"
],
"autoCleanup": true,
"createdDate": "2019-08-24T14:15:22Z",
"defaultAccess": "ACCEPT",
"description": "string",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"expirationEnabled": false,
"expirationOffset": 0,
"expirationType": "SPECIFIED_DATE",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"name": "string",
"networkIds": ["string"
],
"policyId": "string",
"policySetId": "string",
"priority": 0,
"registrationCount": 0,
"ssidRegex": "string"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Create a Registration Pool

Request Body schema: application/json
required

associationIds	Array of strings unique The association list of this pool.
autoCleanup	boolean Default: true A toggle determining whether MAC registrations that are 24 hours past the expiration time will be automatically removed from the pool.
createdDate	string <date-time> The created date of this pool.
defaultAccess	string Enum: "ACCEPT" "REJECT" The type of default access. Possible options are: ACCEPT REJECT.
description	string A description of the pool.
enabled	boolean Default: true The registration pool is enabled for authentication or not.
expirationDate	string <date-time> If the expiration type is specified_date then this field is the related date.
expirationEnabled	boolean Default: false If the expiration setting is enabled for new MAC registration.
expirationOffset	integer <int32> If the expiration type is not specified_date then this field is the offset amount.
expirationType	string Enum: "SPECIFIED_DATE" "MINUTES_AFTER_TIME" "HOURS_AFTER_TIME" "DAYS_AFTER_TIME" "WEEKS_AFTER_TIME" "MONTHS_AFTER_TIME" "QUARTERS_AFTER_TIME" "YEARS_AFTER_TIME" "END_OF_HOUR" "END_OF_DAY" "END_OF_WEEK" "END_OF_MONTH" "END_OF_QUARTER" "END_OF_HALF" "END_OF_YEAR" The type of expiration date rule. The full expiration date rule is determined by paring the type with either an offset or date. Possible options are: SPECIFIED_DATE MINUTES_AFTER_TIME HOURS_AFTER_TIME DAYS_AFTER_TIME WEEKS_AFTER_TIME MONTHS_AFTER_TIME QUARTERS_AFTER_TIME YEARS_AFTER_TIME END_OF_HOUR END_OF_DAY END_OF_WEEK END_OF_MONTH END_OF_QUARTER END_OF_HALF END_OF_YEAR.
id	string <uuid> The unique identifier for this pool.
name required	string The unique reference name of the pool.
networkIds	Array of strings unique The network list of this pool.
policyId	string
policySetId	string The policy set of this pool.
priority required	integer <int32> The sequence of the pool, which determines the order it has when a MAC registration is being evaluated by radius. A MAC registration pool with a lower number is checked before one with a higher number.
registrationCount	integer <int32> Number of registrations in the pool.
ssidRegex	string A regex to determine which SSIDs this registration pool will allows access to.

Responses

Request samples

Payload

Content type

application/json

{"associationIds": ["string"
],
"autoCleanup": true,
"createdDate": "2019-08-24T14:15:22Z",
"defaultAccess": "ACCEPT",
"description": "string",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"expirationEnabled": false,
"expirationOffset": 0,
"expirationType": "SPECIFIED_DATE",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"networkIds": ["string"
],
"policyId": "string",
"policySetId": "string",
"priority": 0,
"registrationCount": 0,
"ssidRegex": "string"
}

Response samples

201
400
419

Content type

application/json

{"associationIds": ["string"
],
"autoCleanup": true,
"createdDate": "2019-08-24T14:15:22Z",
"defaultAccess": "ACCEPT",
"description": "string",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"expirationEnabled": false,
"expirationOffset": 0,
"expirationType": "SPECIFIED_DATE",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"name": "string",
"networkIds": ["string"
],
"policyId": "string",
"policySetId": "string",
"priority": 0,
"registrationCount": 0,
"ssidRegex": "string"
}

Search for Registration Pools with the Specified Criteria

query Parameters

page	integer >= 0 Default: 0 Zero-based page index (0..N)
size	integer >= 1 Default: 20 The size of the page to be returned
sort	Array of strings Sorting criteria in the format: property,(asc\|desc). Default sort order is ascending. Multiple sort criteria are supported.

Request Body schema: application/json
required

dataOption	string
	Array of objects (MAC_Registration_API_SearchCriteria)

Responses

Request samples

Payload

Content type

application/json

{"dataOption": "ALL",
"searchCriteriaList": [{"filterKey": "name",
"operation": "eq",
"value": "ruckus one"
}
]
}

Response samples

200

Content type

application/json

{"content": [{"associationIds": ["string"
],
"autoCleanup": true,
"createdDate": "2019-08-24T14:15:22Z",
"defaultAccess": "ACCEPT",
"description": "string",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"expirationEnabled": false,
"expirationOffset": 0,
"expirationType": "SPECIFIED_DATE",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"name": "string",
"networkIds": ["string"
],
"policyId": "string",
"policySetId": "string",
"priority": 0,
"registrationCount": 0,
"ssidRegex": "string"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Delete the Specific Registration Pool

path Parameters

id

required

string <uuid>

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

Registration pool id

Responses

Response samples

200
400

Content type

application/json

{ }

Returns the Specific Registration Pool Containing MAC Registrations

path Parameters

id

required

string <uuid>

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

Registration pool id

Responses

Response samples

200
400
404

Content type

application/json

{"associationIds": ["string"
],
"autoCleanup": true,
"createdDate": "2019-08-24T14:15:22Z",
"defaultAccess": "ACCEPT",
"description": "string",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"expirationEnabled": false,
"expirationOffset": 0,
"expirationType": "SPECIFIED_DATE",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"name": "string",
"networkIds": ["string"
],
"policyId": "string",
"policySetId": "string",
"priority": 0,
"registrationCount": 0,
"ssidRegex": "string"
}

Update Properties in the Specific Registration Pool

path Parameters

id

required

string <uuid>

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

Registration pool id

Request Body schema: application/json
required

property name*

additional property

object

Responses

Request samples

Payload

Content type

application/json

{"property1": { },
"property2": { }
}

Response samples

200
400
404

Content type

application/json

{"associationIds": ["string"
],
"autoCleanup": true,
"createdDate": "2019-08-24T14:15:22Z",
"defaultAccess": "ACCEPT",
"description": "string",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"expirationEnabled": false,
"expirationOffset": 0,
"expirationType": "SPECIFIED_DATE",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"name": "string",
"networkIds": ["string"
],
"policyId": "string",
"policySetId": "string",
"priority": 0,
"registrationCount": 0,
"ssidRegex": "string"
}

Manage Templates

Retrieve All Templates in Scope

Returns all templates within the given template scope.

path Parameters

templateScopeId

required

string <uuid>

Template scope ID

query Parameters

size	any Page size
page	any The page to retrieve (starts at zero).
sort	any The field name to sort, comma seperated from the sort order (asc or desc). Sortable fields are: id, nameLocalizationKey, userProvidedName, messageTemplate, and extraFieldOneTemplate

Responses

Response samples

200
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"editable": true,
"extraFieldOneTemplate": "string",
"id": "string",
"messageTemplate": "string",
"nameLocalizationKey": "string",
"userProvidedName": "string"
}
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

Retrieve Template

Returns the template specified by the give id, which can be either a registration id or template id.

path Parameters

templateScopeId required	string <uuid> Template Scope ID
genericTemplateId required	string Template or Registration ID

Responses

Response samples

200
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"editable": true,
"extraFieldOneTemplate": "string",
"id": "string",
"messageTemplate": "string",
"nameLocalizationKey": "string",
"userProvidedName": "string"
}

Template Scope

Retrieve information about the template scope

Retrieve All Template Scopes

Returns all available template scopes.

query Parameters

size	any Page size
page	any The page to retrieve (starts at zero).
sort	any The field name to sort, comma seperated from the sort order (asc or desc). Sortable fields are: id, messageType, and nameLocalizationKey

Responses

Response samples

200

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"defaultTemplateId": "bee715a2-1763-4940-8b0e-39be16b372e7",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"messageType": "EMAIL",
"nameLocalizationKey": "string",
"registrations": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"id": "string",
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"usageDescriptionFieldOne": "string",
"usageDescriptionFieldTwo": "string",
"usageLocalizationKey": "string"
}
]
}
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

Get Template Scope

Retrieves the template scope for the given id.

path Parameters

templateScopeId

required

string <uuid>

Template scope id

query Parameters

includes

Array of strings

A comma seperated list of child resources to include in the response in the format: includes={resourcePath},{resourcePath}. Where {resourcePath} must match the REST API path for that resource underneath the Template Scope. Only individual registrations are allowed. Any resource that is invalid or not found will be silently ignored. For example: includes=registrations/registration.id.1,registrations/registration.id.2

Responses

Response samples

200
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"defaultTemplateId": "bee715a2-1763-4940-8b0e-39be16b372e7",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"messageType": "EMAIL",
"nameLocalizationKey": "string",
"registrations": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"id": "string",
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"usageDescriptionFieldOne": "string",
"usageDescriptionFieldTwo": "string",
"usageLocalizationKey": "string"
}
]
}

Variables

Retrieve variables available to templates within the given template scope.

Retrieve Template Scope Variables

Retrieve variables within the given template scope.

path Parameters

templateScopeId

required

string <uuid>

Template scope id

query Parameters

size	any Page size
page	any The page to retrieve (starts at zero).
sort	any Sorting is not allowed for this endpoint.

Responses

Response samples

200
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"defaultValue": "string",
"file": true,
"nameLocalizationKey": "string",
"variableKey": "string"
}
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

Template Registrations

Retrieve template registrations

Retrieve a Template's Registrations

Returns all registrations that reference the given template.

path Parameters

templateScopeId required	string <uuid> Template Scope ID
templateId required	string <uuid> Template ID

query Parameters

size	any Page size
page	any The page to retrieve (starts at zero).
sort	any The field name to sort and the sort order (asc or desc) comma separated. Sortable fields are: id, templateId, usageLocalizationKey, usageDescriptionFieldOne, usageDescriptionFieldTwo

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/templateScopes/{templateScopeId}/templates/{templateId}/registrations

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/templateScopes/{templateScopeId}/templates/{templateId}/registrations

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/templateScopes/{templateScopeId}/templates/{templateId}/registrations

Response samples

200
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"id": "string",
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"usageDescriptionFieldOne": "string",
"usageDescriptionFieldTwo": "string",
"usageLocalizationKey": "string"
}
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

Registrations

Manage template registrations

Retrieve All Registrations

Returns all registrations within the given template scope.

path Parameters

templateScopeId

required

string <uuid>

Template Scope ID

query Parameters

size	any Page size
page	any The page to retrieve (starts at zero).
sort	any The field name to sort and the sort order (asc or desc) comma separated. Sortable fields are: id, templateId, usageLocalizationKey, usageDescriptionFieldOne, usageDescriptionFieldTwo

Responses

Response samples

200
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"id": "string",
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"usageDescriptionFieldOne": "string",
"usageDescriptionFieldTwo": "string",
"usageLocalizationKey": "string"
}
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

Retrieve Registration

Returns the registration for the given ID.

path Parameters

templateScopeId required	string <uuid> Template Scope ID
registrationId required	string Registration ID

Responses

Response samples

200
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"id": "string",
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"usageDescriptionFieldOne": "string",
"usageDescriptionFieldTwo": "string",
"usageLocalizationKey": "string"
}

MSP Managed Accounts

Manage MSP Customer Accounts, Integrator Accounts and Installer Accounts

Get Tenant Accounts

Get MSP-EC account list. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 45 calls can be made per second.
Each second 30 calls will be returned to be used.

Responses

Response samples

200
404
500

Content type

application/json

[{"account_id": "string",
"city": "string",
"country": "string",
"fax_number": "string",
"is_active": "string",
"mapping_url": "string",
"msp_label": "string",
"name": "string",
"parent_tenant_id": "string",
"phone_number": "string",
"postal_code": "string",
"service_effective_date": "string",
"service_expiration_date": "string",
"state": "string",
"street_address": "string",
"tenant_id": "string",
"tenant_type": "string",
"tier": "string"
}
]

Create Tenant Account

Create MSP-EC account. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 30 calls can be made per second.
Each second 15 calls will be returned to be used.

Request Body schema:
application/json
required

account_id	string [ 0 .. 255 ] characters
	Array of objects (MSP_Service_API_MspAdminRole) unique
admin_email	string [ 0 .. 255 ] characters
admin_firstname	string [ 0 .. 64 ] characters
admin_lastname	string [ 0 .. 64 ] characters
admin_role	string [ 0 .. 255 ] characters
city	string [ 0 .. 255 ] characters
country	string [ 0 .. 255 ] characters
	Array of objects (MSP_Service_API_EcDelegation) unique
fax_number	string [ 0 .. 255 ] characters
	object (MSP_Service_API_License)
mapping_url	string [ 0 .. 255 ] characters
name	string [ 2 .. 255 ] characters
phone_number	string [ 0 .. 255 ] characters
postal_code	string [ 0 .. 255 ] characters
service_effective_date	string
service_expiration_date	string
state	string [ 0 .. 255 ] characters
street_address	string [ 0 .. 255 ] characters
tenant_type	string [ 0 .. 25 ] characters
tier	string

Responses

Request samples

Payload

Content type

application/json

{"account_id": "string",
"admin_delegations": [{"msp_admin_id": "string",
"msp_admin_role": "string"
}
],
"admin_email": "string",
"admin_firstname": "string",
"admin_lastname": "string",
"admin_role": "string",
"city": "string",
"country": "string",
"delegations": [{"delegation_id": "string",
"delegation_type": "string",
"mspec_list": ["string"
],
"number_of_days": "string"
}
],
"fax_number": "string",
"licenses": {"assignments": [{"action": "string",
"assignmentId": 0,
"deviceSubType": "string",
"deviceType": "string",
"isTrial": true,
"quantity": 0
}
],
"subscription_end_date": "string",
"subscription_start_date": "string",
"trialAction": "string"
},
"mapping_url": "string",
"name": "string",
"phone_number": "string",
"postal_code": "string",
"service_effective_date": "string",
"service_expiration_date": "string",
"state": "string",
"street_address": "string",
"tenant_type": "string",
"tier": "string"
}

Response samples

202
400
500

Content type

application/json

"string"

Update Integrator/Installer

Add MSP EC to multiple integrator or installer.

Request Body schema: application/json
required

Array of objects (MSP_Service_API_AssignDelegatedRequest)

Responses

Request samples

Payload

Content type

application/json

{"AssignDelegatedRequest": [{"delegation_id": "string",
"delegation_type": "string",
"mspec_id": "string",
"number_of_days": "string"
}
]
}

Response samples

202
400
500

Content type

application/json

"string"

Firmware Upgrade Schedules

Creates a firmware upgrade schedule for the MSP customers specified.

Request Body schema: application/json
required

	object (MSP_Service_API_DataRequest) The bulk operation data.
operation required	string [ 1 .. 255 ] characters The bulk operation type.

Responses

Request samples

Payload

Content type

application/json

{"data": {"autoSchedule": {"days": "['Monday','Friday']",
"timeSlots": "['00:00-02:00','00:00-04:00']"
},
"manualSchedule": {"date": "2023-09-30",
"timeSlot": "00:00-02:00"
},
"mspEcList": ["string"
]
},
"operation": "AP_FIRMWARE_UPGRADE"
}

Response samples

202
400
500

Content type

application/json

"string"

Customer MSP Admin Associations

Associate multiple MSP admins to multiple customers. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 30 calls can be made per second.
Each second 15 calls will be returned to be used.

Request Body schema: application/json
required

Array of objects (MSP_Service_API_MspAdmin) [ 1 .. 200 ] items unique

Responses

Request samples

Payload

Content type

application/json

{"associations": [{"mspAdminRoles": [{"msp_admin_id": "string",
"msp_admin_role": "string"
}
],
"mspEcId": "string",
"operation": "string"
}
]
}

Response samples

202
400
500

Content type

application/json

"string"

Delete Tenant Account

Delete MSP-EC account. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 30 calls can be made per second.
Each second 15 calls will be returned to be used.

path Parameters

customerId

required

string

Responses

Response samples

202
500

Content type

application/json

{"requestId": "string",
"tenantId": "string"
}

Get Account Details

Get MSP-EC account details. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 45 calls can be made per second.
Each second 30 calls will be returned to be used.

path Parameters

customerId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"account_id": "string",
"city": "string",
"country": "string",
"fax_number": "string",
"is_active": "string",
"mapping_url": "string",
"msp_label": "string",
"name": "string",
"parent_tenant_id": "string",
"phone_number": "string",
"postal_code": "string",
"service_effective_date": "string",
"service_expiration_date": "string",
"state": "string",
"street_address": "string",
"tenant_id": "string",
"tenant_type": "string",
"tier": "string"
}

Partial Update of the MSP-EC

Patches the MSP-EC account. Only supports a change of status to deactivate the account and release its license or to reactive the account. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 30 calls can be made per second.
Each second 15 calls will be returned to be used.
vnd.ruckus.v1+json will be deprecated 4/15/2024.

path Parameters

customerId

required

string

Request Body schema:
application/json
required

operation

required

string [ 0 .. 255 ] characters

Responses

Request samples

Payload

Content type

application/json

{"operation": "string"
}

Response samples

202
400
500

Content type

application/json

Example

MSP_Service_API_OperationResponseObject

{"requestId": "string",
"response": { }
}

Update Tenant Account

Update MSP-EC account. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 30 calls can be made per second.
Each second 15 calls will be returned to be used.

path Parameters

customerId

required

string

Request Body schema: application/json
required

city	string [ 0 .. 255 ] characters
country	string [ 0 .. 255 ] characters
fax_number	string [ 0 .. 255 ] characters
	object (MSP_Service_API_License)
mapping_url	string [ 0 .. 255 ] characters
name required	string [ 0 .. 255 ] characters
phone_number	string [ 0 .. 255 ] characters
postal_code	string [ 0 .. 255 ] characters
service_effective_date required	string
service_expiration_date required	string
state	string [ 0 .. 255 ] characters
street_address	string [ 0 .. 255 ] characters
tier	string

Responses

Request samples

Payload

Content type

application/json

{"city": "string",
"country": "string",
"fax_number": "string",
"licenses": {"assignments": [{"action": "string",
"assignmentId": 0,
"deviceSubType": "string",
"deviceType": "string",
"isTrial": true,
"quantity": 0
}
],
"subscription_end_date": "string",
"subscription_start_date": "string",
"trialAction": "string"
},
"mapping_url": "string",
"name": "string",
"phone_number": "string",
"postal_code": "string",
"service_effective_date": "string",
"service_expiration_date": "string",
"state": "string",
"street_address": "string",
"tier": "string"
}

Response samples

202
400
403
500

Content type

application/json

{"requestId": "string",
"tenantId": "string"
}

Get Activation Status Deprecated

Get the activation status of MSP-EC. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 45 calls can be made per second.
Each second 30 calls will be returned to be used.

path Parameters

customerId

required

string

Responses

Response samples

200
404
500

Content type

application/json

{"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"parentId": "string",
"properties": {"property1": { },
"property2": { }
},
"switchActivated": true,
"tenantActivated": true,
"updatedDate": "2019-08-24T14:15:22Z",
"wifiActivated": true
}

Get Administrators

Get MSP-EC administrators along with their data. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 45 calls can be made per second.
Each second 30 calls will be returned to be used.

path Parameters

customerId

required

string

Responses

Response samples

200
404
500

Content type

application/json

"string"

Delete Administrator

Delete MSP-EC administrator. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 30 calls can be made per second.
Each second 15 calls will be returned to be used.

path Parameters

customerId required	string
adminId required	string

Responses

Response samples

500

Content type

application/json

{"errors": {"property1": { },
"property2": { }
}
}

Get Administrator Data

Get MSP-EC administrator data. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 45 calls can be made per second.
Each second 30 calls will be returned to be used.

path Parameters

customerId required	string
adminId required	string

Responses

Response samples

200
404
500

Content type

application/json

{"email": "string",
"first_name": "string",
"full_name": "string",
"last_name": "string",
"user_name": "string"
}

Update Administrator Data

Update MSP-EC administrator data. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 30 calls can be made per second.
Each second 15 calls will be returned to be used.

path Parameters

customerId required	string
adminId required	string

Request Body schema: application/json
required

email required	string [ 0 .. 255 ] characters
first_name required	string [ 0 .. 64 ] characters
full_name	string [ 0 .. 255 ] characters
last_name	string [ 0 .. 64 ] characters
user_name required	string [ 0 .. 255 ] characters

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"first_name": "string",
"full_name": "string",
"last_name": "string",
"user_name": "string"
}

Response samples

400
500

Content type

application/json

{"errors": {"property1": { },
"property2": { }
}
}

Disable RUCKUS Support

Set the status of Ruckus support delegation to disabled. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 30 calls can be made per second.
Each second 15 calls will be returned to be used.

path Parameters

customerId

required

string

Responses

Response samples

204
400
500

Content type

application/json

"string"

Get RUCKUS Support Status

Get the status of Ruckus support delegation for the specific MSP-EC account. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 45 calls can be made per second.
Each second 30 calls will be returned to be used.

path Parameters

customerId

required

string

Responses

Response samples

200
404
500

Content type

application/json

"string"

Enable RUCKUS Support

Set the status of Ruckus support delegation to enabled. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 30 calls can be made per second.
Each second 15 calls will be returned to be used.

path Parameters

customerId

required

string

Responses

Response samples

201
500

Content type

application/json

"string"

Send Email Invitation

Send email invitation to MSP-EC admin. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 30 calls can be made per second.
Each second 15 calls will be returned to be used.

path Parameters

customerId

required

string

Request Body schema: application/json
required

admin_email required	string [ 0 .. 255 ] characters
resend	boolean

Responses

Request samples

Payload

Content type

application/json

{"admin_email": "string",
"resend": true
}

Response samples

400
500

Content type

application/json

{"errors": {"property1": { },
"property2": { }
}
}

Get Customized Logo URL

Get the customized logo URL by MSP-EC account ID for the dashboard page. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 45 calls can be made per second.
Each second 30 calls will be returned to be used.

path Parameters

customerId

required

string

Responses

Response samples

200
404
500

Content type

application/json

"string"

Get Assigned Customers

Add MSP ECs to integrator or installer. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 45 calls can be made per second.
Each second 30 calls will be returned to be used.

path Parameters

integratorId

required

string

query Parameters

delegationType

required

string

Responses

Response samples

200
404
500

Content type

application/json

{"delegated_to": "string",
"delegation_type": "string",
"expiry_date": "string",
"mspec_list": ["string"
]
}

Update Integrator/Installer

Add MSP ECs to integrator or installer. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 30 calls can be made per second.
Each second 15 calls will be returned to be used.

path Parameters

integratorId

required

string

Request Body schema: application/json
required

delegation_type required	string
isManageAllEcs	boolean
mspec_list required	Array of strings unique
number_of_days	string

Responses

Request samples

Payload

Content type

application/json

{"delegation_type": "string",
"isManageAllEcs": true,
"mspec_list": ["string"
],
"number_of_days": "string"
}

Response samples

202
400
500

Content type

application/json

"string"

MSP Account Details

Update Installer/Integrator Admins

Update installer/integrator admins to a customer. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 30 calls can be made per second.
Each second 15 calls will be returned to be used.

path Parameters

customerId

required

string

Request Body schema: application/json
required

delegation_type required	string
required	Array of objects (MSP_Service_API_MspAdminRole)

Responses

Request samples

Payload

Content type

application/json

{"delegation_type": "string",
"mspec_list": [{"msp_admin_id": "string",
"msp_admin_role": "string"
}
]
}

Response samples

202
400
500

Content type

application/json

{"requestId": "string",
"tenantId": "string"
}

Get Delegated Administrators

Get the list of MSP administrators authorized to manage this MSP-EC. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 45 calls can be made per second.
Each second 30 calls will be returned to be used.

path Parameters

customerId

required

string

Responses

Response samples

200
404
500

Content type

application/json

[{"msp_admin_id": "string",
"msp_admin_role": "string"
}
]

Update Administrators

Update the list of MSP administrators authorized to manage this MSP-EC. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 30 calls can be made per second.
Each second 15 calls will be returned to be used.

path Parameters

customerId

required

string

Request Body schema: application/json
required

Array

msp_admin_id required	string
msp_admin_role required	string [ 0 .. 255 ] characters

Responses

Request samples

Payload

Content type

application/json

[{"msp_admin_id": "string",
"msp_admin_role": "string"
}
]

Response samples

202
400
500

Content type

application/json

{"requestId": "string",
"tenantId": "string"
}

Get MSP Data

Get MSP data for account. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 45 calls can be made per second.
Each second 30 calls will be returned to be used.

Responses

Response samples

200
404
500

Content type

application/json

{"alarm_notification_logo_uuid": "string",
"change_password_url": "string",
"contact_support_behavior": "string",
"contact_support_url": "string",
"default_logo_uuid": "string",
"logo_uuid": "string",
"mlisa_logo_uuid": "string",
"mspLogoFileDataList": [{"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"logo_file_name": "string",
"logo_fileuuid": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"msp_email": "string",
"msp_external_id": "string",
"msp_fqdn": "string",
"msp_label": "string",
"msp_phone": "string",
"msp_tenant_name": "string",
"msp_website": "string",
"my_open_case_behavior": "string",
"my_open_case_url": "string",
"open_case_behavior": "string",
"open_case_url": "string",
"ping_login_logo_uuid": "string",
"ping_notification_logo_uuid": "string",
"preferredWisprProvider": {"acct": {"primary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
},
"secondary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
}
},
"apiKey": "string",
"apiSecret": "string",
"auth": {"primary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
},
"secondary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
}
},
"createdDate": "2019-08-24T14:15:22Z",
"customExternalProvider": true,
"id": "string",
"parentId": "string",
"providerName": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
}

Add Label

Add MSP label to facilitate MSP-EC login. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 30 calls can be made per second.
Each second 15 calls will be returned to be used.

Request Body schema: application/json
required

alarm_notification_logo_uuid	string^$\|[a-zA-Z0-9~\.+_-]+
change_password_url	string [ 0 .. 255 ] characters ^$\|(http\|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...
contact_support_behavior	string [ 0 .. 255 ] characters
contact_support_url	string [ 0 .. 255 ] characters ^$\|(http\|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...
default_logo_uuid	string^$\|[a-zA-Z0-9~\.+_-]+
logo_uuid	string^$\|[a-zA-Z0-9~\.+_-]+
mlisa_logo_uuid	string^$\|[a-zA-Z0-9~\.+_-]+
	Array of objects (MSP_Service_API_MspLogoFileData)
msp_email	string [ 0 .. 255 ] characters
msp_fqdn	string [ 0 .. 255 ] characters ^$\|[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9](\...
msp_label required	string[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]
msp_phone	string [ 0 .. 255 ] characters
msp_website	string [ 0 .. 255 ] characters ^$\|(http\|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...
my_open_case_behavior	string [ 0 .. 255 ] characters
my_open_case_url	string [ 0 .. 255 ] characters ^$\|(http\|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...
open_case_behavior	string [ 0 .. 255 ] characters
open_case_url	string [ 0 .. 255 ] characters ^$\|(http\|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...
ping_login_logo_uuid	string^$\|[a-zA-Z0-9~\.+_-]+
ping_notification_logo_uuid	string^$\|[a-zA-Z0-9~\.+_-]+
	object (MSP_Service_API_PreferredWisprProvider)

Responses

Request samples

Payload

Content type

application/json

{"alarm_notification_logo_uuid": "string",
"change_password_url": "string",
"contact_support_behavior": "string",
"contact_support_url": "string",
"default_logo_uuid": "string",
"logo_uuid": "string",
"mlisa_logo_uuid": "string",
"mspLogoFileDataList": [{"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"logo_file_name": "string",
"logo_fileuuid": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"msp_email": "string",
"msp_fqdn": "string",
"msp_label": "string",
"msp_phone": "string",
"msp_website": "string",
"my_open_case_behavior": "string",
"my_open_case_url": "string",
"open_case_behavior": "string",
"open_case_url": "string",
"ping_login_logo_uuid": "string",
"ping_notification_logo_uuid": "string",
"preferredWisprProvider": {"acct": {"primary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
},
"secondary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
}
},
"apiKey": "string",
"apiSecret": "string",
"auth": {"primary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
},
"secondary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
}
},
"createdDate": "2019-08-24T14:15:22Z",
"customExternalProvider": true,
"id": "string",
"parentId": "string",
"providerName": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
}

Response samples

202
400
500

Content type

application/json

{"requestId": "string",
"tenantId": "string"
}

Update MSP Data

Update MSP data for account. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 30 calls can be made per second.
Each second 15 calls will be returned to be used.

Request Body schema: application/json
required

alarm_notification_logo_uuid	string^$\|[a-zA-Z0-9~\.+_-]+
change_password_url	string [ 0 .. 255 ] characters ^$\|(http\|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...
contact_support_behavior	string [ 0 .. 255 ] characters
contact_support_url	string [ 0 .. 255 ] characters ^$\|(http\|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...
default_logo_uuid	string^$\|[a-zA-Z0-9~\.+_-]+
logo_uuid	string^$\|[a-zA-Z0-9~\.+_-]+
mlisa_logo_uuid	string^$\|[a-zA-Z0-9~\.+_-]+
	Array of objects (MSP_Service_API_MspLogoFileData)
msp_email	string [ 0 .. 255 ] characters
msp_fqdn	string [ 0 .. 255 ] characters ^$\|[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9](\...
msp_label required	string[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]
msp_phone	string [ 0 .. 255 ] characters
msp_website	string [ 0 .. 255 ] characters ^$\|(http\|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...
my_open_case_behavior	string [ 0 .. 255 ] characters
my_open_case_url	string [ 0 .. 255 ] characters ^$\|(http\|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...
open_case_behavior	string [ 0 .. 255 ] characters
open_case_url	string [ 0 .. 255 ] characters ^$\|(http\|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...
ping_login_logo_uuid	string^$\|[a-zA-Z0-9~\.+_-]+
ping_notification_logo_uuid	string^$\|[a-zA-Z0-9~\.+_-]+
	object (MSP_Service_API_PreferredWisprProvider)

Responses

Request samples

Payload

Content type

application/json

{"alarm_notification_logo_uuid": "string",
"change_password_url": "string",
"contact_support_behavior": "string",
"contact_support_url": "string",
"default_logo_uuid": "string",
"logo_uuid": "string",
"mlisa_logo_uuid": "string",
"mspLogoFileDataList": [{"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"logo_file_name": "string",
"logo_fileuuid": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"msp_email": "string",
"msp_fqdn": "string",
"msp_label": "string",
"msp_phone": "string",
"msp_website": "string",
"my_open_case_behavior": "string",
"my_open_case_url": "string",
"open_case_behavior": "string",
"open_case_url": "string",
"ping_login_logo_uuid": "string",
"ping_notification_logo_uuid": "string",
"preferredWisprProvider": {"acct": {"primary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
},
"secondary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
}
},
"apiKey": "string",
"apiSecret": "string",
"auth": {"primary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
},
"secondary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
}
},
"createdDate": "2019-08-24T14:15:22Z",
"customExternalProvider": true,
"id": "string",
"parentId": "string",
"providerName": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
}

Response samples

202
400
500

Content type

application/json

{"requestId": "string",
"tenantId": "string"
}

Get Base URL

Get base URL for MSP. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 45 calls can be made per second.
Each second 30 calls will be returned to be used.

Responses

Response samples

200
500

Content type

application/json

"string"

Check MSP Label

Check if the MSP label is used or not. Rate Limit For the Managed Service Provider REST API the following will be true:

Limits are applied to each tenant.
A maximum of 45 calls can be made per second.
Each second 30 calls will be returned to be used.

path Parameters

mspLabel

required

string

Responses

Response samples

200
404
500

Content type

application/json

"string"

Manage Entitlements

Manage Entitlement Assignment Endpoints

Retrieve Assignments

Retrieve all the assignments (created and revoked).

Responses

Response samples

200

Content type

application/json

[{"createdBy": "string",
"dateAssignmentCreated": "2019-08-24T14:15:22Z",
"dateAssignmentRevoked": "2019-08-24T14:15:22Z",
"dateEffective": "2019-08-24T14:15:22Z",
"dateExpires": "2019-08-24T14:15:22Z",
"deviceSubType": "string",
"deviceType": "MSP_WIFI",
"id": 0,
"mspEcTenantId": "string",
"mspTenantId": "string",
"quantity": 0,
"revokedBy": "string",
"status": "FUTURE",
"trialAssignment": true
}
]

Retrieve Device Type Summary

Retrieve a summary by device type of all an MSP's entitlement assignments.

Responses

Response samples

200

Content type

application/json

[{"courtesyMspEntitlementsUsed": true,
"deviceSubType": "string",
"deviceType": "MSP_WIFI",
"quantity": 0,
"remainingDevices": 0,
"trial": true
}
]

Get Entitlement Usage Report

Get the entitlement usage report.

query Parameters

startDate	string The first date included in the usage report, for example, startDate=yyyy-mm-dd; if omitted, the startDate is set to last month's first date.
endDate	string The end date included in the usage report, for example, endDate=yyyy-mm-dd; if omitted, the endDate is set to last month's last date.
month	string month=mm
year	string year=yyyy
mspEcTenantId	string Specific MSP EC tenant ID
deviceDetails	boolean Default: false True to include device detail in the report. False to exclude device detail in the report.

header Parameters

Content-Type

required

string

Responses

Response samples

200

Content type

application/json

{ }

Retrieve MSP Banner Data

Retrieve banner data for the MSP's (bulk) entitlements. Banners provide information about MSP (bulk) entitlements that are either near their expiry or have expired.

Responses

Response samples

200

Content type

application/json

[{"affectedDeviceCount": 0,
"deviceCount": 0,
"deviceType": "MSP_WIFI",
"effectDate": "2019-08-24T14:15:22Z",
"effectDays": 0,
"multipleLicense": true,
"type": "string"
}
]

MSP Entitlements

Retrieve all the MSP's (bulk) entitlements.

Responses

Response samples

200

Content type

application/json

[{"deviceSubType": "string",
"deviceType": "MSP_WIFI",
"effectiveDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isTrial": true,
"lastNotificationDate": "2019-08-24T14:15:22Z",
"quantity": 0,
"sku": "string",
"status": "FUTURE"
}
]

Refresh MSP Entitlements

Refresh MSP entitlements.

query Parameters

refresh

boolean

Responses

Response samples

200

Content type

application/json

{ }

Identity Group

Returns the Identity Groups

query Parameters

required

object (OpenAPI_definition_Pageable)

Parameters for paging

Responses

Response samples

200

Content type

application/json

{"content": [{"certificateTemplateId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"dpskPoolId": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identities": [{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"deviceCount": 0,
"devices": [{"createdAt": "2019-08-24T14:15:22Z",
"hasMacRegistered": true,
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"lastSeenAt": "2019-08-24T14:15:22Z",
"macAddress": "string",
"recentStatus": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"dpskGuid": "string",
"dpskPassphrase": "string",
"email": "john.doe@example.com",
"ethernetPorts": [{"createdAt": "2019-08-24T14:15:22Z",
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"name": "string",
"portIndex": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
"primary": true,
"revoked": true,
"switches": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"portId": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"vlan": 1,
"vni": 8388608
}
],
"identityCount": 0,
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"macRegistrationPoolId": "string",
"name": "string",
"personalIdentityNetworkId": "string",
"propertyId": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Create an Identity Group

Request Body schema:
application/json
required

certificateTemplateId	string Then identifier of the certificate template associated with the group.
description	string <= 255 characters The description for the group.
dpskPoolId	string The identifier of the DPSK pool associated with the group.
	Array of objects (OpenAPI_definition_Link)
macRegistrationPoolId	string The identifier of the MAC registration pool associated with the group.
name required	string <= 255 characters The name for the group.

Responses

Request samples

Payload

Content type

application/json

{"certificateTemplateId": "string",
"description": "string",
"dpskPoolId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"macRegistrationPoolId": "string",
"name": "string"
}

Response samples

201
202
400

Content type

application/json

{"certificateTemplateId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"dpskPoolId": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identities": [{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"deviceCount": 0,
"devices": [{"createdAt": "2019-08-24T14:15:22Z",
"hasMacRegistered": true,
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"lastSeenAt": "2019-08-24T14:15:22Z",
"macAddress": "string",
"recentStatus": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"dpskGuid": "string",
"dpskPassphrase": "string",
"email": "john.doe@example.com",
"ethernetPorts": [{"createdAt": "2019-08-24T14:15:22Z",
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"name": "string",
"portIndex": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
"primary": true,
"revoked": true,
"switches": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"portId": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"vlan": 1,
"vni": 8388608
}
],
"identityCount": 0,
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"macRegistrationPoolId": "string",
"name": "string",
"personalIdentityNetworkId": "string",
"propertyId": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}

Export the Identity Groups Into a CSV File

query Parameters

required	object (OpenAPI_definition_Pageable) Parameters for paging
timezone	string Default: "UTC"
date-format	string Default: "yyyyMMddHHmmss" Format will be applied for date values. Default value is "dd/MM/yyyy HH:mm"

Request Body schema:
application/json
required

certificateTemplateId	string
dpskPoolId	string
groupIds	Array of strings <uuid> [ items <uuid > ]
keyword	string
macRegistrationPoolId	string
personalIdentityNetworkId	string
propertyId	string

Responses

Request samples

Payload

Content type

application/json

{"certificateTemplateId": "string",
"dpskPoolId": "string",
"groupIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"keyword": "string",
"macRegistrationPoolId": "string",
"personalIdentityNetworkId": "string",
"propertyId": "string"
}

Query the Identity Groups

query Parameters

required

object (OpenAPI_definition_Pageable)

Parameters for paging

Request Body schema:
application/json
required

certificateTemplateId	string
dpskPoolId	string
groupIds	Array of strings <uuid> [ items <uuid > ]
keyword	string
macRegistrationPoolId	string
personalIdentityNetworkId	string
propertyId	string

Responses

Request samples

Payload

Content type

application/json

{"certificateTemplateId": "string",
"dpskPoolId": "string",
"groupIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"keyword": "string",
"macRegistrationPoolId": "string",
"personalIdentityNetworkId": "string",
"propertyId": "string"
}

Response samples

200

Content type

application/json

{"content": [{"certificateTemplateId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"dpskPoolId": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identities": [{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"deviceCount": 0,
"devices": [{"createdAt": "2019-08-24T14:15:22Z",
"hasMacRegistered": true,
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"lastSeenAt": "2019-08-24T14:15:22Z",
"macAddress": "string",
"recentStatus": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"dpskGuid": "string",
"dpskPassphrase": "string",
"email": "john.doe@example.com",
"ethernetPorts": [{"createdAt": "2019-08-24T14:15:22Z",
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"name": "string",
"portIndex": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
"primary": true,
"revoked": true,
"switches": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"portId": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"vlan": 1,
"vni": 8388608
}
],
"identityCount": 0,
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"macRegistrationPoolId": "string",
"name": "string",
"personalIdentityNetworkId": "string",
"propertyId": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Delete the Identity Group

path Parameters

id

required

string <uuid>

Group id

Responses

Response samples

Content type

application/json

{ }

Returns the Specific Identity Group

path Parameters

id

required

string <uuid>

Group id

Responses

Response samples

200
400
404

Content type

application/json

{"certificateTemplateId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"dpskPoolId": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identities": [{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"deviceCount": 0,
"devices": [{"createdAt": "2019-08-24T14:15:22Z",
"hasMacRegistered": true,
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"lastSeenAt": "2019-08-24T14:15:22Z",
"macAddress": "string",
"recentStatus": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"dpskGuid": "string",
"dpskPassphrase": "string",
"email": "john.doe@example.com",
"ethernetPorts": [{"createdAt": "2019-08-24T14:15:22Z",
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"name": "string",
"portIndex": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
"primary": true,
"revoked": true,
"switches": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"portId": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"vlan": 1,
"vni": 8388608
}
],
"identityCount": 0,
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"macRegistrationPoolId": "string",
"name": "string",
"personalIdentityNetworkId": "string",
"propertyId": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}

Update the Identity Group

path Parameters

id

required

string <uuid>

Group id

Request Body schema:
application/json
required

certificateTemplateId	string Then identifier of the certificate template associated with the group.
description	string <= 255 characters The description for the group.
dpskPoolId	string The identifier of the DPSK pool associated with the group.
	Array of objects (OpenAPI_definition_Link)
macRegistrationPoolId	string The identifier of the MAC registration pool associated with the group.
name required	string <= 255 characters The name for the group.

Responses

Request samples

Payload

Content type

application/json

{"certificateTemplateId": "string",
"description": "string",
"dpskPoolId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"macRegistrationPoolId": "string",
"name": "string"
}

Response samples

200
202
400
403
404

Content type

application/json

{"certificateTemplateId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"dpskPoolId": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identities": [{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"deviceCount": 0,
"devices": [{"createdAt": "2019-08-24T14:15:22Z",
"hasMacRegistered": true,
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"lastSeenAt": "2019-08-24T14:15:22Z",
"macAddress": "string",
"recentStatus": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"dpskGuid": "string",
"dpskPassphrase": "string",
"email": "john.doe@example.com",
"ethernetPorts": [{"createdAt": "2019-08-24T14:15:22Z",
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"name": "string",
"portIndex": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
"primary": true,
"revoked": true,
"switches": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"portId": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"vlan": 1,
"vni": 8388608
}
],
"identityCount": 0,
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"macRegistrationPoolId": "string",
"name": "string",
"personalIdentityNetworkId": "string",
"propertyId": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}

Update the DPSK Pool Association for Identity Group

path Parameters

id required	string <uuid> Group id
dpskPoolId required	string DPSK pool id

Responses

Response samples

202
400
404

Content type

application/json

{"id": "string",
"requestId": "string"
}

Update the MAC Registration Association for Identity Group

path Parameters

id required	string <uuid> Group id
poolId required	string MAC registration pool id

Responses

Response samples

202
400
404

Content type

application/json

{"id": "string",
"requestId": "string"
}

Identity

Returns Identities in All Groups

query Parameters

required

object (OpenAPI_definition_Pageable)

Parameters for paging

Responses

Response samples

200

Content type

application/json

{"content": [{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"deviceCount": 0,
"devices": [{"createdAt": "2019-08-24T14:15:22Z",
"hasMacRegistered": true,
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"lastSeenAt": "2019-08-24T14:15:22Z",
"macAddress": "string",
"recentStatus": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"dpskGuid": "string",
"dpskPassphrase": "string",
"email": "john.doe@example.com",
"ethernetPorts": [{"createdAt": "2019-08-24T14:15:22Z",
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"name": "string",
"portIndex": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
"primary": true,
"revoked": true,
"switches": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"portId": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"vlan": 1,
"vni": 8388608
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Export the Identities Into a CSV File

query Parameters

required	object (OpenAPI_definition_Pageable) Parameters for paging
timezone	string Default: "UTC"
date-format	string Default: "yyyyMMddHHmmss" Format will be applied for date values. Default value is "dd/MM/yyyy HH:mm"

Request Body schema:
application/json
required

dpskPoolId	string
groupId	string <uuid>
ids	Array of strings <uuid> [ items <uuid > ]
keyword	string
propertyId	string

Responses

Request samples

Payload

Content type

application/json

{"dpskPoolId": "string",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"keyword": "string",
"propertyId": "string"
}

Query Identities

query Parameters

required

object (OpenAPI_definition_Pageable)

Parameters for paging

Request Body schema:
application/json
required

dpskPoolId	string
groupId	string <uuid>
ids	Array of strings <uuid> [ items <uuid > ]
keyword	string
propertyId	string

Responses

Request samples

Payload

Content type

application/json

{"dpskPoolId": "string",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"keyword": "string",
"propertyId": "string"
}

Response samples

200

Content type

application/json

{"content": [{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"deviceCount": 0,
"devices": [{"createdAt": "2019-08-24T14:15:22Z",
"hasMacRegistered": true,
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"lastSeenAt": "2019-08-24T14:15:22Z",
"macAddress": "string",
"recentStatus": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"dpskGuid": "string",
"dpskPassphrase": "string",
"email": "john.doe@example.com",
"ethernetPorts": [{"createdAt": "2019-08-24T14:15:22Z",
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"name": "string",
"portIndex": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
"primary": true,
"revoked": true,
"switches": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"portId": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"vlan": 1,
"vni": 8388608
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Delete the Specific Identities in a Group

path Parameters

groupId

required

string <uuid>

Group id

Request Body schema:
application/json
required

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type

application/json

{ }

Returns the Identities in a Specific Group

path Parameters

groupId

required

string <uuid>

Group id

query Parameters

required

object (OpenAPI_definition_Pageable)

Parameters for paging

Responses

Response samples

200
400

Content type

application/json

[{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"deviceCount": 0,
"devices": [{"createdAt": "2019-08-24T14:15:22Z",
"hasMacRegistered": true,
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"lastSeenAt": "2019-08-24T14:15:22Z",
"macAddress": "string",
"recentStatus": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"dpskGuid": "string",
"dpskPassphrase": "string",
"email": "john.doe@example.com",
"ethernetPorts": [{"createdAt": "2019-08-24T14:15:22Z",
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"name": "string",
"portIndex": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
"primary": true,
"revoked": true,
"switches": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"portId": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"vlan": 1,
"vni": 8388608
}
]

Create an Identity Into a Specific Group

path Parameters

groupId

required

string <uuid>

Group id

Request Body schema:
application/json
required

description	string <= 255 characters The description for the identity.
	Array of objects (OpenAPI_definition_Device) The list of devices for the identity.
dpskPassphrase	string The passphrase of the DPSK for the identity, if it is set to null after the DPSK has been created, then it will ask the DPSK service to reset the passphrase.
email	string^[\w!#$%&’+/=?`{\|}~^-]+(?:\.[\w!#$%&’+/=?`{... The email for the identity.
	Array of objects (OpenAPI_definition_EthernetPort) The list of ethernet port for the identity.
expirationDate	string <date-time> The expiration date for the metering profile of this identity.
	Array of objects (OpenAPI_definition_Link)
meteringProfileId	string <uuid> The identifier of the metering profile.
name required	string <= 255 characters The name for the identity.
primary	boolean
revoked	boolean The field to determine if identity is revoked.
vlan	integer <int32> [ 1 .. 4094 ] The VLAN for the identity.

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"devices": [{"macAddress": "string"
}
],
"dpskPassphrase": "string",
"email": "john.doe@example.com",
"ethernetPorts": [{"macAddress": "string",
"name": "string",
"portIndex": 0
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
"name": "string",
"primary": true,
"revoked": true,
"vlan": 1
}

Response samples

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"deviceCount": 0,
"devices": [{"createdAt": "2019-08-24T14:15:22Z",
"hasMacRegistered": true,
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"lastSeenAt": "2019-08-24T14:15:22Z",
"macAddress": "string",
"recentStatus": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"dpskGuid": "string",
"dpskPassphrase": "string",
"email": "john.doe@example.com",
"ethernetPorts": [{"createdAt": "2019-08-24T14:15:22Z",
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"name": "string",
"portIndex": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
"primary": true,
"revoked": true,
"switches": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"portId": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"vlan": 1,
"vni": 8388608
}

Import Identities Into the Specified Identity Group

path Parameters

groupId

required

string <uuid>

Request Body schema: multipart/form-data

file

required

string <binary>

Responses

Response samples

Content type

application/json

[{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"deviceCount": 0,
"devices": [{"createdAt": "2019-08-24T14:15:22Z",
"hasMacRegistered": true,
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"lastSeenAt": "2019-08-24T14:15:22Z",
"macAddress": "string",
"recentStatus": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"dpskGuid": "string",
"dpskPassphrase": "string",
"email": "john.doe@example.com",
"ethernetPorts": [{"createdAt": "2019-08-24T14:15:22Z",
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"name": "string",
"portIndex": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
"primary": true,
"revoked": true,
"switches": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"portId": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"vlan": 1,
"vni": 8388608
}
]

Delete the Identity

path Parameters

groupId required	string <uuid> Group id
id required	string <uuid> Identity id

Responses

Response samples

Content type

application/json

{ }

Returns the Identity

path Parameters

groupId required	string <uuid> Group id
id required	string <uuid> Identity id

Responses

Response samples

200
400
404

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"deviceCount": 0,
"devices": [{"createdAt": "2019-08-24T14:15:22Z",
"hasMacRegistered": true,
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"lastSeenAt": "2019-08-24T14:15:22Z",
"macAddress": "string",
"recentStatus": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"dpskGuid": "string",
"dpskPassphrase": "string",
"email": "john.doe@example.com",
"ethernetPorts": [{"createdAt": "2019-08-24T14:15:22Z",
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"name": "string",
"portIndex": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
"primary": true,
"revoked": true,
"switches": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"portId": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"vlan": 1,
"vni": 8388608
}

Update the Identity

path Parameters

groupId required	string <uuid> Group id
id required	string <uuid> Identity id

Request Body schema:
application/json
required

description	string <= 255 characters The description for the identity.
	Array of objects (OpenAPI_definition_Device) The list of devices for the identity.
dpskPassphrase	string The passphrase of the DPSK for the identity, if it is set to null after the DPSK has been created, then it will ask the DPSK service to reset the passphrase.
email	string^[\w!#$%&’+/=?`{\|}~^-]+(?:\.[\w!#$%&’+/=?`{... The email for the identity.
	Array of objects (OpenAPI_definition_EthernetPort) The list of ethernet port for the identity.
expirationDate	string <date-time> The expiration date for the metering profile of this identity.
	Array of objects (OpenAPI_definition_Link)
meteringProfileId	string <uuid> The identifier of the metering profile.
name required	string <= 255 characters The name for the identity.
primary	boolean
revoked	boolean The field to determine if identity is revoked.
vlan	integer <int32> [ 1 .. 4094 ] The VLAN for the identity.

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"devices": [{"macAddress": "string"
}
],
"dpskPassphrase": "string",
"email": "john.doe@example.com",
"ethernetPorts": [{"macAddress": "string",
"name": "string",
"portIndex": 0
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
"name": "string",
"primary": true,
"revoked": true,
"vlan": 1
}

Response samples

200
202
400
403
404

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"deviceCount": 0,
"devices": [{"createdAt": "2019-08-24T14:15:22Z",
"hasMacRegistered": true,
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"lastSeenAt": "2019-08-24T14:15:22Z",
"macAddress": "string",
"recentStatus": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"dpskGuid": "string",
"dpskPassphrase": "string",
"email": "john.doe@example.com",
"ethernetPorts": [{"createdAt": "2019-08-24T14:15:22Z",
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"name": "string",
"portIndex": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
],
"meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
"name": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
"primary": true,
"revoked": true,
"switches": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"macAddress": "string",
"portId": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"vlan": 1,
"vni": 8388608
}

Create Devices Into the Identity

path Parameters

groupId required	string <uuid> Group id
id required	string <uuid> Identity id

Request Body schema:
application/json
required

Array

macAddress

required

string^([0-9A-F]{2}-){5}([0-9A-F]{2})$

The MAC of the device.

Responses

Request samples

Payload

Content type

application/json

[{"macAddress": "string"
}
]

Response samples

201
202
400
403
404

Content type

application/json

[{"createdAt": "2019-08-24T14:15:22Z",
"hasMacRegistered": true,
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"lastSeenAt": "2019-08-24T14:15:22Z",
"macAddress": "string",
"recentStatus": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
]

Delete the Device from the Identity

path Parameters

groupId required	string <uuid> Group id
id required	string <uuid> Identity id
macAddress required	string Device's MAC

Responses

Response samples

200
202
400
403
404

Content type

application/json

{ }

Delete the Ethernet Port from the Identity

path Parameters

groupId required	string <uuid> Group id
id required	string <uuid> Identity id
macAddress required	string Ethernet Port's MAC
portIndex required	integer <int32> Ethernet Port's port index

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/identityGroups/{groupId}/identities/{id}/ethernetPorts/{macAddress}/{portIndex}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/identityGroups/{groupId}/identities/{id}/ethernetPorts/{macAddress}/{portIndex}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/identityGroups/{groupId}/identities/{id}/ethernetPorts/{macAddress}/{portIndex}

Response samples

200
202
400
403
404

Content type

application/json

{ }

Update Ethernet Ports for the Identity

path Parameters

groupId required	string <uuid> Group id
venueId required	string Venue id
id required	string <uuid> Identity id

Request Body schema:
application/json
required

Array

macAddress required	string^([0-9A-F]{2}-){5}([0-9A-F]{2})$ The MAC address for the ethernet port.
name required	string <= 255 characters The name for the ethernet port.
portIndex required	integer <int32> The index of the port of the ethernet port.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/identityGroups/{groupId}/identities/{id}/venues/{venueId}/ethernetPorts

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/identityGroups/{groupId}/identities/{id}/venues/{venueId}/ethernetPorts

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/identityGroups/{groupId}/identities/{id}/venues/{venueId}/ethernetPorts

Request samples

Payload

Content type

application/json

[{"macAddress": "string",
"name": "string",
"portIndex": 0
}
]

Response samples

202
400
404

Content type

application/json

{"id": "string",
"requestId": "string"
}

Retry the VNI Allocation for the Identity

path Parameters

groupId required	string <uuid> Group id
id required	string <uuid> Identity id

Responses

Response samples

200
400
403
404

Content type

application/json

{ }

Property Configuration

Manages property configuration for venue

Gets Property Configurations

Gets the list of property configurations paged.

query Parameters

size	integer <int32> Page size
page	integer <int32> The page to retrieve (starts at one).
sort	string The field name to sort, comma seperated from the sort order (asc or desc).

Responses

Response samples

200

Content type

application/json

{"content": [{ }
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Query Property Configurations

Gets the list of property configurations using the specified query.

query Parameters

excludeContent

boolean

Default: false

Indicates that the content should be excluded from the query and only count and size data returned.

Request Body schema: application/json

Data for the requested query

fields	Array of strings Fields to select.
	object Filter names and its values as filter.
page required	integer <int32> Page number.
pageSize required	integer <int32> Number of pages.
sortField	string Sort field.
sortOrder required	string Enum: "ASC" "DESC" Sorting direction.

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"property1": { },
"property2": { }
},
"page": 0,
"pageSize": 0,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200
400

Content type

application/json

{"content": [{ }
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Get Property Configuration

Gets property configuration for the requested venue Id.

path Parameters

venueId

required

string

Venue Id

Responses

Response samples

200
400
404
500

Content type

application/hal+json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"address": {"addressLine": "string",
"city": "string",
"country": "string"
},
"communicationConfig": {"guestPassphraseChangeHtmlRegId": "ac96e5f3-b468-4f5c-9504-ff1d443c817d",
"guestPassphraseChangeTextRegId": "5453bcc0-95c4-485e-a0c4-b5fe5f0114f1",
"portAssignmentHtmlRegId": "eba4b4e5-4b09-427f-a4e5-d5e17892e9f5",
"portAssignmentTextRegId": "24ebe9a5-532a-4f77-93ac-cfd4c2182119",
"portalAccessResetHtmlRegId": "22634e9e-dad7-4cef-bc18-8c676b0bd10a",
"portalAccessResetTextRegId": "3a59b191-53e2-4e40-92fb-d05b8ffef68a",
"sendEmail": true,
"sendSms": true,
"type": "string",
"unitAssignmentHtmlRegId": "030c589c-86a6-447e-9b5a-ed78b23438c0",
"unitAssignmentTextRegId": "ef9733cb-2597-44db-9243-fac282634b61",
"unitPassphraseChangeHtmlRegId": "e94c6646-5201-4506-b50f-0c1231eb96b9",
"unitPassphraseChangeTextRegId": "7d35f554-42b9-425d-87ac-821729e4b3be"
},
"description": "string",
"personaGroupId": "string",
"residentPortalId": "e8c784df-e1dd-4a2f-bf68-3c29e8c7e9da",
"status": "DISABLED",
"unitConfig": {"guestAllowed": true,
"maxUnitCount": 0,
"residentApiAllowed": true,
"residentPortalAllowed": true,
"type": "string",
"useMaxUnitCount": true
},
"venueId": "string",
"venueName": "string"
}

Selectively Update Property Configuration

Allows the user to selectively update property management configuration on the specified venue.

path Parameters

venueId

required

string

Venue Id

Request Body schema: application/json
required

Property configuration to enable

	object (OpenAPI_definition_Address) Venue address.
	object (OpenAPI_definition_CommunicationConfigDto) Configuration for communicating unit change events
description	string
personaGroupId required	string Persona group identifier.
residentPortalId	string <uuid> Resident portal identifier.
status required	string Default: "DISABLED" Enum: "DISABLED" "ENABLED" Status of the property
	object (OpenAPI_definition_UnitConfigDto) Basic configuration on property units
venueId	string
venueName required	string Venue name.

Responses

Request samples

Payload

Content type

application/json

{"address": {"addressLine": "string",
"city": "string",
"country": "string"
},
"communicationConfig": {"guestPassphraseChangeHtmlRegId": "ac96e5f3-b468-4f5c-9504-ff1d443c817d",
"guestPassphraseChangeTextRegId": "5453bcc0-95c4-485e-a0c4-b5fe5f0114f1",
"portAssignmentHtmlRegId": "eba4b4e5-4b09-427f-a4e5-d5e17892e9f5",
"portAssignmentTextRegId": "24ebe9a5-532a-4f77-93ac-cfd4c2182119",
"portalAccessResetHtmlRegId": "22634e9e-dad7-4cef-bc18-8c676b0bd10a",
"portalAccessResetTextRegId": "3a59b191-53e2-4e40-92fb-d05b8ffef68a",
"sendEmail": true,
"sendSms": true,
"type": "string",
"unitAssignmentHtmlRegId": "030c589c-86a6-447e-9b5a-ed78b23438c0",
"unitAssignmentTextRegId": "ef9733cb-2597-44db-9243-fac282634b61",
"unitPassphraseChangeHtmlRegId": "e94c6646-5201-4506-b50f-0c1231eb96b9",
"unitPassphraseChangeTextRegId": "7d35f554-42b9-425d-87ac-821729e4b3be"
},
"description": "string",
"personaGroupId": "string",
"residentPortalId": "e8c784df-e1dd-4a2f-bf68-3c29e8c7e9da",
"status": "DISABLED",
"unitConfig": {"guestAllowed": true,
"maxUnitCount": 0,
"residentApiAllowed": true,
"residentPortalAllowed": true,
"type": "string",
"useMaxUnitCount": true
},
"venueId": "string",
"venueName": "string"
}

Update Property Configuration

Allows the user to enable or disable property management configuration on the specified venue.

path Parameters

venueId

required

string

Venue Id

Request Body schema: application/json
required

Property configuration to enable

	object (OpenAPI_definition_Address) Venue address.
	object (OpenAPI_definition_CommunicationConfigDto) Configuration for communicating unit change events
description	string
personaGroupId required	string Persona group identifier.
residentPortalId	string <uuid> Resident portal identifier.
status required	string Default: "DISABLED" Enum: "DISABLED" "ENABLED" Status of the property
	object (OpenAPI_definition_UnitConfigDto) Basic configuration on property units
venueId	string
venueName required	string Venue name.

Responses

Request samples

Payload

Content type

application/json

{"address": {"addressLine": "string",
"city": "string",
"country": "string"
},
"communicationConfig": {"guestPassphraseChangeHtmlRegId": "ac96e5f3-b468-4f5c-9504-ff1d443c817d",
"guestPassphraseChangeTextRegId": "5453bcc0-95c4-485e-a0c4-b5fe5f0114f1",
"portAssignmentHtmlRegId": "eba4b4e5-4b09-427f-a4e5-d5e17892e9f5",
"portAssignmentTextRegId": "24ebe9a5-532a-4f77-93ac-cfd4c2182119",
"portalAccessResetHtmlRegId": "22634e9e-dad7-4cef-bc18-8c676b0bd10a",
"portalAccessResetTextRegId": "3a59b191-53e2-4e40-92fb-d05b8ffef68a",
"sendEmail": true,
"sendSms": true,
"type": "string",
"unitAssignmentHtmlRegId": "030c589c-86a6-447e-9b5a-ed78b23438c0",
"unitAssignmentTextRegId": "ef9733cb-2597-44db-9243-fac282634b61",
"unitPassphraseChangeHtmlRegId": "e94c6646-5201-4506-b50f-0c1231eb96b9",
"unitPassphraseChangeTextRegId": "7d35f554-42b9-425d-87ac-821729e4b3be"
},
"description": "string",
"personaGroupId": "string",
"residentPortalId": "e8c784df-e1dd-4a2f-bf68-3c29e8c7e9da",
"status": "DISABLED",
"unitConfig": {"guestAllowed": true,
"maxUnitCount": 0,
"residentApiAllowed": true,
"residentPortalAllowed": true,
"type": "string",
"useMaxUnitCount": true
},
"venueId": "string",
"venueName": "string"
}

Units API

Manages units for a venue

Delete Units for Venue

Allows the user to delete units with the given ids.

path Parameters

venueId

required

string

Venue Id

Request Body schema: application/json
required

Unit ids to delete

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Gets Units for Venue

Gets the list of units paged.

path Parameters

venueId

required

string

Venue Id

query Parameters

size	integer <int32> Page size
page	integer <int32> The page to retrieve (starts at one).
sort	string The field name to sort, comma seperated from the sort order (asc or desc).

Responses

Response samples

200

Content type

application/json

{"content": [{ }
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Adds Unit to Venue

Allows the user to add a unit on the specified venue.

path Parameters

venueId

required

string

Venue Id

Request Body schema:
application/json
required

Unit to add

	object (OpenAPI_definition_UnitAp) Access point details.
	Array of objects (OpenAPI_definition_DpskSettings) [ 0 .. 2 ] items DPSK details.
guestPersonaId	string <uuid>
id	string <uuid>
name required	string Unit name.
personaId	string <uuid>
required	object (OpenAPI_definition_Resident) Resident contact details.
status	string Enum: "DISABLED" "ENABLED" Unit status.
	object (OpenAPI_definition_TrafficControl) Traffic control profile details.

Responses

Request samples

Payload

Content type

application/json

{"accessPoint": {"name": "string",
"selectedPorts": [{"macAddress": "string",
"portIndex": 0
}
]
},
"dpsks": [{"passphrase": "stringst",
"type": "UNIT",
"vlan": 1
}
],
"guestPersonaId": "18b4ce0f-80e0-4cf7-b6fa-bc1935214748",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"personaId": "0387819c-a33e-454c-ad84-570bf53cd75f",
"resident": {"email": "string",
"name": "string",
"phoneNumber": "string"
},
"status": "DISABLED",
"trafficControl": {"meteringProfileId": "string",
"profileExpiry": "2019-08-24T14:15:22Z"
}
}

Query Units for Venue

Gets the list of units using the specified query.

path Parameters

venueId

required

string

query Parameters

excludeContent

boolean

Default: false

Indicates that the content should be excluded from the query and only count and size data returned.

Request Body schema: application/json

Data for the requested query

fields	Array of strings Fields to select.
	object Filter names and its values as filter.
page required	integer <int32> Page number.
pageSize required	integer <int32> Number of pages.
sortField	string Sort field.
sortOrder required	string Enum: "ASC" "DESC" Sorting direction.

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"property1": { },
"property2": { }
},
"page": 0,
"pageSize": 0,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200
400

Content type

application/hal+json

{"content": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"accessPoint": {"name": "string",
"selectedPorts": [{"macAddress": "string",
"portIndex": 0
}
]
},
"dpsks": [{"passphrase": "stringst",
"type": "UNIT",
"vlan": 1
}
],
"guestPersonaId": "18b4ce0f-80e0-4cf7-b6fa-bc1935214748",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"personaId": "0387819c-a33e-454c-ad84-570bf53cd75f",
"resident": {"email": "string",
"name": "string",
"phoneNumber": "string"
},
"status": "DISABLED",
"trafficControl": {"meteringProfileId": "string",
"profileExpiry": "2019-08-24T14:15:22Z"
}
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Delete Unit for Venue

Allows the user to delete a unit with the given id.

path Parameters

venueId required	string Venue Id
unitId required	string <uuid> Unit Id

Responses

Gets Unit for Venue

Allows the user to get a unit with the given id.

path Parameters

venueId required	string Venue Id
unitId required	string <uuid> Unit Id

Responses

Response samples

200
400
500

Content type

application/hal+json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"accessPoint": {"name": "string",
"selectedPorts": [{"macAddress": "string",
"portIndex": 0
}
]
},
"dpsks": [{"passphrase": "stringst",
"type": "UNIT",
"vlan": 1
}
],
"guestPersonaId": "18b4ce0f-80e0-4cf7-b6fa-bc1935214748",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"personaId": "0387819c-a33e-454c-ad84-570bf53cd75f",
"resident": {"email": "string",
"name": "string",
"phoneNumber": "string"
},
"status": "DISABLED",
"trafficControl": {"meteringProfileId": "string",
"profileExpiry": "2019-08-24T14:15:22Z"
}
}

Selectively Updates Unit Configurations

Allows the user to selectively update unit configurations on the specified venue.

path Parameters

venueId required	string Venue Id
unitId required	string <uuid> Unit Id

Request Body schema: application/json
required

Unit to edit

	object (OpenAPI_definition_UnitAp) Access point details.
	Array of objects (OpenAPI_definition_DpskSettings) [ 0 .. 2 ] items DPSK details.
guestPersonaId	string <uuid>
id	string <uuid>
name required	string Unit name.
personaId	string <uuid>
required	object (OpenAPI_definition_Resident) Resident contact details.
status	string Enum: "DISABLED" "ENABLED" Unit status.
	object (OpenAPI_definition_TrafficControl) Traffic control profile details.

Responses

Request samples

Payload

Content type

application/json

{"accessPoint": {"name": "string",
"selectedPorts": [{"macAddress": "string",
"portIndex": 0
}
]
},
"dpsks": [{"passphrase": "stringst",
"type": "UNIT",
"vlan": 1
}
],
"guestPersonaId": "18b4ce0f-80e0-4cf7-b6fa-bc1935214748",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"personaId": "0387819c-a33e-454c-ad84-570bf53cd75f",
"resident": {"email": "string",
"name": "string",
"phoneNumber": "string"
},
"status": "DISABLED",
"trafficControl": {"meteringProfileId": "string",
"profileExpiry": "2019-08-24T14:15:22Z"
}
}

Resident Portals

Manages, create and get configuration of resident portals for a tenant

Delete Resident Portals

Allows the user to delete resident portals with the given ids.

Request Body schema: application/json
required

Resident portal ids to delete

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Get Resident Portals

Gets the list of resident portals paged.

query Parameters

size	integer <int32> Page size
page	integer <int32> The page to retrieve (starts at one).
sort	string The field name to sort, comma seperated from the sort order (asc or desc).

Responses

Response samples

200

Content type

application/json

{"content": [{ }
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Adds Resident Portal

Allows the user to add a resident portal.

Request Body schema: multipart/form-data

favIcon	string <binary> Portal fav icon image
logo	string <binary> Portal logo image
required	object (OpenAPI_definition_ResidentPortal)

Responses

Query Resident Portals

Gets the list of resident portals using the specified query.

query Parameters

excludeContent

boolean

Default: false

Indicates that the content should be excluded from the query and only count and size data returned.

Request Body schema: application/json

Data for the requested query

fields	Array of strings Fields to select.
	object Filter names and its values as filter.
page required	integer <int32> Page number.
pageSize required	integer <int32> Number of pages.
sortField	string Sort field.
sortOrder required	string Enum: "ASC" "DESC" Sorting direction.

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filters": {"property1": { },
"property2": { }
},
"page": 0,
"pageSize": 0,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200
400

Content type

application/json

{"content": [{ }
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Delete Resident Portal

Allows the user to delete a resident portal with the given id.

path Parameters

portalId

required

string <uuid>

Resident Portal Id

Responses

Gets Resident Portal

Allows the user to get a resident portal with the given id.

path Parameters

portalId

required

string <uuid>

Resident Portal Id

Responses

Response samples

200
400
404
500

Content type

application/hal+json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"portalStatus": "DISABLED",
"uiConfiguration": {"type": "string"
},
"venueCount": 0
}

Updates Resident Portal Configurations

Allows the user to selectively update resident portal configurations.

path Parameters

portalId

required

string <uuid>

Resident Portal Id

Request Body schema: multipart/form-data

	object (OpenAPI_definition_ResidentPortal)
favIcon	string <binary> Portal fav icon image
logo	string <binary> Portal logo image

Responses

Deletes Resident Portal File

Allows the user to delete a resident portal file with the given id.

path Parameters

portalId required	string <uuid> Resident Portal Id
type required	string Enum: "logo" "favIcon" Resident Portal file type

Responses

Gets Resident Portal File

Allows the user to get a resident portal file with the given id.

path Parameters

portalId required	string <uuid> Resident Portal Id
type required	string Enum: "logo" "favIcon" Resident Portal file type

Responses

Criteria Evaluation

Evaluates policy criteria provided and identifies the matching policy.

Evaluate Criteria

Evaluates the criteria provided and returns the matched response from the first matching policy, or it will indicate that no match was found. A policy has additional required criteria and no matching test criteria is provided, that will be considered a failure. Additional test attributes that are provided but are not required within a policy will be ignored and not considered a match failure.

Request Body schema: application/json
required

	object (Policy_Management_REST_API_Links)
required	Array of objects (Policy_Management_REST_API_Evaluation Criteria) The complete list of criteria to evaluate against this policy set.
onMatchResponse	string The response value that was defined in the policy that was matched.
policyId	string <uuid> The unique identifier of the specific policy that was found during evaluation. It will be ignored on the post and will not be set if no matching policy was found.
policyName	string The name of the specific policy that was matched. Ignored on the post, and will not be set if no match was made.
policySetId required	string <uuid> The identifier for the policy set to evaluate.
policyType	string Enum: "BASE" "RADIUS" "DPSK" "UNMATCHED" The type of policy that was found during evaluation. Optional, and will be used on the post if it is a valid policy type, and can be evaluated. UNMATCHED, DPSK and RADIUS map to the existing policy types, any other policy types are not available.
wasMatched	boolean The overall results of the matched request. This will be ignored on the post if it is provided.

Responses

Request samples

Payload

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"evaluationCriteria": [{"matchName": "string",
"value": {"booleanValue": true
}
}
],
"onMatchResponse": "string",
"policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
"policyName": "string",
"policySetId": "cd627cf7-03c4-4c1d-8b46-84b816ad5cc6",
"policyType": "BASE",
"wasMatched": true
}

Response samples

400
404
409

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"evaluationCriteria": [{"matchName": "string",
"value": {"booleanValue": true
}
}
],
"onMatchResponse": "string",
"policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
"policyName": "string",
"policySetId": "cd627cf7-03c4-4c1d-8b46-84b816ad5cc6",
"policyType": "BASE",
"wasMatched": true
}

Policy Conditions

Manage the conditions that are applied on the specified policy.

Get Conditions

Retrieves the list of condition for the policy.

path Parameters

templateId required	integer <int64> Template identifier.
policyId required	string <uuid> Policy identifier.

query Parameters

size	any Page size
page	any The page to retrieve (starts at zero).
sort	any The field name to sort, comma seperated from the sort order (asc or desc).

Responses

Response samples

200
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{ }
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

Create Condition

Creates a condition and applies it to the policy.

path Parameters

templateId required	integer <int64> Policy Template identifier.
policyId required	string <uuid> Policy identifier.

Request Body schema: application/json
required

	object (Policy_Management_REST_API_Links)
	object (Policy_Management_REST_API_EvaluationCriteria)
id	string <uuid> The identifier for this policy condition.
policyId required	string <uuid> The identifier of the policy to assign this condition.
	object (Policy_Management_REST_API_Dynamic Policy Template Attribute) Attribute that is allowed to be assigned on a policy using the template.
templateAttributeId required	integer <int64> The identifier for the template attribute to associate with this condition.

Responses

Request samples

Payload

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"evaluationRule": {"criteriaType": "string",
"booleanCriteria": true
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
"templateAttribute": {"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"attributeTextMatch": "string",
"attributeType": "STRING",
"description": "string",
"id": 0,
"name": "string"
},
"templateAttributeId": 0
}

Response samples

201
404
409

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"evaluationRule": {"criteriaType": "string",
"booleanCriteria": true
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
"templateAttribute": {"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"attributeTextMatch": "string",
"attributeType": "STRING",
"description": "string",
"id": 0,
"name": "string"
},
"templateAttributeId": 0
}

Delete Conditions

Deletes the condition from the specified policy, but only if at least one condition still exists.

path Parameters

templateId required	integer <int64> Template identifier
policyId required	string <uuid> Policy identifier
conditionId required	string <uuid> Condition identifier

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/policyTemplates/{templateId}/policies/{policyId}/conditions/{conditionId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/policyTemplates/{templateId}/policies/{policyId}/conditions/{conditionId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/policyTemplates/{templateId}/policies/{policyId}/conditions/{conditionId}

Response samples

200
204
404
409

Content type

application/json

{ }

Get Condition

Retrieves the requested condition for the policy.

path Parameters

templateId required	integer <int64> Template identifier.
policyId required	string <uuid> Policy identifier.
conditionId required	string <uuid> Condition identifier.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/policyTemplates/{templateId}/policies/{policyId}/conditions/{conditionId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/policyTemplates/{templateId}/policies/{policyId}/conditions/{conditionId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/policyTemplates/{templateId}/policies/{policyId}/conditions/{conditionId}

Response samples

200
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"identityName": "string"
}

Update Condition

Updates the condition from the requested values.

path Parameters

templateId required	integer <int64> Policy Template identifier.
policyId required	string <uuid> Policy identifier.
conditionId required	string <uuid> Condition identifier.

Request Body schema: application/json
required

	object (Policy_Management_REST_API_Links)
	object (Policy_Management_REST_API_EvaluationCriteria)
id	string <uuid> The identifier for this policy condition.
policyId required	string <uuid> The identifier of the policy to assign this condition.
	object (Policy_Management_REST_API_Dynamic Policy Template Attribute) Attribute that is allowed to be assigned on a policy using the template.
templateAttributeId required	integer <int64> The identifier for the template attribute to associate with this condition.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/policyTemplates/{templateId}/policies/{policyId}/conditions/{conditionId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/policyTemplates/{templateId}/policies/{policyId}/conditions/{conditionId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/policyTemplates/{templateId}/policies/{policyId}/conditions/{conditionId}

Request samples

Payload

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"evaluationRule": {"criteriaType": "string",
"booleanCriteria": true
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
"templateAttribute": {"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"attributeTextMatch": "string",
"attributeType": "STRING",
"description": "string",
"id": 0,
"name": "string"
},
"templateAttributeId": 0
}

Response samples

200
409

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"evaluationRule": {"criteriaType": "string",
"booleanCriteria": true
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
"templateAttribute": {"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"attributeTextMatch": "string",
"attributeType": "STRING",
"description": "string",
"id": 0,
"name": "string"
},
"templateAttributeId": 0
}

Policy Templates

View the list of policy templates.

Get Policy Templates

Gets the list of policy templates in a paged format.

query Parameters

size	any Page size
page	any The page to retrieve (starts at zero).
sort	any The field name to sort, comma seperated from the sort order (asc or desc).

Responses

Response samples

200

Content type

application/json

{"content": [{ }
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

All Policies Paged

Returns the list of policies regardless of the template. Template can be found in the links section of each policy.

query Parameters

size	any Page size
page	any The page to retrieve (starts at zero).
sort	any The field name to sort, comma seperated from the sort order (asc or desc).

Responses

Response samples

200

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"conditionsCount": 0,
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"onMatchResponse": "string",
"policySetCount": 0,
"policySetNames": ["string"
],
"policyType": "RADIUS"
}
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

All Policies by Query

Returns the list of policies regardless of the template filtered by query criteria.

query Parameters

excludeContent

boolean

Default: false

Indicates that the content should be excluded from the query and only count and size data returned.

Request Body schema: application/json
required

	object The list of filters to apply.
page	integer <int32> >= 0 The page number to return, paging starts with 0.
pageSize	integer <int32> [ 1 .. 2000 ] The number of items requested on the page.
sortField	string The field to use to sort on.
sortOrder	string Enum: "ASC" "DESC" The sort order of the applied query.

Responses

Request samples

Payload

Content type

application/json

{"filters": {"property1": { },
"property2": { }
},
"page": 0,
"pageSize": 1,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200
422

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"conditionsCount": 0,
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"onMatchResponse": "string",
"policySetCount": 0,
"policySetNames": ["string"
],
"policyType": "RADIUS"
}
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

Query Policy Templates

Gets the list of policy templates using the specified query.

query Parameters

excludeContent

boolean

Default: false

Indicates that the content should be excluded from the query and only count and size data returned.

Request Body schema: application/json
required

	object The list of filters to apply.
page	integer <int32> >= 0 The page number to return, paging starts with 0.
pageSize	integer <int32> [ 1 .. 2000 ] The number of items requested on the page.
sortField	string The field to use to sort on.
sortOrder	string Enum: "ASC" "DESC" The sort order of the applied query.

Responses

Request samples

Payload

Content type

application/json

{"filters": {"property1": { },
"property2": { }
},
"page": 0,
"pageSize": 1,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"description": "string",
"id": 0,
"name": "string",
"returnType": "RADIUS_ATTRIB_GROUP",
"ruleType": "RADIUS"
}

Get Policy Template

Gets the specific policy template requested.

path Parameters

templateId

required

integer <int64>

Policy template identifier

Responses

Response samples

200
400
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"description": "string",
"id": 0,
"name": "string",
"returnType": "RADIUS_ATTRIB_GROUP",
"ruleType": "RADIUS"
}

Get Policy Template Attributes

Gets the attributes associated with the specific policy template requested.

path Parameters

templateId

required

integer <int64>

Policy Template identifier.

query Parameters

size	any Page size
page	any The page to retrieve (starts at zero).
sort	any The field name to sort, comma seperated from the sort order (asc or desc).

Responses

Response samples

200
400
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"attributeTextMatch": "string",
"attributeType": "STRING",
"description": "string",
"id": 0,
"name": "string"
}
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

Get Policy Template Attributes

Gets the attributes associated with the specific policy template requested using a query.

path Parameters

templateId

required

integer <int64>

Policy Template identifier.

query Parameters

excludeContent

boolean

Default: false

Indicates that the content should be excluded from the query and only count and size data returned.

Request Body schema: application/json
required

	object The list of filters to apply.
page	integer <int32> >= 0 The page number to return, paging starts with 0.
pageSize	integer <int32> [ 1 .. 2000 ] The number of items requested on the page.
sortField	string The field to use to sort on.
sortOrder	string Enum: "ASC" "DESC" The sort order of the applied query.

Responses

Request samples

Payload

Content type

application/json

{"filters": {"property1": { },
"property2": { }
},
"page": 0,
"pageSize": 1,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200
400
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"attributeTextMatch": "string",
"attributeType": "STRING",
"description": "string",
"id": 0,
"name": "string"
}
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

Get Policy Template Attribute

Gets the requested attribute associated with the specific policy.

path Parameters

templateId required	integer <int64> Policy Template identifier.
attributeId required	integer <int64> Policy Template Attribute identifier.

Responses

Response samples

200
400
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"attributeTextMatch": "string",
"attributeType": "STRING",
"description": "string",
"id": 0,
"name": "string"
}

Policy Set Prioritized Rules

Manages, create and gets the policies prioritized for this set.

Get Prioritized Policies

Gets the list of prioritized policies for this policy set.

path Parameters

policySetId

required

string <uuid>

Policy set identifier.

Responses

Response samples

200
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{ }
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

Remove Policy Assignment

Removes the priority mapping assignment of the policy to this policy set.

path Parameters

policySetId required	string <uuid> Policy set identifier.
policyId required	string <uuid> Policy identifier.

Responses

Response samples

200
204
404

Content type

application/json

{ }

Get Prioritized Policy

Retrieves the requested policy priority.

path Parameters

policySetId required	string <uuid> Policy set identifier.
policyId required	string <uuid> Policy identifier.

Responses

Response samples

200
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
"priority": 0
}

Assign Policy Priority

Maps policy to the priority defined on this set, will order the other priorities.

path Parameters

policySetId required	string <uuid> Policy set identifier.
policyId required	string <uuid> Policy identifier.

Request Body schema: application/json
required

	object (Policy_Management_REST_API_Links)
policyId	string <uuid> The identifier for the prioritized policy. Will be ignored on a put, as URL is the identifier.
priority	integer <int32> The priority of this policy, 1 being the highest priority.

Responses

Request samples

Payload

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
"priority": 0
}

Response samples

200
409

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
"priority": 0
}

Policies

Manages, create and get of policies assigned to a specific template.

Get Policies

Gets the list of policies that are based off of this template.

path Parameters

templateId

required

integer <int64>

Policy template identifier.

query Parameters

size	any Page size
page	any The page to retrieve, paging starts at zero).
sort	any The field name to sort, comma seperated from the sort order (asc or desc).

Responses

Response samples

200
400
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{ }
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

Create Policy

Creates a policy from the requested values, and based on the specified parent. If the content type of "application/ruckus.one.v1-synchronous+json" is provided, then the method will be asynchronous, and will return only once it has correctly associated with the requested radius attribute group. Otherwise it is asynchronous, and must be looked up by id to be complete.

path Parameters

templateId

required

integer <int64>

Policy template identifier.

Request Body schema: application/json
required

	object (Policy_Management_REST_API_Links)
conditionsCount	integer <int64> The number of conditions that are used when evaluating this policy.
description	string The policy description.
id	string <uuid> The identifier for this dynamic policy.
name required	string The name of the policy.
onMatchResponse	string The response details if the policy is matched. For policy types which are RADIUS and DPSK, this is expected to be the identifier of a valid RADIUS attribute group.
policySetCount	integer <int64> The number of policy sets that this policy is assigned to.
policySetNames	Array of strings The names of the policy sets that this policy is currently assigned to.
policyType required	string Enum: "RADIUS" "DPSK" The data type for this attribute text. EX: it identifies which type of value the test data will be. This cannot be changed, and will be matched with the policy template for this policy type. It cannot be changed.

Responses

Request samples

Payload

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"conditionsCount": 0,
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"onMatchResponse": "string",
"policySetCount": 0,
"policySetNames": ["string"
],
"policyType": "RADIUS"
}

Response samples

201
202
409

Content type

application/ruckus.one.v1-synchronous+json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"conditionsCount": 0,
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"onMatchResponse": "string",
"policySetCount": 0,
"policySetNames": ["string"
],
"policyType": "RADIUS"
}

Query Policies

Returns the list of policies on the specific templates using the specified query.

path Parameters

templateId

required

integer <int64>

Policy template identifier.

query Parameters

excludeContent

boolean

Default: false

Indicates that the content should be excluded from the query and only count and size data returned.

Request Body schema: application/json
required

	object The list of filters to apply.
page	integer <int32> >= 0 The page number to return, paging starts with 0.
pageSize	integer <int32> [ 1 .. 2000 ] The number of items requested on the page.
sortField	string The field to use to sort on.
sortOrder	string Enum: "ASC" "DESC" The sort order of the applied query.

Responses

Request samples

Payload

Content type

application/json

{"filters": {"property1": { },
"property2": { }
},
"page": 0,
"pageSize": 1,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200
400
404
422

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"conditionsCount": 0,
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"onMatchResponse": "string",
"policySetCount": 0,
"policySetNames": ["string"
],
"policyType": "RADIUS"
}
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

Delete Policy

Deletes the policy and conditions, may not be assigned to a service.

path Parameters

templateId required	integer <int64> Policy template identifier.
policyId required	string <uuid> Policy identifier.

Responses

Response samples

200
204
404
409

Content type

application/json

{ }

Get Policy

Retrieves the requested policy.

path Parameters

templateId required	integer <int64> Policy template identifier.
policyId required	string <uuid> Policy identifier.

Responses

Response samples

200
400
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"conditionsCount": 0,
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"onMatchResponse": "string",
"policySetCount": 0,
"policySetNames": ["string"
],
"policyType": "RADIUS"
}

Update Policy

Updates the policy from the requested values. The policy template assigned to this policy cannot be changed.

path Parameters

templateId required	integer <int64> Policy template identifier.
policyId required	string <uuid> Policy identifier.

Request Body schema: application/json
required

	object (Policy_Management_REST_API_Links)
conditionsCount	integer <int64> The number of conditions that are used when evaluating this policy.
description	string The policy description.
id	string <uuid> The identifier for this dynamic policy.
name required	string The name of the policy.
onMatchResponse	string The response details if the policy is matched. For policy types which are RADIUS and DPSK, this is expected to be the identifier of a valid RADIUS attribute group.
policySetCount	integer <int64> The number of policy sets that this policy is assigned to.
policySetNames	Array of strings The names of the policy sets that this policy is currently assigned to.
policyType required	string Enum: "RADIUS" "DPSK" The data type for this attribute text. EX: it identifies which type of value the test data will be. This cannot be changed, and will be matched with the policy template for this policy type. It cannot be changed.

Responses

Request samples

Payload

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"conditionsCount": 0,
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"onMatchResponse": "string",
"policySetCount": 0,
"policySetNames": ["string"
],
"policyType": "RADIUS"
}

Response samples

200
409

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"conditionsCount": 0,
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"onMatchResponse": "string",
"policySetCount": 0,
"policySetNames": ["string"
],
"policyType": "RADIUS"
}

Policy Sets

Manages the policy sets.

Get Policy Set

Gets the list of policy sets.

query Parameters

size	any Page size
page	any The page to retrieve (starts at zero).
sort	any The field name to sort, comma seperated from the sort order (asc or desc).

Responses

Response samples

200

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{ }
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

Create Policy Set

Creates a policy set from the requested values.

Request Body schema: application/json
required

	object (Policy_Management_REST_API_Links)
assignmentCount	integer <int64> The number of assignments to this policy set.
description required	string The policy set description.
	Array of objects (Policy_Management_REST_API_Policy Set Assignment Groups) The list of external assignments assigned to this policy set.
id	string <uuid> The identifier for this dynamic policy.
mappedPolicyCount	integer <int64> The number of policies mapped to this policy set.
name required	string The policy set name.
policyNames	Array of strings The names of the policies mapped to this policy set.

Responses

Request samples

Payload

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"assignmentCount": 0,
"description": "string",
"externalAssignments": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"identityId": ["string"
],
"identityName": "string"
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mappedPolicyCount": 0,
"name": "string",
"policyNames": ["string"
]
}

Response samples

201
409

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"assignmentCount": 0,
"description": "string",
"externalAssignments": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"identityId": ["string"
],
"identityName": "string"
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mappedPolicyCount": 0,
"name": "string",
"policyNames": ["string"
]
}

Query Policy Sets

Returns the list of policies sets using the specified query.

query Parameters

excludeContent

boolean

Default: false

Indicates that the content should be excluded from the query and only count and size data returned.

Request Body schema: application/json
required

	object The list of filters to apply.
page	integer <int32> >= 0 The page number to return, paging starts with 0.
pageSize	integer <int32> [ 1 .. 2000 ] The number of items requested on the page.
sortField	string The field to use to sort on.
sortOrder	string Enum: "ASC" "DESC" The sort order of the applied query.

Responses

Request samples

Payload

Content type

application/json

{"filters": {"property1": { },
"property2": { }
},
"page": 0,
"pageSize": 1,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200
400

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{ }
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

Delete Policy Set

Deletes the policy set, but only if it is not used by another service.

path Parameters

policySetId

required

string <uuid>

Policy Set identifier.

Responses

Response samples

200
204
404
409

Content type

application/json

{ }

Get Policy Set

Retrieves the requested policy set.

path Parameters

policySetId

required

string <uuid>

Policy set identifier.

Responses

Response samples

200
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"conditionsCount": 0,
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"onMatchResponse": "string",
"policySetCount": 0,
"policySetNames": ["string"
],
"policyType": "RADIUS"
}

Update Policy Set

Updates the policy sets with the requested values. Only policy sets attributes can be changed. Use the prioritized policy APIs to manipulate the prioritized policies.

path Parameters

policySetId

required

string <uuid>

Policy set identifier.

Request Body schema: application/json
required

	object (Policy_Management_REST_API_Links)
assignmentCount	integer <int64> The number of assignments to this policy set.
description required	string The policy set description.
	Array of objects (Policy_Management_REST_API_Policy Set Assignment Groups) The list of external assignments assigned to this policy set.
id	string <uuid> The identifier for this dynamic policy.
mappedPolicyCount	integer <int64> The number of policies mapped to this policy set.
name required	string The policy set name.
policyNames	Array of strings The names of the policies mapped to this policy set.

Responses

Request samples

Payload

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"assignmentCount": 0,
"description": "string",
"externalAssignments": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"identityId": ["string"
],
"identityName": "string"
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mappedPolicyCount": 0,
"name": "string",
"policyNames": ["string"
]
}

Response samples

200
409

Content type

application/json

{ }

Policy Set Assignments

Provides information on the assignments made on a policy set.

Get Policy Set Assignments

Gets the list of assignments for this policy set.

path Parameters

policySetId

required

string <uuid>

Policy set identifier.

query Parameters

size	any Page size
page	any The page to retrieve (starts at zero).
sort	any The field name to sort, comma seperated from the sort order (asc or desc).

Responses

Response samples

200
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{ }
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

Query Policy Set Assignments

Returns the list of assignments using the specified query.

path Parameters

policySetId

required

string <uuid>

Policy set identifier.

query Parameters

excludeContent

boolean

Default: false

Indicates that the content should be excluded from the query and only count and size data returned.

Request Body schema: application/json
required

	object The list of filters to apply.
page	integer <int32> >= 0 The page number to return, paging starts with 0.
pageSize	integer <int32> [ 1 .. 2000 ] The number of items requested on the page.
sortField	string The field to use to sort on.
sortOrder	string Enum: "ASC" "DESC" The sort order of the applied query.

Responses

Request samples

Payload

Content type

application/json

{"filters": {"property1": { },
"property2": { }
},
"page": 0,
"pageSize": 1,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200
400

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"content": [{ }
],
"paging": {"page": 0,
"pageCount": 0,
"pageSize": 0,
"totalCount": 0
}
}

Get Policy Set Assignment

Retrieves the requested assignment for the policy set.

path Parameters

policySetId required	string <uuid> Policy set identifier.
assignmentId required	string <uuid> Assignment identifier.

Responses

Response samples

200
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityId": "string",
"identityName": "string"
}

Notification Recipient

Manage notification recipients.

Delete Notification Recipient

Delete notification recipient list.

Request Body schema:
application/json
required

Array

description required	string
required	Array of Tenant_Management_API_EmailNotificationEndpoint (object) or Tenant_Management_API_MobilePushNotificationEndpoint (object) or Tenant_Management_API_SmsNotificationEndpoint (object) [ 1 .. 2147483647 ] items
id	string

Responses

Request samples

Payload

Content type

application/json

[{"description": "string",
"endpoints": [{"active": true,
"destination": "string",
"id": "string",
"status": "OK",
"type": "string"
}
],
"id": "string"
}
]

Response samples

202
500

Content type

application/json

{"requestId": "string",
"response": { }
}

Get Notification Recipients

Get notification recipient list.

Responses

Response samples

200

Content type

application/json

[{"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"endpoints": [{"active": true,
"createdDate": "2019-08-24T14:15:22Z",
"destination": "string",
"id": "string",
"parentId": "string",
"status": "OK",
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"id": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
]

Add Notification Recipient

Add notification recipient.

Request Body schema: application/json
required

description required	string
required	Array of Tenant_Management_API_EmailNotificationEndpoint (object) or Tenant_Management_API_MobilePushNotificationEndpoint (object) or Tenant_Management_API_SmsNotificationEndpoint (object) [ 1 .. 2147483647 ] items
id	string

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"endpoints": [{"active": true,
"destination": "string",
"id": "string",
"status": "OK",
"type": "string"
}
],
"id": "string"
}

Response samples

202
400
500

Content type

application/json

{"requestId": "string",
"response": {"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"endpoints": [{"active": true,
"createdDate": "2019-08-24T14:15:22Z",
"destination": "string",
"id": "string",
"parentId": "string",
"status": "OK",
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"id": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
}

Tenant

Manage tenants.

Get Tenant

Get tenant by identifier.

query Parameters

deep

boolean

Responses

Response samples

200

Content type

application/json

{"MspEcServiceDates": {"parentMspId": "string",
"serviceEffectiveDate": "2019-08-24T14:15:22Z",
"serviceExpirationDate": "2019-08-24T14:15:22Z"
},
"account": {"city": "string",
"country": "string",
"createdDate": "2019-08-24T14:15:22Z",
"faxNumber": "string",
"id": "string",
"mappingURL": "string",
"parentId": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"streetAddress": "string",
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"accountTier": "string",
"accountVertical": "string",
"admins": [{"adminAppSettings": [{"appType": "UI",
"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"parentId": "string",
"productType": "WIFI",
"updatedDate": "2019-08-24T14:15:22Z",
"value": "string"
}
],
"adminRoles": [{"createdDate": "2019-08-24T14:15:22Z",
"delegated": "string",
"delegatedRoleType": "RKS_EC",
"id": "string",
"parentId": "string",
"privilegeGroup": {"createdDate": "2019-08-24T14:15:22Z",
"customRole": {"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"frameworkRO": true,
"id": "string",
"name": "string",
"parentId": "string",
"policyBased": true,
"preDefinedRole": "string",
"roleObjectPermissions": [{"add": true,
"apply": true,
"conditions": "string",
"createdDate": "2019-08-24T14:15:22Z",
"customRole": { },
"delete": true,
"entityInstanceId": "string",
"id": "string",
"objectType": "string",
"parentId": "string",
"privilegeGroup": { },
"read": true,
"roleEntity": {"createdDate": null,
"id": null,
"objectType": null,
"parentId": null,
"roleObjectPermissions": [ ],
"serviceName": null,
"updatedDate": null
},
"tenant": { },
"update": true,
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"roleType": "string",
"scopes": [{"createdDate": "2019-08-24T14:15:22Z",
"customRoles": [null
],
"features": [null
],
"id": "string",
"name": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"tenant": { },
"updatedDate": "2019-08-24T14:15:22Z"
},
"delegatedBy": "string",
"delegationDetails": "string",
"description": "string",
"hasDelegations": true,
"id": "string",
"memberCount": 0,
"mspCustomers": 0,
"name": "string",
"parentId": "string",
"parentPrivilegeGroupId": "string",
"readOnly": true,
"roleObjectPermissions": [{"add": true,
"apply": true,
"conditions": "string",
"createdDate": "2019-08-24T14:15:22Z",
"customRole": {"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"frameworkRO": true,
"id": "string",
"name": "string",
"parentId": "string",
"policyBased": true,
"preDefinedRole": "string",
"roleObjectPermissions": [null
],
"roleType": "string",
"scopes": [null
],
"tenant": { },
"updatedDate": "2019-08-24T14:15:22Z"
},
"delete": true,
"entityInstanceId": "string",
"id": "string",
"objectType": "string",
"parentId": "string",
"privilegeGroup": { },
"read": true,
"roleEntity": {"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"objectType": "string",
"parentId": "string",
"roleObjectPermissions": [null
],
"serviceName": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"tenant": { },
"update": true,
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"tenant": { },
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"role": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"authentication": {"accountBased": true,
"authDomains": [{"authentication": { },
"createdDate": "2019-08-24T14:15:22Z",
"domain": "string",
"id": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"authScopes": [{"authentication": { },
"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"parentId": "string",
"privilegeGroup": {"createdDate": "2019-08-24T14:15:22Z",
"customRole": {"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"frameworkRO": true,
"id": "string",
"name": "string",
"parentId": "string",
"policyBased": true,
"preDefinedRole": "string",
"roleObjectPermissions": [{"add": null,
"apply": null,
"conditions": null,
"createdDate": null,
"customRole": null,
"delete": null,
"entityInstanceId": null,
"id": null,
"objectType": null,
"parentId": null,
"privilegeGroup": null,
"read": null,
"roleEntity": null,
"tenant": null,
"update": null,
"updatedDate": null
}
],
"roleType": "string",
"scopes": [{"createdDate": null,
"customRoles": [ ],
"features": [ ],
"id": null,
"name": null,
"parentId": null,
"updatedDate": null
}
],
"tenant": { },
"updatedDate": "2019-08-24T14:15:22Z"
},
"delegatedBy": "string",
"delegationDetails": "string",
"description": "string",
"hasDelegations": true,
"id": "string",
"memberCount": 0,
"mspCustomers": 0,
"name": "string",
"parentId": "string",
"parentPrivilegeGroupId": "string",
"readOnly": true,
"roleObjectPermissions": [{"add": true,
"apply": true,
"conditions": "string",
"createdDate": "2019-08-24T14:15:22Z",
"customRole": {"createdDate": null,
"description": null,
"frameworkRO": null,
"id": null,
"name": null,
"parentId": null,
"policyBased": null,
"preDefinedRole": null,
"roleObjectPermissions": [ ],
"roleType": null,
"scopes": [ ],
"tenant": null,
"updatedDate": null
},
"delete": true,
"entityInstanceId": "string",
"id": "string",
"objectType": "string",
"parentId": "string",
"privilegeGroup": { },
"read": true,
"roleEntity": {"createdDate": null,
"id": null,
"objectType": null,
"parentId": null,
"roleObjectPermissions": [ ],
"serviceName": null,
"updatedDate": null
},
"tenant": { },
"update": true,
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"tenant": { },
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"authenticationType": "IDM",
"authorizationURL": "string",
"clientID": "string",
"clientIDStatus": "ACTIVE",
"clientSecret": "string",
"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"parentId": "string",
"samlFileType": "DIRECT_URL",
"samlFileURL": "string",
"scopes": "string",
"tokenURL": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"createdDate": "2019-08-24T14:15:22Z",
"dateFormat": "mm/dd/yyyy",
"detailLevel": "ba",
"externalId": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z",
"username": "string"
}
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [{"accountBased": true,
"authDomains": [{"authentication": { },
"createdDate": "2019-08-24T14:15:22Z",
"domain": "string",
"id": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"authScopes": [{"authentication": { },
"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"parentId": "string",
"privilegeGroup": {"createdDate": "2019-08-24T14:15:22Z",
"customRole": {"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"frameworkRO": true,
"id": "string",
"name": "string",
"parentId": "string",
"policyBased": true,
"preDefinedRole": "string",
"roleObjectPermissions": [{"add": true,
"apply": true,
"conditions": "string",
"createdDate": "2019-08-24T14:15:22Z",
"customRole": { },
"delete": true,
"entityInstanceId": "string",
"id": "string",
"objectType": "string",
"parentId": "string",
"privilegeGroup": { },
"read": true,
"roleEntity": {"createdDate": null,
"id": null,
"objectType": null,
"parentId": null,
"roleObjectPermissions": [ ],
"serviceName": null,
"updatedDate": null
},
"tenant": { },
"update": true,
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"roleType": "string",
"scopes": [{"createdDate": "2019-08-24T14:15:22Z",
"customRoles": [null
],
"features": [null
],
"id": "string",
"name": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"tenant": { },
"updatedDate": "2019-08-24T14:15:22Z"
},
"delegatedBy": "string",
"delegationDetails": "string",
"description": "string",
"hasDelegations": true,
"id": "string",
"memberCount": 0,
"mspCustomers": 0,
"name": "string",
"parentId": "string",
"parentPrivilegeGroupId": "string",
"readOnly": true,
"roleObjectPermissions": [{"add": true,
"apply": true,
"conditions": "string",
"createdDate": "2019-08-24T14:15:22Z",
"customRole": {"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"frameworkRO": true,
"id": "string",
"name": "string",
"parentId": "string",
"policyBased": true,
"preDefinedRole": "string",
"roleObjectPermissions": [null
],
"roleType": "string",
"scopes": [null
],
"tenant": { },
"updatedDate": "2019-08-24T14:15:22Z"
},
"delete": true,
"entityInstanceId": "string",
"id": "string",
"objectType": "string",
"parentId": "string",
"privilegeGroup": { },
"read": true,
"roleEntity": {"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"objectType": "string",
"parentId": "string",
"roleObjectPermissions": [null
],
"serviceName": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"tenant": { },
"update": true,
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"tenant": { },
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"authenticationType": "IDM",
"authorizationURL": "string",
"clientID": "string",
"clientIDStatus": "ACTIVE",
"clientSecret": "string",
"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"parentId": "string",
"samlFileType": "DIRECT_URL",
"samlFileURL": "string",
"scopes": "string",
"tokenURL": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [{"createdDate": "2019-08-24T14:15:22Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"id": "string",
"isValid": true,
"parentId": "string",
"status": "INVITED",
"type": "VAR",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": "string",
"changePasswordUrl": "string",
"contactSupportUrl": "string",
"contractSupportBehavior": "string",
"defaultLogoUUID": "string",
"email": "string",
"isDisableNotification": true,
"logoUUID": "string",
"mlisaLogoUUID": "string",
"mspFQDN": "string",
"mspLabel": "string",
"myOpenCaseBehavior": "string",
"myOpenCaseUrl": "string",
"openCaseBehavior": "string",
"openCaseUrl": "string",
"phone": "string",
"pingLoginLogoUUID": "string",
"pingNotificationLogoUUID": "string",
"website": "string"
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [{"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"endpoints": [{"active": true,
"createdDate": "2019-08-24T14:15:22Z",
"destination": "string",
"id": "string",
"parentId": "string",
"status": "OK",
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"id": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": "string",
"recoveryCodes": "string"
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
}

Update a Tenant

Update tenant information are tenant name, tenant type,external id by passing the alto tenant id.

Request Body schema:
application/json
required

enableAlpha	boolean
enableBeta	boolean
enableMfa	string
enableSa	boolean
entitlementId	string
missingAdminIds	Array of strings
newIdmId	string
tenantName	string
var	boolean

Responses

Request samples

Payload

Content type

application/json

{"enableAlpha": true,
"enableBeta": true,
"enableMfa": "string",
"enableSa": true,
"entitlementId": "string",
"missingAdminIds": ["string"
],
"newIdmId": "string",
"tenantName": "string",
"var": true
}

Response samples

200

Content type

application/json

"string"

Delegation

Manage delegations.

Get Delegations

Get delegation list.

query Parameters

type	string Enum: "VAR" "SUPPORT" "MSP" "SUPPORT_EC" "MSP_INSTALLER" "MSP_INTEGRATOR" "UNKNOWN"

Responses

Response samples

200

Content type

application/json

[{"createdDate": "2019-08-24T14:15:22Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"id": "string",
"isValid": true,
"parentId": "string",
"status": "INVITED",
"type": "VAR",
"updatedDate": "2019-08-24T14:15:22Z"
}
]

Invite VAR

Send invitation to VAR (aka delegate) to manage my account.This operation is not supported using client credentials.

Request Body schema:
application/json
required

username

string

Responses

Request samples

Payload

Content type

application/json

{"username": "string"
}

Response samples

202
400
404
500

Content type

application/json

{"requestId": "string",
"response": {"createdDate": "2019-08-24T14:15:22Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"id": "string",
"isValid": true,
"parentId": "string",
"status": "INVITED",
"type": "VAR",
"updatedDate": "2019-08-24T14:15:22Z"
}
}

Revoke VAR Delegation

Revoke VAR delegation by ID.

path Parameters

delegationId

required

string

Responses

Response samples

202
500

Content type

application/json

{"requestId": "string",
"response": { }
}

Get Delegation

Get delegation by ID.

path Parameters

delegationId

required

string

Responses

Response samples

200

Content type

application/json

{"createdDate": "2019-08-24T14:15:22Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"id": "string",
"isValid": true,
"parentId": "string",
"status": "INVITED",
"type": "VAR",
"updatedDate": "2019-08-24T14:15:22Z"
}

Respond to Delegation

A VAR uses this endpoint to respond to a delegation invitation; the response is either accept or reject.

path Parameters

delegationId

required

string

Request Body schema:
application/json
required

accept required	boolean
fromTenantId required	string

Responses

Request samples

Payload

Content type

application/json

{"accept": true,
"fromTenantId": "string"
}

Response samples

202
500

Content type

application/json

{"requestId": "string",
"response": {"createdDate": "2019-08-24T14:15:22Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"id": "string",
"isValid": true,
"parentId": "string",
"status": "INVITED",
"type": "VAR",
"updatedDate": "2019-08-24T14:15:22Z"
}
}

Revoke Access

Revoke Ruckus customer support's access to my account.

Responses

Response samples

202
500

Content type

application/json

{"requestId": "string",
"response": { }
}

Grant Access

Grant Ruckus customer support access to my account.

Responses

Response samples

202
500

Content type

application/json

{"requestId": "string",
"response": {"createdDate": "2019-08-24T14:15:22Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"id": "string",
"isValid": true,
"parentId": "string",
"status": "INVITED",
"type": "VAR",
"updatedDate": "2019-08-24T14:15:22Z"
}
}

User Profile

Manage user profiles.

Get Account

Get account details.

Responses

Response samples

200

Content type

application/json

{"address": "string",
"city": "string",
"country": "string",
"organization": "string",
"stateOrProvince": "string",
"zip": "string"
}

Get User Profile

Get user profile.

Responses

Response samples

200

Content type

application/json

{"adminId": "string",
"allowedRegions": [{"current": true,
"description": "string",
"id": "string",
"link": "string",
"name": "string"
}
],
"companyName": "string",
"customRoleName": "string",
"dateFormat": "mm/dd/yyyy",
"delegatedDogfood": true,
"detailLevel": "ba",
"dogfood": true,
"email": "string",
"externalId": "string",
"firstName": "string",
"lastName": "string",
"newDateFormat": "string",
"preferredLanguage": "string",
"pver": "string",
"region": "string",
"role": "string",
"roles": ["string"
],
"scopes": ["string"
],
"support": true,
"tenantId": "string",
"username": "string",
"var": true,
"varTenantId": "string"
}

Update User Profile

Update user profile.

Request Body schema:
application/json
required

adminId	string
	Array of objects (Tenant_Management_API_Region) unique Regions are the continents to which the user is allowed. Currently permitted regions are North America, European Union and Asia.
companyName	string
customRoleName	string
dateFormat required	string Enum: "mm/dd/yyyy" "dd/mm/yyyy" "yyyy/mm/dd"
delegatedDogfood	boolean Delegation to a dog food account (internal RUCKUS test accounts, named per the saying, eat your own dog food).
detailLevel required	string Enum: "ba" "it" "su" "debug"
email	string
externalId	string
firstName	string
lastName	string
newDateFormat	string
preferredLanguage	string
region	string
role	string Deprecated
roles	Array of strings unique
scopes	Array of strings unique
tenantId	string
username	string
var	boolean
varTenantId	string

Responses

Request samples

Payload

Content type

application/json

{"adminId": "string",
"allowedRegions": [{"current": true,
"description": "string",
"link": "string",
"name": "string"
}
],
"companyName": "string",
"customRoleName": "string",
"dateFormat": "mm/dd/yyyy",
"delegatedDogfood": true,
"detailLevel": "ba",
"email": "string",
"externalId": "string",
"firstName": "string",
"lastName": "string",
"newDateFormat": "string",
"preferredLanguage": "string",
"region": "string",
"role": "string",
"roles": ["string"
],
"scopes": ["string"
],
"tenantId": "string",
"username": "string",
"var": true,
"varTenantId": "string"
}

Response samples

200
500

Content type

application/json

{"requestId": "string",
"response": {"adminId": "string",
"allowedRegions": [{"current": true,
"description": "string",
"id": "string",
"link": "string",
"name": "string"
}
],
"companyName": "string",
"customRoleName": "string",
"dateFormat": "mm/dd/yyyy",
"delegatedDogfood": true,
"detailLevel": "ba",
"dogfood": true,
"email": "string",
"externalId": "string",
"firstName": "string",
"lastName": "string",
"newDateFormat": "string",
"preferredLanguage": "string",
"pver": "string",
"region": "string",
"role": "string",
"roles": ["string"
],
"scopes": ["string"
],
"support": true,
"tenantId": "string",
"username": "string",
"var": true,
"varTenantId": "string"
}
}

Administrator

Manage administrators.

Delete Administrators

Delete administrators in bulk.

Request Body schema:
application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

202
500

Content type

application/json

{"requestId": "string",
"response": { }
}

Get Administrator

Get list of administrators.

query Parameters

withExternalId

boolean

Default: false

Responses

Response samples

200

Content type

application/json

[{"authenticationId": "string",
"delegateToAllECs": true,
"delegatedECs": ["string"
],
"detailLevel": "ba",
"email": "string",
"externalId": "string",
"id": "string",
"isManageAllEcs": true,
"lastLogin": "string",
"lastName": "string",
"manageAllEcs": true,
"name": "string",
"role": "string"
}
]

Add Administrator

Add administrator.

Request Body schema:
application/json
required

authenticationId

string

delegateToAllECs

boolean

If set to true, this admin is permitted to manage all delegated account IDs (RECs or MSP-ECs).

delegatedECs

Array of strings

List of delegated account IDs (RECs or MSP-ECs) that this admin is permitted to manage.

detailLevel

string

Enum: "ba" "it" "su" "debug"

Enum	Meaning
ba	Show events appropriate for a basic user.
it	Show events appropriate for someone having training as an IT administrator.
su	Show events appropriate for a super user.
debug	Show events useful for debugging purposes.

email

required

string

externalId

string

id

string

isManageAllEcs

boolean

lastLogin

string

lastName

string

manageAllEcs

boolean

name

string

role

required

string

Enum	Meaning
PRIME_ADMIN	Role with the highest level of administrator privilege; all actions are permitted.
ADMIN	Role permitting administrator to perform any action except personnel assignments (i.e., manage other administrators); for MSP's, this role is not permitted to manage (e.g., create or delete) MSP-ECs.
VAR_ADMIN	Role permitting VAR personnel the capability to manage delegated accounts.
READ_ONLY	Role permitting administrator to observe network configuration and operational data, but not the capability to change any configuration. Role can be appropriate for personnel training.
OFFICE_ADMIN	Role permitting administrator the capability to manage guest Wi-Fi users.
SUPPORT	Role for RUCKUS customer support; this role is not granted to any RUCKUS customer (it's included here for the sake of completeness).
DEVOPS	Role for RUCKUS DEVOPS; this role is not granted to any RUCKUS customer (it's included here for the sake of completeness).

Responses

Request samples

Payload

Content type

application/json

{"authenticationId": "string",
"delegateToAllECs": true,
"delegatedECs": ["string"
],
"detailLevel": "ba",
"email": "string",
"externalId": "string",
"id": "string",
"isManageAllEcs": true,
"lastLogin": "string",
"lastName": "string",
"manageAllEcs": true,
"name": "string",
"role": "string"
}

Response samples

202
400
500

Content type

application/json

{"requestId": "string",
"response": {"adminAppSettings": [{"appType": "UI",
"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"parentId": "string",
"productType": "WIFI",
"updatedDate": "2019-08-24T14:15:22Z",
"value": "string"
}
],
"adminRoles": [{"createdDate": "2019-08-24T14:15:22Z",
"delegated": "string",
"delegatedRoleType": "RKS_EC",
"id": "string",
"parentId": "string",
"privilegeGroup": {"createdDate": "2019-08-24T14:15:22Z",
"customRole": {"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"frameworkRO": true,
"id": "string",
"name": "string",
"parentId": "string",
"policyBased": true,
"preDefinedRole": "string",
"roleObjectPermissions": [{"add": true,
"apply": true,
"conditions": "string",
"createdDate": "2019-08-24T14:15:22Z",
"customRole": { },
"delete": true,
"entityInstanceId": "string",
"id": "string",
"objectType": "string",
"parentId": "string",
"privilegeGroup": { },
"read": true,
"roleEntity": {"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"objectType": "string",
"parentId": "string",
"roleObjectPermissions": [null
],
"serviceName": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"tenant": {"MspEcServiceDates": {"parentMspId": null,
"serviceEffectiveDate": null,
"serviceExpirationDate": null
},
"account": {"city": null,
"country": null,
"createdDate": null,
"faxNumber": null,
"id": null,
"mappingURL": null,
"parentId": null,
"phoneNumber": null,
"postalCode": null,
"state": null,
"streetAddress": null,
"type": null,
"updatedDate": null
},
"accountTier": "string",
"accountVertical": "string",
"admins": [null
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [null
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [null
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": null,
"changePasswordUrl": null,
"contactSupportUrl": null,
"contractSupportBehavior": null,
"defaultLogoUUID": null,
"email": null,
"isDisableNotification": null,
"logoUUID": null,
"mlisaLogoUUID": null,
"mspFQDN": null,
"mspLabel": null,
"myOpenCaseBehavior": null,
"myOpenCaseUrl": null,
"openCaseBehavior": null,
"openCaseUrl": null,
"phone": null,
"pingLoginLogoUUID": null,
"pingNotificationLogoUUID": null,
"website": null
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [null
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": null,
"recoveryCodes": null
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
},
"update": true,
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"roleType": "string",
"scopes": [{"createdDate": "2019-08-24T14:15:22Z",
"customRoles": [{ }
],
"features": [{"category": null,
"createdDate": null,
"description": null,
"id": null,
"name": null,
"parentId": null,
"scopes": [ ],
"updatedDate": null
}
],
"id": "string",
"name": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"tenant": {"MspEcServiceDates": {"parentMspId": "string",
"serviceEffectiveDate": "2019-08-24T14:15:22Z",
"serviceExpirationDate": "2019-08-24T14:15:22Z"
},
"account": {"city": "string",
"country": "string",
"createdDate": "2019-08-24T14:15:22Z",
"faxNumber": "string",
"id": "string",
"mappingURL": "string",
"parentId": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"streetAddress": "string",
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"accountTier": "string",
"accountVertical": "string",
"admins": [{ }
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [{"accountBased": true,
"authDomains": [null
],
"authScopes": [null
],
"authenticationType": "IDM",
"authorizationURL": "string",
"clientID": "string",
"clientIDStatus": "ACTIVE",
"clientSecret": "string",
"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"parentId": "string",
"samlFileType": "DIRECT_URL",
"samlFileURL": "string",
"scopes": "string",
"tokenURL": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [{"createdDate": "2019-08-24T14:15:22Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"id": "string",
"isValid": true,
"parentId": "string",
"status": "INVITED",
"type": "VAR",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": "string",
"changePasswordUrl": "string",
"contactSupportUrl": "string",
"contractSupportBehavior": "string",
"defaultLogoUUID": "string",
"email": "string",
"isDisableNotification": true,
"logoUUID": "string",
"mlisaLogoUUID": "string",
"mspFQDN": "string",
"mspLabel": "string",
"myOpenCaseBehavior": "string",
"myOpenCaseUrl": "string",
"openCaseBehavior": "string",
"openCaseUrl": "string",
"phone": "string",
"pingLoginLogoUUID": "string",
"pingNotificationLogoUUID": "string",
"website": "string"
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [{"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"endpoints": [null
],
"id": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": "string",
"recoveryCodes": "string"
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
},
"updatedDate": "2019-08-24T14:15:22Z"
},
"delegatedBy": "string",
"delegationDetails": "string",
"description": "string",
"hasDelegations": true,
"id": "string",
"memberCount": 0,
"mspCustomers": 0,
"name": "string",
"parentId": "string",
"parentPrivilegeGroupId": "string",
"readOnly": true,
"roleObjectPermissions": [{"add": true,
"apply": true,
"conditions": "string",
"createdDate": "2019-08-24T14:15:22Z",
"customRole": {"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"frameworkRO": true,
"id": "string",
"name": "string",
"parentId": "string",
"policyBased": true,
"preDefinedRole": "string",
"roleObjectPermissions": [{ }
],
"roleType": "string",
"scopes": [{"createdDate": null,
"customRoles": [ ],
"features": [ ],
"id": null,
"name": null,
"parentId": null,
"updatedDate": null
}
],
"tenant": {"MspEcServiceDates": {"parentMspId": null,
"serviceEffectiveDate": null,
"serviceExpirationDate": null
},
"account": {"city": null,
"country": null,
"createdDate": null,
"faxNumber": null,
"id": null,
"mappingURL": null,
"parentId": null,
"phoneNumber": null,
"postalCode": null,
"state": null,
"streetAddress": null,
"type": null,
"updatedDate": null
},
"accountTier": "string",
"accountVertical": "string",
"admins": [null
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [null
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [null
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": null,
"changePasswordUrl": null,
"contactSupportUrl": null,
"contractSupportBehavior": null,
"defaultLogoUUID": null,
"email": null,
"isDisableNotification": null,
"logoUUID": null,
"mlisaLogoUUID": null,
"mspFQDN": null,
"mspLabel": null,
"myOpenCaseBehavior": null,
"myOpenCaseUrl": null,
"openCaseBehavior": null,
"openCaseUrl": null,
"phone": null,
"pingLoginLogoUUID": null,
"pingNotificationLogoUUID": null,
"website": null
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [null
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": null,
"recoveryCodes": null
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
},
"updatedDate": "2019-08-24T14:15:22Z"
},
"delete": true,
"entityInstanceId": "string",
"id": "string",
"objectType": "string",
"parentId": "string",
"privilegeGroup": { },
"read": true,
"roleEntity": {"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"objectType": "string",
"parentId": "string",
"roleObjectPermissions": [{ }
],
"serviceName": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"tenant": {"MspEcServiceDates": {"parentMspId": "string",
"serviceEffectiveDate": "2019-08-24T14:15:22Z",
"serviceExpirationDate": "2019-08-24T14:15:22Z"
},
"account": {"city": "string",
"country": "string",
"createdDate": "2019-08-24T14:15:22Z",
"faxNumber": "string",
"id": "string",
"mappingURL": "string",
"parentId": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"streetAddress": "string",
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"accountTier": "string",
"accountVertical": "string",
"admins": [{ }
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [{"accountBased": null,
"authDomains": [ ],
"authScopes": [ ],
"authenticationType": null,
"authorizationURL": null,
"clientID": null,
"clientIDStatus": null,
"clientSecret": null,
"createdDate": null,
"id": null,
"name": null,
"parentId": null,
"samlFileType": null,
"samlFileURL": null,
"scopes": null,
"tokenURL": null,
"updatedDate": null
}
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [{"createdDate": null,
"delegatedBy": null,
"delegatedTo": null,
"delegatedToAdmin": null,
"delegatedToName": null,
"expiryDate": null,
"id": null,
"isValid": null,
"parentId": null,
"status": null,
"type": null,
"updatedDate": null
}
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": "string",
"changePasswordUrl": "string",
"contactSupportUrl": "string",
"contractSupportBehavior": "string",
"defaultLogoUUID": "string",
"email": "string",
"isDisableNotification": true,
"logoUUID": "string",
"mlisaLogoUUID": "string",
"mspFQDN": "string",
"mspLabel": "string",
"myOpenCaseBehavior": "string",
"myOpenCaseUrl": "string",
"openCaseBehavior": "string",
"openCaseUrl": "string",
"phone": "string",
"pingLoginLogoUUID": "string",
"pingNotificationLogoUUID": "string",
"website": "string"
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [{"createdDate": null,
"description": null,
"endpoints": [ ],
"id": null,
"parentId": null,
"updatedDate": null
}
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": "string",
"recoveryCodes": "string"
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
},
"update": true,
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"tenant": {"MspEcServiceDates": {"parentMspId": "string",
"serviceEffectiveDate": "2019-08-24T14:15:22Z",
"serviceExpirationDate": "2019-08-24T14:15:22Z"
},
"account": {"city": "string",
"country": "string",
"createdDate": "2019-08-24T14:15:22Z",
"faxNumber": "string",
"id": "string",
"mappingURL": "string",
"parentId": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"streetAddress": "string",
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"accountTier": "string",
"accountVertical": "string",
"admins": [{ }
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [{"accountBased": true,
"authDomains": [{"authentication": null,
"createdDate": null,
"domain": null,
"id": null,
"parentId": null,
"updatedDate": null
}
],
"authScopes": [{"authentication": null,
"createdDate": null,
"id": null,
"parentId": null,
"privilegeGroup": null,
"updatedDate": null
}
],
"authenticationType": "IDM",
"authorizationURL": "string",
"clientID": "string",
"clientIDStatus": "ACTIVE",
"clientSecret": "string",
"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"parentId": "string",
"samlFileType": "DIRECT_URL",
"samlFileURL": "string",
"scopes": "string",
"tokenURL": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [{"createdDate": "2019-08-24T14:15:22Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"id": "string",
"isValid": true,
"parentId": "string",
"status": "INVITED",
"type": "VAR",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": "string",
"changePasswordUrl": "string",
"contactSupportUrl": "string",
"contractSupportBehavior": "string",
"defaultLogoUUID": "string",
"email": "string",
"isDisableNotification": true,
"logoUUID": "string",
"mlisaLogoUUID": "string",
"mspFQDN": "string",
"mspLabel": "string",
"myOpenCaseBehavior": "string",
"myOpenCaseUrl": "string",
"openCaseBehavior": "string",
"openCaseUrl": "string",
"phone": "string",
"pingLoginLogoUUID": "string",
"pingNotificationLogoUUID": "string",
"website": "string"
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [{"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"endpoints": [{"active": null,
"createdDate": null,
"destination": null,
"id": null,
"parentId": null,
"status": null,
"type": null,
"updatedDate": null
}
],
"id": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": "string",
"recoveryCodes": "string"
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
},
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"role": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"authentication": {"accountBased": true,
"authDomains": [{"authentication": { },
"createdDate": "2019-08-24T14:15:22Z",
"domain": "string",
"id": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"authScopes": [{"authentication": { },
"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"parentId": "string",
"privilegeGroup": {"createdDate": "2019-08-24T14:15:22Z",
"customRole": {"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"frameworkRO": true,
"id": "string",
"name": "string",
"parentId": "string",
"policyBased": true,
"preDefinedRole": "string",
"roleObjectPermissions": [{"add": true,
"apply": true,
"conditions": "string",
"createdDate": "2019-08-24T14:15:22Z",
"customRole": { },
"delete": true,
"entityInstanceId": "string",
"id": "string",
"objectType": "string",
"parentId": "string",
"privilegeGroup": { },
"read": true,
"roleEntity": {"createdDate": null,
"id": null,
"objectType": null,
"parentId": null,
"roleObjectPermissions": [ ],
"serviceName": null,
"updatedDate": null
},
"tenant": {"MspEcServiceDates": null,
"account": null,
"accountTier": null,
"accountVertical": null,
"admins": [ ],
"aggregateNotifications": null,
"almActivated": null,
"almActivationDate": null,
"almMigrationDate": null,
"almMigrationFlag": null,
"almSysAccountId": null,
"authentications": [ ],
"createdDate": null,
"delegationsTo": [ ],
"entitlementId": null,
"excludeecforAggregation": null,
"externalId": null,
"externalModifiedDate": null,
"id": null,
"isActivated": null,
"maintenanceDate": null,
"maintenanceState": null,
"msp": null,
"mspPingOrgId": null,
"name": null,
"notificationRecipients": [ ],
"obsolete": null,
"oemName": null,
"parentId": null,
"pingMigrated": null,
"preferences": null,
"ruckusUser": null,
"serviceAccount": null,
"status": null,
"tenantMFA": null,
"tenantType": null,
"updatedDate": null,
"upgradeGroup": null
},
"update": true,
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"roleType": "string",
"scopes": [{"createdDate": "2019-08-24T14:15:22Z",
"customRoles": [null
],
"features": [null
],
"id": "string",
"name": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"tenant": {"MspEcServiceDates": {"parentMspId": "string",
"serviceEffectiveDate": "2019-08-24T14:15:22Z",
"serviceExpirationDate": "2019-08-24T14:15:22Z"
},
"account": {"city": "string",
"country": "string",
"createdDate": "2019-08-24T14:15:22Z",
"faxNumber": "string",
"id": "string",
"mappingURL": "string",
"parentId": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"streetAddress": "string",
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"accountTier": "string",
"accountVertical": "string",
"admins": [{ }
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [{ }
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [{"createdDate": null,
"delegatedBy": null,
"delegatedTo": null,
"delegatedToAdmin": null,
"delegatedToName": null,
"expiryDate": null,
"id": null,
"isValid": null,
"parentId": null,
"status": null,
"type": null,
"updatedDate": null
}
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": "string",
"changePasswordUrl": "string",
"contactSupportUrl": "string",
"contractSupportBehavior": "string",
"defaultLogoUUID": "string",
"email": "string",
"isDisableNotification": true,
"logoUUID": "string",
"mlisaLogoUUID": "string",
"mspFQDN": "string",
"mspLabel": "string",
"myOpenCaseBehavior": "string",
"myOpenCaseUrl": "string",
"openCaseBehavior": "string",
"openCaseUrl": "string",
"phone": "string",
"pingLoginLogoUUID": "string",
"pingNotificationLogoUUID": "string",
"website": "string"
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [{"createdDate": null,
"description": null,
"endpoints": [ ],
"id": null,
"parentId": null,
"updatedDate": null
}
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": "string",
"recoveryCodes": "string"
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
},
"updatedDate": "2019-08-24T14:15:22Z"
},
"delegatedBy": "string",
"delegationDetails": "string",
"description": "string",
"hasDelegations": true,
"id": "string",
"memberCount": 0,
"mspCustomers": 0,
"name": "string",
"parentId": "string",
"parentPrivilegeGroupId": "string",
"readOnly": true,
"roleObjectPermissions": [{"add": true,
"apply": true,
"conditions": "string",
"createdDate": "2019-08-24T14:15:22Z",
"customRole": {"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"frameworkRO": true,
"id": "string",
"name": "string",
"parentId": "string",
"policyBased": true,
"preDefinedRole": "string",
"roleObjectPermissions": [null
],
"roleType": "string",
"scopes": [null
],
"tenant": {"MspEcServiceDates": null,
"account": null,
"accountTier": null,
"accountVertical": null,
"admins": [ ],
"aggregateNotifications": null,
"almActivated": null,
"almActivationDate": null,
"almMigrationDate": null,
"almMigrationFlag": null,
"almSysAccountId": null,
"authentications": [ ],
"createdDate": null,
"delegationsTo": [ ],
"entitlementId": null,
"excludeecforAggregation": null,
"externalId": null,
"externalModifiedDate": null,
"id": null,
"isActivated": null,
"maintenanceDate": null,
"maintenanceState": null,
"msp": null,
"mspPingOrgId": null,
"name": null,
"notificationRecipients": [ ],
"obsolete": null,
"oemName": null,
"parentId": null,
"pingMigrated": null,
"preferences": null,
"ruckusUser": null,
"serviceAccount": null,
"status": null,
"tenantMFA": null,
"tenantType": null,
"updatedDate": null,
"upgradeGroup": null
},
"updatedDate": "2019-08-24T14:15:22Z"
},
"delete": true,
"entityInstanceId": "string",
"id": "string",
"objectType": "string",
"parentId": "string",
"privilegeGroup": { },
"read": true,
"roleEntity": {"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"objectType": "string",
"parentId": "string",
"roleObjectPermissions": [null
],
"serviceName": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"tenant": {"MspEcServiceDates": {"parentMspId": null,
"serviceEffectiveDate": null,
"serviceExpirationDate": null
},
"account": {"city": null,
"country": null,
"createdDate": null,
"faxNumber": null,
"id": null,
"mappingURL": null,
"parentId": null,
"phoneNumber": null,
"postalCode": null,
"state": null,
"streetAddress": null,
"type": null,
"updatedDate": null
},
"accountTier": "string",
"accountVertical": "string",
"admins": [null
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [null
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [null
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": null,
"changePasswordUrl": null,
"contactSupportUrl": null,
"contractSupportBehavior": null,
"defaultLogoUUID": null,
"email": null,
"isDisableNotification": null,
"logoUUID": null,
"mlisaLogoUUID": null,
"mspFQDN": null,
"mspLabel": null,
"myOpenCaseBehavior": null,
"myOpenCaseUrl": null,
"openCaseBehavior": null,
"openCaseUrl": null,
"phone": null,
"pingLoginLogoUUID": null,
"pingNotificationLogoUUID": null,
"website": null
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [null
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": null,
"recoveryCodes": null
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
},
"update": true,
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"tenant": {"MspEcServiceDates": {"parentMspId": "string",
"serviceEffectiveDate": "2019-08-24T14:15:22Z",
"serviceExpirationDate": "2019-08-24T14:15:22Z"
},
"account": {"city": "string",
"country": "string",
"createdDate": "2019-08-24T14:15:22Z",
"faxNumber": "string",
"id": "string",
"mappingURL": "string",
"parentId": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"streetAddress": "string",
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"accountTier": "string",
"accountVertical": "string",
"admins": [{ }
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [{ }
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [{"createdDate": "2019-08-24T14:15:22Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"id": "string",
"isValid": true,
"parentId": "string",
"status": "INVITED",
"type": "VAR",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": "string",
"changePasswordUrl": "string",
"contactSupportUrl": "string",
"contractSupportBehavior": "string",
"defaultLogoUUID": "string",
"email": "string",
"isDisableNotification": true,
"logoUUID": "string",
"mlisaLogoUUID": "string",
"mspFQDN": "string",
"mspLabel": "string",
"myOpenCaseBehavior": "string",
"myOpenCaseUrl": "string",
"openCaseBehavior": "string",
"openCaseUrl": "string",
"phone": "string",
"pingLoginLogoUUID": "string",
"pingNotificationLogoUUID": "string",
"website": "string"
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [{"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"endpoints": [null
],
"id": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": "string",
"recoveryCodes": "string"
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
},
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"authenticationType": "IDM",
"authorizationURL": "string",
"clientID": "string",
"clientIDStatus": "ACTIVE",
"clientSecret": "string",
"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"parentId": "string",
"samlFileType": "DIRECT_URL",
"samlFileURL": "string",
"scopes": "string",
"tokenURL": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"createdDate": "2019-08-24T14:15:22Z",
"dateFormat": "mm/dd/yyyy",
"detailLevel": "ba",
"externalId": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z",
"username": "string"
}
}

Update Administrator

Update administrator.

Request Body schema:
application/json
required

authenticationId

string

delegateToAllECs

boolean

If set to true, this admin is permitted to manage all delegated account IDs (RECs or MSP-ECs).

delegatedECs

Array of strings

List of delegated account IDs (RECs or MSP-ECs) that this admin is permitted to manage.

detailLevel

string

Enum: "ba" "it" "su" "debug"

Enum	Meaning
ba	Show events appropriate for a basic user.
it	Show events appropriate for someone having training as an IT administrator.
su	Show events appropriate for a super user.
debug	Show events useful for debugging purposes.

email

required

string

externalId

string

id

string

isManageAllEcs

boolean

lastLogin

string

lastName

string

manageAllEcs

boolean

name

string

role

required

string

Enum	Meaning
PRIME_ADMIN	Role with the highest level of administrator privilege; all actions are permitted.
ADMIN	Role permitting administrator to perform any action except personnel assignments (i.e., manage other administrators); for MSP's, this role is not permitted to manage (e.g., create or delete) MSP-ECs.
VAR_ADMIN	Role permitting VAR personnel the capability to manage delegated accounts.
READ_ONLY	Role permitting administrator to observe network configuration and operational data, but not the capability to change any configuration. Role can be appropriate for personnel training.
OFFICE_ADMIN	Role permitting administrator the capability to manage guest Wi-Fi users.
SUPPORT	Role for RUCKUS customer support; this role is not granted to any RUCKUS customer (it's included here for the sake of completeness).
DEVOPS	Role for RUCKUS DEVOPS; this role is not granted to any RUCKUS customer (it's included here for the sake of completeness).

Responses

Request samples

Payload

Content type

application/json

{"authenticationId": "string",
"delegateToAllECs": true,
"delegatedECs": ["string"
],
"detailLevel": "ba",
"email": "string",
"externalId": "string",
"id": "string",
"isManageAllEcs": true,
"lastLogin": "string",
"lastName": "string",
"manageAllEcs": true,
"name": "string",
"role": "string"
}

Response samples

202
500

Content type

application/json

{"requestId": "string",
"response": {"adminAppSettings": [{"appType": "UI",
"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"parentId": "string",
"productType": "WIFI",
"updatedDate": "2019-08-24T14:15:22Z",
"value": "string"
}
],
"adminRoles": [{"createdDate": "2019-08-24T14:15:22Z",
"delegated": "string",
"delegatedRoleType": "RKS_EC",
"id": "string",
"parentId": "string",
"privilegeGroup": {"createdDate": "2019-08-24T14:15:22Z",
"customRole": {"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"frameworkRO": true,
"id": "string",
"name": "string",
"parentId": "string",
"policyBased": true,
"preDefinedRole": "string",
"roleObjectPermissions": [{"add": true,
"apply": true,
"conditions": "string",
"createdDate": "2019-08-24T14:15:22Z",
"customRole": { },
"delete": true,
"entityInstanceId": "string",
"id": "string",
"objectType": "string",
"parentId": "string",
"privilegeGroup": { },
"read": true,
"roleEntity": {"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"objectType": "string",
"parentId": "string",
"roleObjectPermissions": [null
],
"serviceName": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"tenant": {"MspEcServiceDates": {"parentMspId": null,
"serviceEffectiveDate": null,
"serviceExpirationDate": null
},
"account": {"city": null,
"country": null,
"createdDate": null,
"faxNumber": null,
"id": null,
"mappingURL": null,
"parentId": null,
"phoneNumber": null,
"postalCode": null,
"state": null,
"streetAddress": null,
"type": null,
"updatedDate": null
},
"accountTier": "string",
"accountVertical": "string",
"admins": [null
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [null
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [null
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": null,
"changePasswordUrl": null,
"contactSupportUrl": null,
"contractSupportBehavior": null,
"defaultLogoUUID": null,
"email": null,
"isDisableNotification": null,
"logoUUID": null,
"mlisaLogoUUID": null,
"mspFQDN": null,
"mspLabel": null,
"myOpenCaseBehavior": null,
"myOpenCaseUrl": null,
"openCaseBehavior": null,
"openCaseUrl": null,
"phone": null,
"pingLoginLogoUUID": null,
"pingNotificationLogoUUID": null,
"website": null
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [null
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": null,
"recoveryCodes": null
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
},
"update": true,
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"roleType": "string",
"scopes": [{"createdDate": "2019-08-24T14:15:22Z",
"customRoles": [{ }
],
"features": [{"category": null,
"createdDate": null,
"description": null,
"id": null,
"name": null,
"parentId": null,
"scopes": [ ],
"updatedDate": null
}
],
"id": "string",
"name": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"tenant": {"MspEcServiceDates": {"parentMspId": "string",
"serviceEffectiveDate": "2019-08-24T14:15:22Z",
"serviceExpirationDate": "2019-08-24T14:15:22Z"
},
"account": {"city": "string",
"country": "string",
"createdDate": "2019-08-24T14:15:22Z",
"faxNumber": "string",
"id": "string",
"mappingURL": "string",
"parentId": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"streetAddress": "string",
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"accountTier": "string",
"accountVertical": "string",
"admins": [{ }
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [{"accountBased": true,
"authDomains": [null
],
"authScopes": [null
],
"authenticationType": "IDM",
"authorizationURL": "string",
"clientID": "string",
"clientIDStatus": "ACTIVE",
"clientSecret": "string",
"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"parentId": "string",
"samlFileType": "DIRECT_URL",
"samlFileURL": "string",
"scopes": "string",
"tokenURL": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [{"createdDate": "2019-08-24T14:15:22Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"id": "string",
"isValid": true,
"parentId": "string",
"status": "INVITED",
"type": "VAR",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": "string",
"changePasswordUrl": "string",
"contactSupportUrl": "string",
"contractSupportBehavior": "string",
"defaultLogoUUID": "string",
"email": "string",
"isDisableNotification": true,
"logoUUID": "string",
"mlisaLogoUUID": "string",
"mspFQDN": "string",
"mspLabel": "string",
"myOpenCaseBehavior": "string",
"myOpenCaseUrl": "string",
"openCaseBehavior": "string",
"openCaseUrl": "string",
"phone": "string",
"pingLoginLogoUUID": "string",
"pingNotificationLogoUUID": "string",
"website": "string"
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [{"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"endpoints": [null
],
"id": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": "string",
"recoveryCodes": "string"
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
},
"updatedDate": "2019-08-24T14:15:22Z"
},
"delegatedBy": "string",
"delegationDetails": "string",
"description": "string",
"hasDelegations": true,
"id": "string",
"memberCount": 0,
"mspCustomers": 0,
"name": "string",
"parentId": "string",
"parentPrivilegeGroupId": "string",
"readOnly": true,
"roleObjectPermissions": [{"add": true,
"apply": true,
"conditions": "string",
"createdDate": "2019-08-24T14:15:22Z",
"customRole": {"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"frameworkRO": true,
"id": "string",
"name": "string",
"parentId": "string",
"policyBased": true,
"preDefinedRole": "string",
"roleObjectPermissions": [{ }
],
"roleType": "string",
"scopes": [{"createdDate": null,
"customRoles": [ ],
"features": [ ],
"id": null,
"name": null,
"parentId": null,
"updatedDate": null
}
],
"tenant": {"MspEcServiceDates": {"parentMspId": null,
"serviceEffectiveDate": null,
"serviceExpirationDate": null
},
"account": {"city": null,
"country": null,
"createdDate": null,
"faxNumber": null,
"id": null,
"mappingURL": null,
"parentId": null,
"phoneNumber": null,
"postalCode": null,
"state": null,
"streetAddress": null,
"type": null,
"updatedDate": null
},
"accountTier": "string",
"accountVertical": "string",
"admins": [null
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [null
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [null
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": null,
"changePasswordUrl": null,
"contactSupportUrl": null,
"contractSupportBehavior": null,
"defaultLogoUUID": null,
"email": null,
"isDisableNotification": null,
"logoUUID": null,
"mlisaLogoUUID": null,
"mspFQDN": null,
"mspLabel": null,
"myOpenCaseBehavior": null,
"myOpenCaseUrl": null,
"openCaseBehavior": null,
"openCaseUrl": null,
"phone": null,
"pingLoginLogoUUID": null,
"pingNotificationLogoUUID": null,
"website": null
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [null
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": null,
"recoveryCodes": null
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
},
"updatedDate": "2019-08-24T14:15:22Z"
},
"delete": true,
"entityInstanceId": "string",
"id": "string",
"objectType": "string",
"parentId": "string",
"privilegeGroup": { },
"read": true,
"roleEntity": {"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"objectType": "string",
"parentId": "string",
"roleObjectPermissions": [{ }
],
"serviceName": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"tenant": {"MspEcServiceDates": {"parentMspId": "string",
"serviceEffectiveDate": "2019-08-24T14:15:22Z",
"serviceExpirationDate": "2019-08-24T14:15:22Z"
},
"account": {"city": "string",
"country": "string",
"createdDate": "2019-08-24T14:15:22Z",
"faxNumber": "string",
"id": "string",
"mappingURL": "string",
"parentId": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"streetAddress": "string",
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"accountTier": "string",
"accountVertical": "string",
"admins": [{ }
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [{"accountBased": null,
"authDomains": [ ],
"authScopes": [ ],
"authenticationType": null,
"authorizationURL": null,
"clientID": null,
"clientIDStatus": null,
"clientSecret": null,
"createdDate": null,
"id": null,
"name": null,
"parentId": null,
"samlFileType": null,
"samlFileURL": null,
"scopes": null,
"tokenURL": null,
"updatedDate": null
}
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [{"createdDate": null,
"delegatedBy": null,
"delegatedTo": null,
"delegatedToAdmin": null,
"delegatedToName": null,
"expiryDate": null,
"id": null,
"isValid": null,
"parentId": null,
"status": null,
"type": null,
"updatedDate": null
}
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": "string",
"changePasswordUrl": "string",
"contactSupportUrl": "string",
"contractSupportBehavior": "string",
"defaultLogoUUID": "string",
"email": "string",
"isDisableNotification": true,
"logoUUID": "string",
"mlisaLogoUUID": "string",
"mspFQDN": "string",
"mspLabel": "string",
"myOpenCaseBehavior": "string",
"myOpenCaseUrl": "string",
"openCaseBehavior": "string",
"openCaseUrl": "string",
"phone": "string",
"pingLoginLogoUUID": "string",
"pingNotificationLogoUUID": "string",
"website": "string"
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [{"createdDate": null,
"description": null,
"endpoints": [ ],
"id": null,
"parentId": null,
"updatedDate": null
}
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": "string",
"recoveryCodes": "string"
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
},
"update": true,
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"tenant": {"MspEcServiceDates": {"parentMspId": "string",
"serviceEffectiveDate": "2019-08-24T14:15:22Z",
"serviceExpirationDate": "2019-08-24T14:15:22Z"
},
"account": {"city": "string",
"country": "string",
"createdDate": "2019-08-24T14:15:22Z",
"faxNumber": "string",
"id": "string",
"mappingURL": "string",
"parentId": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"streetAddress": "string",
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"accountTier": "string",
"accountVertical": "string",
"admins": [{ }
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [{"accountBased": true,
"authDomains": [{"authentication": null,
"createdDate": null,
"domain": null,
"id": null,
"parentId": null,
"updatedDate": null
}
],
"authScopes": [{"authentication": null,
"createdDate": null,
"id": null,
"parentId": null,
"privilegeGroup": null,
"updatedDate": null
}
],
"authenticationType": "IDM",
"authorizationURL": "string",
"clientID": "string",
"clientIDStatus": "ACTIVE",
"clientSecret": "string",
"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"parentId": "string",
"samlFileType": "DIRECT_URL",
"samlFileURL": "string",
"scopes": "string",
"tokenURL": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [{"createdDate": "2019-08-24T14:15:22Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"id": "string",
"isValid": true,
"parentId": "string",
"status": "INVITED",
"type": "VAR",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": "string",
"changePasswordUrl": "string",
"contactSupportUrl": "string",
"contractSupportBehavior": "string",
"defaultLogoUUID": "string",
"email": "string",
"isDisableNotification": true,
"logoUUID": "string",
"mlisaLogoUUID": "string",
"mspFQDN": "string",
"mspLabel": "string",
"myOpenCaseBehavior": "string",
"myOpenCaseUrl": "string",
"openCaseBehavior": "string",
"openCaseUrl": "string",
"phone": "string",
"pingLoginLogoUUID": "string",
"pingNotificationLogoUUID": "string",
"website": "string"
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [{"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"endpoints": [{"active": null,
"createdDate": null,
"destination": null,
"id": null,
"parentId": null,
"status": null,
"type": null,
"updatedDate": null
}
],
"id": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": "string",
"recoveryCodes": "string"
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
},
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"role": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"authentication": {"accountBased": true,
"authDomains": [{"authentication": { },
"createdDate": "2019-08-24T14:15:22Z",
"domain": "string",
"id": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"authScopes": [{"authentication": { },
"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"parentId": "string",
"privilegeGroup": {"createdDate": "2019-08-24T14:15:22Z",
"customRole": {"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"frameworkRO": true,
"id": "string",
"name": "string",
"parentId": "string",
"policyBased": true,
"preDefinedRole": "string",
"roleObjectPermissions": [{"add": true,
"apply": true,
"conditions": "string",
"createdDate": "2019-08-24T14:15:22Z",
"customRole": { },
"delete": true,
"entityInstanceId": "string",
"id": "string",
"objectType": "string",
"parentId": "string",
"privilegeGroup": { },
"read": true,
"roleEntity": {"createdDate": null,
"id": null,
"objectType": null,
"parentId": null,
"roleObjectPermissions": [ ],
"serviceName": null,
"updatedDate": null
},
"tenant": {"MspEcServiceDates": null,
"account": null,
"accountTier": null,
"accountVertical": null,
"admins": [ ],
"aggregateNotifications": null,
"almActivated": null,
"almActivationDate": null,
"almMigrationDate": null,
"almMigrationFlag": null,
"almSysAccountId": null,
"authentications": [ ],
"createdDate": null,
"delegationsTo": [ ],
"entitlementId": null,
"excludeecforAggregation": null,
"externalId": null,
"externalModifiedDate": null,
"id": null,
"isActivated": null,
"maintenanceDate": null,
"maintenanceState": null,
"msp": null,
"mspPingOrgId": null,
"name": null,
"notificationRecipients": [ ],
"obsolete": null,
"oemName": null,
"parentId": null,
"pingMigrated": null,
"preferences": null,
"ruckusUser": null,
"serviceAccount": null,
"status": null,
"tenantMFA": null,
"tenantType": null,
"updatedDate": null,
"upgradeGroup": null
},
"update": true,
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"roleType": "string",
"scopes": [{"createdDate": "2019-08-24T14:15:22Z",
"customRoles": [null
],
"features": [null
],
"id": "string",
"name": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"tenant": {"MspEcServiceDates": {"parentMspId": "string",
"serviceEffectiveDate": "2019-08-24T14:15:22Z",
"serviceExpirationDate": "2019-08-24T14:15:22Z"
},
"account": {"city": "string",
"country": "string",
"createdDate": "2019-08-24T14:15:22Z",
"faxNumber": "string",
"id": "string",
"mappingURL": "string",
"parentId": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"streetAddress": "string",
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"accountTier": "string",
"accountVertical": "string",
"admins": [{ }
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [{ }
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [{"createdDate": null,
"delegatedBy": null,
"delegatedTo": null,
"delegatedToAdmin": null,
"delegatedToName": null,
"expiryDate": null,
"id": null,
"isValid": null,
"parentId": null,
"status": null,
"type": null,
"updatedDate": null
}
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": "string",
"changePasswordUrl": "string",
"contactSupportUrl": "string",
"contractSupportBehavior": "string",
"defaultLogoUUID": "string",
"email": "string",
"isDisableNotification": true,
"logoUUID": "string",
"mlisaLogoUUID": "string",
"mspFQDN": "string",
"mspLabel": "string",
"myOpenCaseBehavior": "string",
"myOpenCaseUrl": "string",
"openCaseBehavior": "string",
"openCaseUrl": "string",
"phone": "string",
"pingLoginLogoUUID": "string",
"pingNotificationLogoUUID": "string",
"website": "string"
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [{"createdDate": null,
"description": null,
"endpoints": [ ],
"id": null,
"parentId": null,
"updatedDate": null
}
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": "string",
"recoveryCodes": "string"
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
},
"updatedDate": "2019-08-24T14:15:22Z"
},
"delegatedBy": "string",
"delegationDetails": "string",
"description": "string",
"hasDelegations": true,
"id": "string",
"memberCount": 0,
"mspCustomers": 0,
"name": "string",
"parentId": "string",
"parentPrivilegeGroupId": "string",
"readOnly": true,
"roleObjectPermissions": [{"add": true,
"apply": true,
"conditions": "string",
"createdDate": "2019-08-24T14:15:22Z",
"customRole": {"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"frameworkRO": true,
"id": "string",
"name": "string",
"parentId": "string",
"policyBased": true,
"preDefinedRole": "string",
"roleObjectPermissions": [null
],
"roleType": "string",
"scopes": [null
],
"tenant": {"MspEcServiceDates": null,
"account": null,
"accountTier": null,
"accountVertical": null,
"admins": [ ],
"aggregateNotifications": null,
"almActivated": null,
"almActivationDate": null,
"almMigrationDate": null,
"almMigrationFlag": null,
"almSysAccountId": null,
"authentications": [ ],
"createdDate": null,
"delegationsTo": [ ],
"entitlementId": null,
"excludeecforAggregation": null,
"externalId": null,
"externalModifiedDate": null,
"id": null,
"isActivated": null,
"maintenanceDate": null,
"maintenanceState": null,
"msp": null,
"mspPingOrgId": null,
"name": null,
"notificationRecipients": [ ],
"obsolete": null,
"oemName": null,
"parentId": null,
"pingMigrated": null,
"preferences": null,
"ruckusUser": null,
"serviceAccount": null,
"status": null,
"tenantMFA": null,
"tenantType": null,
"updatedDate": null,
"upgradeGroup": null
},
"updatedDate": "2019-08-24T14:15:22Z"
},
"delete": true,
"entityInstanceId": "string",
"id": "string",
"objectType": "string",
"parentId": "string",
"privilegeGroup": { },
"read": true,
"roleEntity": {"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"objectType": "string",
"parentId": "string",
"roleObjectPermissions": [null
],
"serviceName": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"tenant": {"MspEcServiceDates": {"parentMspId": null,
"serviceEffectiveDate": null,
"serviceExpirationDate": null
},
"account": {"city": null,
"country": null,
"createdDate": null,
"faxNumber": null,
"id": null,
"mappingURL": null,
"parentId": null,
"phoneNumber": null,
"postalCode": null,
"state": null,
"streetAddress": null,
"type": null,
"updatedDate": null
},
"accountTier": "string",
"accountVertical": "string",
"admins": [null
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [null
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [null
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": null,
"changePasswordUrl": null,
"contactSupportUrl": null,
"contractSupportBehavior": null,
"defaultLogoUUID": null,
"email": null,
"isDisableNotification": null,
"logoUUID": null,
"mlisaLogoUUID": null,
"mspFQDN": null,
"mspLabel": null,
"myOpenCaseBehavior": null,
"myOpenCaseUrl": null,
"openCaseBehavior": null,
"openCaseUrl": null,
"phone": null,
"pingLoginLogoUUID": null,
"pingNotificationLogoUUID": null,
"website": null
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [null
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": null,
"recoveryCodes": null
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
},
"update": true,
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"tenant": {"MspEcServiceDates": {"parentMspId": "string",
"serviceEffectiveDate": "2019-08-24T14:15:22Z",
"serviceExpirationDate": "2019-08-24T14:15:22Z"
},
"account": {"city": "string",
"country": "string",
"createdDate": "2019-08-24T14:15:22Z",
"faxNumber": "string",
"id": "string",
"mappingURL": "string",
"parentId": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"streetAddress": "string",
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"accountTier": "string",
"accountVertical": "string",
"admins": [{ }
],
"aggregateNotifications": true,
"almActivated": true,
"almActivationDate": "2019-08-24T14:15:22Z",
"almMigrationDate": "2019-08-24T14:15:22Z",
"almMigrationFlag": true,
"almSysAccountId": "string",
"authentications": [{ }
],
"createdDate": "2019-08-24T14:15:22Z",
"delegationsTo": [{"createdDate": "2019-08-24T14:15:22Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"id": "string",
"isValid": true,
"parentId": "string",
"status": "INVITED",
"type": "VAR",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"entitlementId": "string",
"excludeecforAggregation": true,
"externalId": "string",
"externalModifiedDate": "2019-08-24T14:15:22Z",
"id": "string",
"isActivated": true,
"maintenanceDate": "2019-08-24T14:15:22Z",
"maintenanceState": true,
"msp": {"alarmNotificationLogoUUID": "string",
"changePasswordUrl": "string",
"contactSupportUrl": "string",
"contractSupportBehavior": "string",
"defaultLogoUUID": "string",
"email": "string",
"isDisableNotification": true,
"logoUUID": "string",
"mlisaLogoUUID": "string",
"mspFQDN": "string",
"mspLabel": "string",
"myOpenCaseBehavior": "string",
"myOpenCaseUrl": "string",
"openCaseBehavior": "string",
"openCaseUrl": "string",
"phone": "string",
"pingLoginLogoUUID": "string",
"pingNotificationLogoUUID": "string",
"website": "string"
},
"mspPingOrgId": "string",
"name": "string",
"notificationRecipients": [{"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"endpoints": [null
],
"id": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"obsolete": true,
"oemName": "string",
"parentId": "string",
"pingMigrated": true,
"preferences": "string",
"ruckusUser": true,
"serviceAccount": true,
"status": "active",
"tenantMFA": {"mfaStatus": "string",
"recoveryCodes": "string"
},
"tenantType": "REC",
"updatedDate": "2019-08-24T14:15:22Z",
"upgradeGroup": "string"
},
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"authenticationType": "IDM",
"authorizationURL": "string",
"clientID": "string",
"clientIDStatus": "ACTIVE",
"clientSecret": "string",
"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"parentId": "string",
"samlFileType": "DIRECT_URL",
"samlFileURL": "string",
"scopes": "string",
"tokenURL": "string",
"updatedDate": "2019-08-24T14:15:22Z"
},
"createdDate": "2019-08-24T14:15:22Z",
"dateFormat": "mm/dd/yyyy",
"detailLevel": "ba",
"externalId": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"parentId": "string",
"updatedDate": "2019-08-24T14:15:22Z",
"username": "string"
}
}

Delete Administrator

Delete administrator by identifier.

path Parameters

adminId

required

string

Responses

Response samples

202
500

Content type

application/json

{"requestId": "string",
"response": { }
}

Get Administrator

Get administrator by identifier.

path Parameters

adminId

required

string

Responses

Response samples

200

Content type

application/json

{"authenticationId": "string",
"delegateToAllECs": true,
"delegatedECs": ["string"
],
"detailLevel": "ba",
"email": "string",
"externalId": "string",
"id": "string",
"isManageAllEcs": true,
"lastLogin": "string",
"lastName": "string",
"manageAllEcs": true,
"name": "string",
"role": "string"
}

acx-mobile-push-notification-endpoint-controller

addMobilePushNotifications

query Parameters

app

string

Request Body schema:
application/json
required

active	boolean
destination required	string The email address to which notifications are sent.
id	string
status	string Enum: "OK" "BOUNCED" This parameter is set to bounced when emails are not deliverable to the destination.
type	string Tenant_Management_API_EmailNotificationEndpoint

Responses

Request samples

Payload

Content type

application/json

Example

Tenant_Management_API_EmailNotificationEndpoint

{"active": true,
"destination": "string",
"id": "string",
"status": "OK",
"type": "Tenant_Management_API_EmailNotificationEndpoint"
}

Response samples

200

Content type

application/json

{"requestId": "string",
"response": {"active": true,
"createdDate": "2019-08-24T14:15:22Z",
"destination": "string",
"id": "string",
"parentId": "string",
"status": "OK",
"type": "string",
"updatedDate": "2019-08-24T14:15:22Z",
"deviceId": "string",
"deviceToken": "string",
"platform": "string"
}
}

authentication-controller

Get Authentications

Get all authentications.

query Parameters

withExtendedRole

boolean

Default: false

Responses

Response samples

200

Content type

application/json

[{"authenticationType": "IDM",
"authorizationURL": "string",
"clientID": "string",
"clientIDStatus": "ACTIVE",
"clientSecret": "string",
"domains": ["string"
],
"id": "string",
"name": "string",
"samlFileType": "DIRECT_URL",
"samlFileURL": "string",
"scopes": "string",
"tokenURL": "string"
}
]

Add Authentication

Add authentication.

Request Body schema:
application/json
required

authenticationType required	string Enum: "IDM" "SAML" "OATH2_OIDC" "OAUTH2_CLIENT_CREDENTIALS" "LDAP" "GOOGLE_WORKSPACE"
authorizationURL	string
clientID	string
clientIDStatus	string Enum: "ACTIVE" "REVOKED"
clientSecret	string
domains	Array of strings
id	string
name required	string
samlFileType	string Enum: "DIRECT_URL" "FILE"
samlFileURL	string
scopes	string
tokenURL	string

Responses

Request samples

Payload

Content type

application/json

{"authenticationType": "IDM",
"authorizationURL": "string",
"clientID": "string",
"clientIDStatus": "ACTIVE",
"clientSecret": "string",
"domains": ["string"
],
"id": "string",
"name": "string",
"samlFileType": "DIRECT_URL",
"samlFileURL": "string",
"scopes": "string",
"tokenURL": "string"
}

Response samples

200

Content type

application/json

{"authenticationType": "IDM",
"authorizationURL": "string",
"clientID": "string",
"clientIDStatus": "ACTIVE",
"clientSecret": "string",
"domains": ["string"
],
"id": "string",
"name": "string",
"samlFileType": "DIRECT_URL",
"samlFileURL": "string",
"scopes": "string",
"tokenURL": "string"
}

RADIUS Attribute Group

Manage the RADIUS attribute groups.

Get RADIUS Attribute Groups

Gets the complete list of RADIUS attribute group in a paged format.

Responses

Create RADIUS Attribute Group

Creates a RADIUS attribute group with the requested values.

Request Body schema: application/json
required

	object (RADIUS_Attribute_Group_Management_REST_API_Links)
required	Array of objects (RADIUS_Attribute_Group_Management_REST_API_Attribute Assignment) The RADIUS attributes that are assigned to this group.
attributeCount	integer <int32> The number of attributes assigned to this attribute group. Allows sorting and filtering.
description	string The the description for this attribute group.
externalAssignmentsCount	integer <int32> The number of attributes assigned to this attribute group. Allows sorting and filtering.
	Array of objects (RADIUS_Attribute_Group_Management_REST_API_External Assignment Service Group) The number of attributes assigned to this attribute group. Allows sorting and filtering.
id	string <uuid> The unique identifier for this attribute group.
name required	string The the name for this attribute group.

Responses

Request samples

Payload

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"attributeAssignments": [{"attributeName": "string",
"attributeValue": "string",
"dataType": "ABINARY",
"operator": "ADD"
}
],
"attributeCount": 0,
"description": "string",
"externalAssignmentsCount": 0,
"externalServiceAssignments": [{"externalAssignmentIdentifier": ["string"
],
"serviceName": "string"
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}

Response samples

201
409

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"attributeAssignments": [{"attributeName": "string",
"attributeValue": "string",
"dataType": "ABINARY",
"operator": "ADD"
}
],
"attributeCount": 0,
"description": "string",
"externalAssignmentsCount": 0,
"externalServiceAssignments": [{"externalAssignmentIdentifier": ["string"
],
"serviceName": "string"
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}

Get RADIUS Attribute Groups

Gets the list of RADIUS attribute groups using the specified query.

query Parameters

excludeContent

boolean

Default: false

Request Body schema: application/json
required

	object The list of filters to apply.
page	integer <int32> >= 0 The page number to return, indexed starting with 0.
pageSize	integer <int32> [ 1 .. 2000 ] The number of items requested on the page.
sortField	string The field to use to sort on.
sortOrder	string Enum: "ASC" "DESC" The sort order of the applied query.

Responses

Request samples

Payload

Content type

application/json

{"filters": {"property1": { },
"property2": { }
},
"page": 0,
"pageSize": 1,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200
400

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"attributeAssignments": [{"attributeName": "string",
"attributeValue": "string",
"dataType": "ABINARY",
"operator": "ADD"
}
],
"attributeCount": 0,
"description": "string",
"externalAssignmentsCount": 0,
"externalServiceAssignments": [{"externalAssignmentIdentifier": ["string"
],
"serviceName": "string"
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}

Delete RADIUS Attribute Group

Deletes the requested RADIUS attribute group.

path Parameters

groupId

required

string <uuid>

Radius Attribute Group id

Responses

Response samples

200
204
404
409

Content type

application/json

{ }

Get RADIUS Attribute Group

Gets the requested RADIUS attribute group by the id.

path Parameters

groupId

required

string <uuid>

RADIUS attribute group id

Responses

Response samples

200
400
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"attributeAssignments": [{"attributeName": "string",
"attributeValue": "string",
"dataType": "ABINARY",
"operator": "ADD"
}
],
"attributeCount": 0,
"description": "string",
"externalAssignmentsCount": 0,
"externalServiceAssignments": [{"externalAssignmentIdentifier": ["string"
],
"serviceName": "string"
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}

Update RADIUS Attribute Group

Updates the properties on the requested RADIUS attribute group.

path Parameters

groupId

required

string <uuid>

RADIUS attribute group id

Request Body schema: application/json
required

property name*

additional property

object

Responses

Request samples

Payload

Content type

application/json

{"property1": { },
"property2": { }
}

Response samples

200
400
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"attributeAssignments": [{"attributeName": "string",
"attributeValue": "string",
"dataType": "ABINARY",
"operator": "ADD"
}
],
"attributeCount": 0,
"description": "string",
"externalAssignmentsCount": 0,
"externalServiceAssignments": [{"externalAssignmentIdentifier": ["string"
],
"serviceName": "string"
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}

RADIUS Attribute

View the list of supported RADIUS attributes.

Get RADIUS Attributes

Gets the list of RADIUS attributes in a paged format.

Responses

Get RADIUS Attributes

Gets the list of RADIUS attributes using the specified query. Paging is indexed starting at one.

query Parameters

excludeContent

boolean

Default: false

Request Body schema: application/json
required

	object The list of filters to apply.
page	integer <int32> >= 0 The page number to return, indexed starting with 0.
pageSize	integer <int32> [ 1 .. 2000 ] The number of items requested on the page.
sortField	string The field to use to sort on.
sortOrder	string Enum: "ASC" "DESC" The sort order of the applied query.

Responses

Request samples

Payload

Content type

application/json

{"filters": {"property1": { },
"property2": { }
},
"page": 0,
"pageSize": 1,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

200
400

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"dataType": "ABINARY",
"id": 0,
"name": "string",
"showOnDefault": true,
"vendorName": "string"
}

Get RADIUS Attribute Vendors

Gets the list of vendors that are supported in the RADIUS attributes.

Responses

Response samples

200

Content type

application/json

{"supportedVendors": ["string"
]
}

Get RADIUS Attribute

Gets the specific RADIUS attribute requested.

path Parameters

id

required

integer <int64>

Attribute unique identifier.

Responses

Response samples

200
400
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"dataType": "ABINARY",
"id": 0,
"name": "string",
"showOnDefault": true,
"vendorName": "string"
}

RADIUS Attribute Group Assignments

Manages the external service assignments to a specified Attribute Group

Get External Assignments

Gets the external assignments for the specified Radius attribute group.

path Parameters

groupId

required

string <uuid>

RADIUS Attribute Group id

Responses

Response samples

404

Content type

application/json

{"content": [{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"externalAssignmentIdentifier": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceName": "string"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}

Create External Assignment

Create an external service assignment to the requested RADIUS attribute group.

path Parameters

groupId

required

string <uuid>

RADIUS Attribute Group id

Request Body schema: application/json
required

	object (RADIUS_Attribute_Group_Management_REST_API_Links)
externalAssignmentIdentifier required	string The identifier for this external assignment and must be unique when combined with the service name.
id	string <uuid> The unique identifier for this external assignment of an attribute group.
serviceName required	string The name of the service that is using the attribute group.

Responses

Request samples

Payload

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"externalAssignmentIdentifier": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceName": "string"
}

Response samples

201
409

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"externalAssignmentIdentifier": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceName": "string"
}

Delete External Assignment

Delete the requested external assignment for this RADIUS attribute group.

path Parameters

groupId required	string <uuid> RADIUS Attribute Group id
assignmentId required	string <uuid> RADIUS Attribute Group Assignment id

Responses

Response samples

200
204

Content type

application/json

{ }

Get External Assignment

Gets the external assignment for the specified RADIUS attribute group.

path Parameters

groupId required	string <uuid> RADIUS Attribute Group id
assignmentId required	string <uuid> RADIUS Attribute Group Assignment id

Responses

Response samples

200
400
404

Content type

application/json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"externalAssignmentIdentifier": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceName": "string"
}

Resident Portal Configuration

Manages Resident Portal configuration.

Gets Property Details

Gets details of the property.

path Parameters

propertyId

required

string <uuid>

Property identifier.

Responses

Response samples

200
400
404
500

Content type

application/hal+json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"address": "string",
"allowSeparateGuestSecret": true,
"description": "string",
"enforceMaxUnits": true,
"guid": "string",
"managementEmail": "string",
"managementName": "string",
"managementPhone": "string",
"maxUnits": 0,
"name": "string",
"sendEmail": true,
"sendSms": true,
"ssids": ["string"
],
"tenantPortalAnnouncements": "string",
"tenantPortalHelpText": "string"
}

Gets Resident Portal File

Allows the user to download resident portal file with the given type.

path Parameters

propertyId required	string <uuid> Property identifier.
type required	string Resident Portal file type.

Responses

Response samples

400
404
500

Content type

application/json

{"detailedMessage": "string",
"message": "string",
"status": "100 CONTINUE",
"timestamp": "2019-08-24T14:15:22Z",
"validationErrors": ["string"
]
}

Gets User Interface Configurations

Gets user interface configurations for the portal.

path Parameters

propertyId

required

string <uuid>

Property identifier.

Responses

Response samples

200
400
404
500

Content type

application/hal+json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"accentColor": "string",
"announcements": "string",
"apiAllowed": true,
"helpText": "string",
"iconFileName": "string",
"loginText": "string",
"logoFileName": "string",
"mainColor": "string",
"portalAllowed": true,
"separatorColor": "string",
"tenantSetDpsk": true,
"tenantSubtitle": "string",
"tenantTitle": "string",
"textColor": "string"
}

Resident Portal Login API

Manages Resident Portal access

Access Resident Portal

Enables user authentication and authorization.

path Parameters

propertyId

required

string

Property identifier.

Request Body schema: application/json
required

HashedSecret

hashedSecret

string

Hash secret for login.

Responses

Request samples

Payload

Content type

application/json

{"hashedSecret": "string"
}

Response samples

200
400
401
500

Content type

application/hal+json

{"expireDateTime": "2019-08-24T14:15:22Z",
"serverVersion": "string",
"token": "string",
"unitGuid": "string"
}

Resident Portal Unit API

Manages units associated to the resident portal

Gets Unit Details

Gets unit details for the authenticated unit.

path Parameters

propertyId

required

string <uuid>

Property identifier.

Responses

Response samples

200
400
500

Content type

application/hal+json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"contact": {"contactName": "string",
"email": "string",
"phoneNumber": "string"
},
"description": "string",
"guestSecret": "string",
"guid": "string",
"number": "string",
"secret": "string",
"status": "DISABLED"
}

Selectively Updates Unit Configurations

Allows the user to selectively update unit configurations such as passphrase, contact details.

path Parameters

propertyId

required

string <uuid>

Property identifier.

Request Body schema: application/json
required

Unit to edit

	object (Resident_Portal_REST_API_UnitContactDto) Resident contact details.
description	string
guestSecret	string Unit guest passphrase.
guid	string Unit identifier.
number required	string Unit name.
secret	string Unit owner passphrase.
status	string Enum: "DISABLED" "ENABLED" Unit status.

Responses

Request samples

Payload

Content type

application/json

{"contact": {"contactName": "string",
"email": "string",
"phoneNumber": "string"
},
"description": "string",
"guestSecret": "string",
"guid": "string",
"number": "string",
"secret": "string",
"status": "DISABLED"
}

Response samples

200
202
400
404
500

Content type

application/hal+json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"contact": {"contactName": "string",
"email": "string",
"phoneNumber": "string"
},
"description": "string",
"guestSecret": "string",
"guid": "string",
"number": "string",
"secret": "string",
"status": "DISABLED"
}

Gets Unit Devices

Allows the user to get all unit and guest devices with the given unit id.

path Parameters

propertyId

required

string <uuid>

Property identifier.

query Parameters

type

required

string

Type of device.UNIT and GUEST are the possible values

Responses

Response samples

200
400
500

Content type

application/hal+json

{"_links": {"property1": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
},
"property2": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"name": "string",
"profile": "string",
"templated": true,
"title": "string",
"type": "string"
}
},
"contents": [{"authType": "DPSK",
"guid": "string",
"lastConnectedDate": "2019-08-24T14:15:22Z",
"macAddress": "string",
"type": "string"
}
]
}

Delete Device

Allows the user to selectively remove unit device on the specified unit and device MAC address.

path Parameters

propertyId required	string <uuid> Property identifier.
deviceId required	string Device Identification

Responses

Response samples

400
404
500

Content type

application/json

{"detailedMessage": "string",
"message": "string",
"status": "100 CONTINUE",
"timestamp": "2019-08-24T14:15:22Z",
"validationErrors": ["string"
]
}

Resident Portal UI Configuration

Provides resident portal UI configuration

Gets Portal Access Details

Fetches resident portal access details.

path Parameters

propertyId

required

string

Property identifier.

Responses

Response samples

200
400
404
500

Content type

application/json

{"loginText": "string",
"portalAllowed": true
}

Gets Resident Portal Icon File

Enables the user to get a resident portal icon file for the property.

path Parameters

propertyId

required

string

Property identifier.

Responses

Response samples

400
404
500

Content type

application/json

{"detailedMessage": "string",
"message": "string",
"status": "100 CONTINUE",
"timestamp": "2019-08-24T14:15:22Z",
"validationErrors": ["string"
]
}

Gets Resident Portal Styles

Gets resident portal page details.

path Parameters

propertyId

required

string

Property identifier.

Responses

Response samples

400
404
500

Content type

application/json

{"detailedMessage": "string",
"message": "string",
"status": "100 CONTINUE",
"timestamp": "2019-08-24T14:15:22Z",
"validationErrors": ["string"
]
}

LAG

Manage LAGs (link aggregation groups).

Delete LAGs

Delete switch's multiple LAG settings.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Delete LAG

Delete switch's LAG setting.

path Parameters

lagId

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get LAG

Get LAG setting by id.

path Parameters

lagId

required

string

Responses

Response samples

Content type

application/json

{"addPorts": ["string"
],
"defaultVlanId": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"lagId": 0,
"lagViewList": [{ }
],
"lastName": "string",
"name": "string",
"originalUntaggedVlan": "string",
"portAddVlans": [{"needRemoveUntaggedDefaultVlan": true,
"portId": "string",
"taggedVlans": ["string"
],
"untaggedVlan": "string"
}
],
"portVlans": [{"needRemoveUntaggedDefaultVlan": true,
"portId": "string",
"taggedVlans": ["string"
],
"untaggedVlan": "string"
}
],
"ports": ["string"
],
"realRemove": true,
"removePorts": ["string"
],
"switchId": "string",
"taggedVlans": ["string"
],
"tenantId": "string",
"type": "static",
"untaggedVlan": "string"
}

Update LAG

Update switch's LAG setting.

path Parameters

lagId

required

string

Request Body schema: application/json
required

addPorts	Array of strings
defaultVlanId	string
id	string
lagId	integer <int32>
lastName	string
name	string^(?:(?!").){1,64}$
originalUntaggedVlan	string
	Array of objects (Switch_Service_API_&_Model_Documentation_LagPortVlanBo)
	Array of objects (Switch_Service_API_&_Model_Documentation_LagPortVlanBo)
ports	Array of strings unique
removePorts	Array of strings
switchId	string
taggedVlans	Array of strings unique
type	string Enum: "static" "dynamic"
untaggedVlan	string

Responses

Request samples

Payload

Content type

application/json

{"addPorts": ["string"
],
"defaultVlanId": "string",
"id": "string",
"lagId": 0,
"lastName": "string",
"name": "string",
"originalUntaggedVlan": "string",
"portAddVlans": [{"needRemoveUntaggedDefaultVlan": true,
"portId": "string",
"taggedVlans": ["string"
],
"untaggedVlan": "string"
}
],
"portVlans": [{"needRemoveUntaggedDefaultVlan": true,
"portId": "string",
"taggedVlans": ["string"
],
"untaggedVlan": "string"
}
],
"ports": ["string"
],
"removePorts": ["string"
],
"switchId": "string",
"taggedVlans": ["string"
],
"type": "static",
"untaggedVlan": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get LAGs

List of switch's LAG settings.

path Parameters

switchId

required

string

Responses

Response samples

Content type

application/json

[{"addPorts": ["string"
],
"defaultVlanId": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"lagId": 0,
"lagViewList": [{ }
],
"lastName": "string",
"name": "string",
"originalUntaggedVlan": "string",
"portAddVlans": [{"needRemoveUntaggedDefaultVlan": true,
"portId": "string",
"taggedVlans": ["string"
],
"untaggedVlan": "string"
}
],
"portVlans": [{"needRemoveUntaggedDefaultVlan": true,
"portId": "string",
"taggedVlans": ["string"
],
"untaggedVlan": "string"
}
],
"ports": ["string"
],
"realRemove": true,
"removePorts": ["string"
],
"switchId": "string",
"taggedVlans": ["string"
],
"tenantId": "string",
"type": "static",
"untaggedVlan": "string"
}
]

Add LAGs

Add switch's multiple LAG settings.

path Parameters

switchId

required

string

Request Body schema: application/json
required

Array

addPorts	Array of strings
defaultVlanId	string
id	string
lagId	integer <int32>
lastName	string
name	string^(?:(?!").){1,64}$
originalUntaggedVlan	string
	Array of objects (Switch_Service_API_&_Model_Documentation_LagPortVlanBo)
	Array of objects (Switch_Service_API_&_Model_Documentation_LagPortVlanBo)
ports	Array of strings unique
removePorts	Array of strings
switchId	string
taggedVlans	Array of strings unique
type	string Enum: "static" "dynamic"
untaggedVlan	string

Responses

Request samples

Payload

Content type

application/json

[{"addPorts": ["string"
],
"defaultVlanId": "string",
"id": "string",
"lagId": 0,
"lastName": "string",
"name": "string",
"originalUntaggedVlan": "string",
"portAddVlans": [{"needRemoveUntaggedDefaultVlan": true,
"portId": "string",
"taggedVlans": ["string"
],
"untaggedVlan": "string"
}
],
"portVlans": [{"needRemoveUntaggedDefaultVlan": true,
"portId": "string",
"taggedVlans": ["string"
],
"untaggedVlan": "string"
}
],
"ports": ["string"
],
"removePorts": ["string"
],
"switchId": "string",
"taggedVlans": ["string"
],
"type": "static",
"untaggedVlan": "string"
}
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

AAA Server

Manage AAA (authentication, authorization, and accounting) Servers.

Delete AAA Servers

Delete multiple authentication, authorization, and accounting servers.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Query AAA Servers

List of venue's authentication, authorization, and accounting servers.

Request Body schema: application/json
required

fields	Array of strings
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings
serverType	string Enum: "__NULL" "RADIUS" "TACACS_PLUS" "LOCAL" "NONE_TYPE"
sortField	string
sortOrder	string Enum: "ASC" "DESC"
venueId	string

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"serverType": "__NULL",
"sortField": "string",
"sortOrder": "ASC",
"venueId": "string"
}

Response samples

Content type

application/json

{"data": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"fields": ["string"
],
"id": "string",
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Delete AAA Server

Delete authentication, authorization, and accounting server by id.

path Parameters

aaaServerId

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get AAA Server-Setting

Get a switch's authentication, authorization, and accounting server setting.

path Parameters

aaaServerId

required

string

Responses

Response samples

Content type

application/json

{"aaaServerViewList": [{ }
],
"acctPort": 0,
"authPort": 0,
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"ip": "string",
"level": "UNSPECIFIED",
"name": "string",
"password": "string",
"purpose": "UNSPECIFIED",
"secret": "string",
"serverType": "__NULL",
"username": "string"
}

Add AAA Server

Add authentication, authorization, and accounting server. Use activity API with request id to get the status update.

path Parameters

venueId

required

string

Request Body schema: application/json
required

acctPort	integer <int32> [ 0 .. 65535 ]
adminLocalUser	boolean
authPort	integer <int32> [ 0 .. 65535 ]
encryptedPassword	string
id	string
ip	string^([1-9]\|[1-9]\d\|1\d\d\|2[0-4]\d\|25[0-5])(\.([0...
level	string Enum: "UNSPECIFIED" "READ_WRITE" "PORT_CONFIG" "READ_ONLY" "LEVEL_NONE"
name	string [ 2 .. 64 ] characters
password	string [ 8 .. 64 ] characters
purpose	string Enum: "UNSPECIFIED" "DEFAULT" "AUTHENTICATION_ONLY" "AUTHORIZATION_ONLY" "ACCOUNTING_ONLY"
secret	string [ 1 .. 64 ] characters
serverType	string Enum: "__NULL" "RADIUS" "TACACS_PLUS" "LOCAL" "NONE_TYPE"
username	string [ 2 .. 48 ] characters

Responses

Request samples

Payload

Content type

application/json

{"acctPort": 65535,
"adminLocalUser": true,
"authPort": 65535,
"encryptedPassword": "string",
"id": "string",
"ip": "string",
"level": "UNSPECIFIED",
"name": "string",
"password": "stringst",
"purpose": "UNSPECIFIED",
"secret": "string",
"serverType": "__NULL",
"username": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Update AAA Server

Update authentication, authorization, and accounting server by id. Use activity API with request id to get the status update.

path Parameters

venueId required	string
aaaServerId required	string

Request Body schema: application/json
required

acctPort	integer <int32> [ 0 .. 65535 ]
adminLocalUser	boolean
authPort	integer <int32> [ 0 .. 65535 ]
encryptedPassword	string
id	string
ip	string^([1-9]\|[1-9]\d\|1\d\d\|2[0-4]\d\|25[0-5])(\.([0...
level	string Enum: "UNSPECIFIED" "READ_WRITE" "PORT_CONFIG" "READ_ONLY" "LEVEL_NONE"
name	string [ 2 .. 64 ] characters
password	string [ 8 .. 64 ] characters
purpose	string Enum: "UNSPECIFIED" "DEFAULT" "AUTHENTICATION_ONLY" "AUTHORIZATION_ONLY" "ACCOUNTING_ONLY"
secret	string [ 1 .. 64 ] characters
serverType	string Enum: "__NULL" "RADIUS" "TACACS_PLUS" "LOCAL" "NONE_TYPE"
username	string [ 2 .. 48 ] characters

Responses

Request samples

Payload

Content type

application/json

{"acctPort": 65535,
"adminLocalUser": true,
"authPort": 65535,
"encryptedPassword": "string",
"id": "string",
"ip": "string",
"level": "UNSPECIFIED",
"name": "string",
"password": "stringst",
"purpose": "UNSPECIFIED",
"secret": "string",
"serverType": "__NULL",
"username": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Profile ACL

Manage ACL (access control list) of switch profile.

Delete ACLs

Delete multiple ACLs of the switch profile.

path Parameters

switchProfileId

required

string

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get ACLs

Get multiple ACLs of the switch profile.

path Parameters

switchProfileId

required

string

query Parameters

page	integer <int32>
size	integer <int32>

Responses

Response samples

Content type

application/json

[{"aclRules": [{"action": "permit",
"destination": "string",
"destinationPort": 0,
"dscpMarking": 0,
"dscpMatching": 0,
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 0,
"source": "string",
"sourcePort": 0
}
],
"aclType": "standard",
"aclViewList": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string"
}
]

Add ACL

Add the ACL of the switch profile.

path Parameters

switchProfileId

required

string

Request Body schema: application/json
required

	Array of objects (Switch_Service_API_&_Model_Documentation_AclRuleBo) unique
aclType	string Enum: "standard" "extended"
id	string
name	string
switchId	string

Responses

Request samples

Payload

Content type

application/json

{"aclRules": [{"action": "permit",
"destination": "string",
"destinationPort": "string",
"dscpMarking": 0,
"dscpMatching": 0,
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 0,
"source": "string",
"sourcePort": "string",
"typeIp": true
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"switchId": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Delete ACL

Delete ACL of the switch profile.

path Parameters

switchProfileId required	string
aclId required	string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get ACL

Get the ACL of the switch profile.

path Parameters

switchProfileId required	string
aclId required	string

Responses

Response samples

Content type

application/json

{"aclRules": [{"action": "permit",
"destination": "string",
"destinationPort": 0,
"dscpMarking": 0,
"dscpMatching": 0,
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 0,
"source": "string",
"sourcePort": 0
}
],
"aclType": "standard",
"aclViewList": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string"
}

Update ACL

Update the ACL of the switch profile.

path Parameters

switchProfileId required	string
aclId required	string

Request Body schema: application/json
required

	Array of objects (Switch_Service_API_&_Model_Documentation_AclRuleBo) unique
aclType	string Enum: "standard" "extended"
id	string
name	string
switchId	string

Responses

Request samples

Payload

Content type

application/json

{"aclRules": [{"action": "permit",
"destination": "string",
"destinationPort": "string",
"dscpMarking": 0,
"dscpMatching": 0,
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 0,
"source": "string",
"sourcePort": "string",
"typeIp": true
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"switchId": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get ACLs

Get all ACLs of switch profiles in the venue.

path Parameters

venueId

required

string

Responses

Response samples

Content type

application/json

[{"aclRules": [{"action": "permit",
"destination": "string",
"destinationPort": 0,
"dscpMarking": 0,
"dscpMatching": 0,
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 0,
"source": "string",
"sourcePort": 0
}
],
"aclType": "standard",
"aclViewList": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string"
}
]

Configuration History

Retrieve configuration history.

Get Configuration History

Query for configuration history details on this switch.

path Parameters

switchId

required

string

Request Body schema: application/json
required

filterByConfigType	string
filterByStatus	string Enum: "ALL" "SUCCESS" "FAILED" "NOTIFY_SUCCESS"
	object (Switch_Service_API_&_Model_Documentation_ConfigurationHistoryFilter)
limit	integer <int32>
orderBy	string
page	integer <int32>
pageSize	integer <int32>
sortField	string Enum: "startTime" "configType" "dispatchStatus"
	object (Switch_Service_API_&_Model_Documentation_ConfigurationHistoryDetailSortInfo)
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"filterByConfigType": "string",
"filterByStatus": "ALL",
"filters": {"configType": ["string"
],
"filterByStatus": ["ALL"
]
},
"limit": 0,
"orderBy": "string",
"page": 0,
"pageSize": 0,
"sortField": "startTime",
"sortInfo": {"dir": "ASC",
"sortColumn": "startTime"
},
"sortOrder": "ASC"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Configuration History

Get the configuration history details of this transaction on this switch.

path Parameters

switchId required	string
transactionId required	string

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/switches/{switchId}/transactions/{transactionId}/configHistDetails

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/switches/{switchId}/transactions/{transactionId}/configHistDetails

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/switches/{switchId}/transactions/{transactionId}/configHistDetails

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Configuration History

Query for configuration history details for switches in this venue.

path Parameters

venueId

required

string

Request Body schema: application/json
required

filterByConfigType	string
	object (Switch_Service_API_&_Model_Documentation_ConfigurationHistoryFilter)
limit	integer <int32>
page	integer <int32>
pageSize	integer <int32>
sortField	string Value: "startTime"
	object (Switch_Service_API_&_Model_Documentation_SortInfo)
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"filterByConfigType": "string",
"filters": {"configType": ["string"
],
"filterByStatus": ["ALL"
]
},
"limit": 0,
"page": 0,
"pageSize": 0,
"sortField": "startTime",
"sortInfo": {"dir": "ASC",
"sortColumn": "startTime"
},
"sortOrder": "ASC"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Configuration History

Get the configuration history details for this transaction relative to the switches in this venue.

path Parameters

venueId required	string
transactionId required	string

Request Body schema: application/json
required

filterByConfigType	string
filterByStatus	string Enum: "ALL" "SUCCESS" "FAILED" "NOTIFY_SUCCESS"
	object (Switch_Service_API_&_Model_Documentation_ConfigurationHistoryFilter)
limit	integer <int32>
orderBy	string
page	integer <int32>
pageSize	integer <int32>
sortField	string Enum: "startTime" "configType" "dispatchStatus"
	object (Switch_Service_API_&_Model_Documentation_ConfigurationHistoryDetailSortInfo)
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"filterByConfigType": "string",
"filterByStatus": "ALL",
"filters": {"configType": ["string"
],
"filterByStatus": ["ALL"
]
},
"limit": 0,
"orderBy": "string",
"page": 0,
"pageSize": 0,
"sortField": "startTime",
"sortInfo": {"dir": "ASC",
"sortColumn": "startTime"
},
"sortOrder": "ASC"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

ICX Switch

Manage ICX Switches.

Delete Stack Member

Delete stack member.

path Parameters

stackSwitchSerialNumber

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Delete ICX Switches

Delete multiple ICX switches.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get ICX Switches

List of tenant's ICX switches.

Responses

Response samples

Content type

application/json

[{"defaultGateway": "string",
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"enableStack": true,
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"firmwareVersion": "string",
"id": "string",
"igmpSnooping": "active",
"initialVlanId": 0,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"isPrimaryDeleted": true,
"jumboMode": true,
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"name": "string",
"position": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"floorplanId": "string",
"id": "string",
"xpercent": 0.1,
"ypercent": 0.1
},
"previousMembers": ["string"
],
"rearModule": "string",
"sendedHostname": true,
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 0,
"specifiedType": "AUTO",
"stackConfigTimestamp": "string",
"stackMemberViews": [{"activeSwitch": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"memberSerials": ["string"
],
"model": "string",
"rearModule": "string"
}
],
"subnetMask": "string",
"syncDataEndTime": 0,
"syncDataId": "string",
"syncDataStartTime": 0,
"tags": "string",
"trustPorts": ["string"
],
"venueId": "string"
}
]

Add ICX Switches

Add multiple ICX switches. Use activity API with request id to get the status update.

Request Body schema: application/json
required

Array

defaultGateway	string
description	string
dhcpClientEnabled	boolean
dhcpServerEnabled	boolean
displayOfStack	string
enableStack	boolean
firmwareVersion	string
id	string
igmpSnooping	string
initialVlanId	integer <int32>
ipAddress	string
ipAddressInterface	string
ipAddressInterfaceType	string
ipAddressType	string Enum: "static" "dynamic"
is7650Switch	boolean
is8200Switch	boolean
jumboMode	boolean
lastDataSyncTime	string <date-time>
lastDataSyncTriggerTime	string <date-time>
model	string Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C" "ICX7550-24" "ICX7550-48" "ICX7550-24P" "ICX7550-48P" "ICX7550-24ZP" "ICX7550-48ZP" "ICX7550-24F" "ICX7550-48F" "ICX8200-24" "ICX8200-24P" "ICX8200-24F" "ICX8200-24FX" "ICX8200-24ZP" "ICX8200-48" "ICX8200-48F" "ICX8200-48P" "ICX8200-48PF" "ICX8200-48PF2" "ICX8200-48ZP2" "ICX8200-C08P" "ICX8200-C08PDC" "ICX8200-C08PF" "ICX8200-C08PT" "ICX8200-C08ZP"
name	string
position	string
previousMembers	Array of strings unique
primaryDeleted	boolean
rearModule	string
sendedHostname	boolean
softDeleted	boolean
softDeletedDate	string <date-time>
spanningTreePriority	integer <int32>
specifiedType	string Enum: "AUTO" "SWITCH" "ROUTER"
stackConfigTimestamp	string
	Array of objects (Switch_Service_API_&_Model_Documentation_StackMembers)
	Array of objects (Switch_Service_API_&_Model_Documentation_StackMembers)
subnetMask	string
syncDataEndTime	string <date-time>
syncDataId	string
syncDataStartTime	string <date-time>
tags	string
trustPorts	Array of strings
venueId	string

Responses

Request samples

Payload

Content type

application/json

[{"defaultGateway": "string",
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"displayOfStack": "string",
"enableStack": true,
"firmwareVersion": "string",
"id": "string",
"igmpSnooping": "string",
"initialVlanId": 0,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "string",
"ipAddressType": "static",
"is7650Switch": true,
"is8200Switch": true,
"jumboMode": true,
"lastDataSyncTime": "2019-08-24T14:15:22Z",
"lastDataSyncTriggerTime": "2019-08-24T14:15:22Z",
"model": "ICX7150-24",
"name": "string",
"position": "string",
"previousMembers": ["string"
],
"primaryDeleted": true,
"rearModule": "string",
"sendedHostname": true,
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 0,
"specifiedType": "AUTO",
"stackConfigTimestamp": "string",
"stackMembers": [{"activeSwitch": {"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [{"byMergeDeployLogDetail": { },
"cliDeploy": true,
"cliProvisionDeploy": true,
"clis": "string",
"collectConf": true,
"configType": "PROVISIONING",
"dataSyncFail": true,
"deployExtraStatus": "string",
"deployTime": "2019-08-24T14:15:22Z",
"deployTimeFromFakeResponse": {"configType": "PROVISIONING",
"fakeReason": "TIMEOUT",
"fakeTimestamp": "2019-08-24T14:15:22Z",
"operationId": "string",
"restconf_response": "string",
"switchId": "string",
"timestamp": "string",
"transactionId": "string"
},
"dispatchConfig": {"cliTemplateId": "string"
},
"dispatchConfigBo": {"activeStackConfig": true,
"addDeployConfigs": {"aaaServers": {"configList": [ ]
},
"aaaSettings": {"configList": [ ]
},
"accessSwitchConfigs": {"configList": [ ]
},
"acls": {"configList": [ ]
},
"acxCliTemplateVariables": {"configList": [ ]
},
"commonConfigs": {"configList": [ ]
},
"configType": "PROVISIONING",
"defaultVlans": {"configList": [ ]
},
"dhcpClients": {"configList": [ ]
},
"dhcpServers": {"configList": [ ]
},
"distributionSwitchConfigs": {"configList": [ ]
},
"ipConfigs": {"configList": [ ]
},
"lags": {"configList": [ ]
},
"modelFamily": "string",
"portConfigs": {"configList": [ ]
},
"profileId": "string",
"specificSettings": {"configList": [ ]
},
"stackConfigs": {"configList": [ ]
},
"staticRoutes": {"configList": [ ]
},
"switches": [null
],
"syslogServerConfigs": {"configList": [ ]
},
"vePortConfigs": {"configList": [ ]
},
"vlans": {"configList": [ ]
}
},
"changeLogList": ["string"
],
"cliNotificationType": "SWITCH_DELETE",
"configType": "PROVISIONING",
"copyConfig": "string",
"deployMode": "REST_CONF",
"disconnectCli": true,
"enableDefaultConfig": true,
"extraConfig": "string",
"firmwareVersion": "string",
"groupOptimization": true,
"hasDefaultVlanConfig": true,
"hasIpConfig": true,
"initialVlanId": 0,
"isRouter": true,
"memberStackConfig": true,
"needMarkAsOffline": true,
"needReload": true,
"overwriteStartupConfig": true,
"removeDeployConfigs": {"aaaServers": {"configList": [ ]
},
"aaaSettings": {"configList": [ ]
},
"accessSwitchConfigs": {"configList": [ ]
},
"acls": {"configList": [ ]
},
"acxCliTemplateVariables": {"configList": [ ]
},
"commonConfigs": {"configList": [ ]
},
"configType": "PROVISIONING",
"defaultVlans": {"configList": [ ]
},
"dhcpClients": {"configList": [ ]
},
"dhcpServers": {"configList": [ ]
},
"distributionSwitchConfigs": {"configList": [ ]
},
"ipConfigs": {"configList": [ ]
},
"lags": {"configList": [ ]
},
"modelFamily": "string",
"portConfigs": {"configList": [ ]
},
"profileId": "string",
"specificSettings": {"configList": [ ]
},
"stackConfigs": {"configList": [ ]
},
"staticRoutes": {"configList": [ ]
},
"switches": [null
],
"syslogServerConfigs": {"configList": [ ]
},
"vePortConfigs": {"configList": [ ]
},
"vlans": {"configList": [ ]
}
},
"serialNumber": "string",
"switchId": "string",
"transactionId": "string",
"triggerType": "PROVISIONING"
},
"dispatchError": [{"lineNumber": "string",
"message": "string",
"status": "string"
}
],
"dispatchStatus": "PENDING",
"expireTime": "2019-08-24T14:15:22Z",
"hostnameVariable": "string",
"id": "string",
"inprogress": true,
"isActiveRole": true,
"notFinalState": true,
"overwriteDeploy": true,
"provisionDeploy": true,
"responseTime": "2019-08-24T14:15:22Z",
"retryCount": 0,
"specificDeploy": true,
"stackDeploy": true,
"startTime": "2019-08-24T14:15:22Z",
"switchId": "string",
"switchName": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [ ],
"acxCliProfile": null,
"acxVenueCliTemplate": null,
"cliProfile": null,
"description": null,
"id": null,
"name": null,
"profileType": null,
"profileVenues": [ ],
"regularProfile": null,
"tenant": null,
"trustedPorts": [ ],
"venues": [ ],
"vlans": [ ]
}
],
"venues": [{"addressLine": null,
"cliApplied": null,
"dns": [ ],
"dnsList": [ ],
"firmware": null,
"id": null,
"lastScheduleUpdateTime": null,
"name": null,
"preDownloadFirmware": null,
"profileId": [ ],
"switchFirmwareVersion": null,
"switchFirmwareVersionAboveTen": null,
"switchLoginPassword": null,
"switchLoginUsername": null,
"switches": [ ],
"syslogEnabled": null,
"syslogPrimaryServer": null,
"syslogSecondaryServer": null,
"tenant": null,
"timeZone": null,
"upgradeSchedule": null
}
]
},
"transactionId": "string",
"triggerSyncDeploy": true,
"venueId": "string"
}
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [{"addr": "string",
"pref_len": 0
}
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{ }
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [ ],
"aclType": null,
"id": null,
"name": null,
"profile": null,
"profileId": null,
"tenant": null
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": [null
],
"switchModels": "string",
"tenant": { },
"variables": [null
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": null,
"profile": null,
"tenant": null,
"venue": null
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": null,
"model": null,
"profile": null,
"slots": [ ],
"tenant": null,
"trustPorts": [ ],
"trustedPortType": null,
"vlanDemand": null
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": null,
"arpInspectionTrustPort": null,
"defaultVlan": null,
"id": null,
"igmpSnooping": null,
"ipv4DhcpSnooping": null,
"ipv4DhcpSnoopingTrustPort": null,
"multicastVersion": null,
"profile": null,
"rootBridgeFamilyId": null,
"spanningTreePriority": null,
"spanningTreeProtocol": null,
"switchFamilyModels": [ ],
"tenant": null,
"vlanId": null,
"vlanName": null
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{ }
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": null,
"id": null,
"startDateTime": null,
"status": null,
"totalCapacityVenue": null
},
"version": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"versionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
}
}
}
]
},
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [ ],
"acxCliProfile": null,
"acxVenueCliTemplate": null,
"cliProfile": null,
"description": null,
"id": null,
"name": null,
"profileType": null,
"profileVenues": [ ],
"regularProfile": null,
"tenant": null,
"trustedPorts": [ ],
"venues": [ ],
"vlans": [ ]
}
],
"venues": [{ }
]
}
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [ ],
"acxCliProfile": null,
"acxVenueCliTemplate": null,
"cliProfile": null,
"description": null,
"id": null,
"name": null,
"profileType": null,
"profileVenues": [ ],
"regularProfile": null,
"tenant": null,
"trustedPorts": [ ],
"venues": [ ],
"vlans": [ ]
}
],
"venues": [{ }
]
}
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{ }
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{ }
]
},
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [ ],
"acxCliProfile": null,
"acxVenueCliTemplate": null,
"cliProfile": null,
"description": null,
"id": null,
"name": null,
"profileType": null,
"profileVenues": [ ],
"regularProfile": null,
"tenant": null,
"trustedPorts": [ ],
"venues": [ ],
"vlans": [ ]
}
],
"venues": [{ }
]
},
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
}
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
}
}
}
},
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
},
"id": "string",
"insufficientLicense": true,
"model": "string",
"priority": 255,
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [null
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": null,
"id": null,
"ipAddressEnd": null,
"ipAddressStart": null,
"name": null,
"needUpdate": null,
"subMaskAndEndIp": [ ],
"value": null,
"variableName": null,
"variableType": null
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": {"addressLine": null,
"cliApplied": null,
"dns": [ ],
"dnsList": [ ],
"firmware": null,
"id": null,
"lastScheduleUpdateTime": null,
"name": null,
"preDownloadFirmware": null,
"profileId": [ ],
"switchFirmwareVersion": null,
"switchFirmwareVersionAboveTen": null,
"switchLoginPassword": null,
"switchLoginUsername": null,
"switches": [ ],
"syslogEnabled": null,
"syslogPrimaryServer": null,
"syslogSecondaryServer": null,
"tenant": null,
"timeZone": null,
"upgradeSchedule": null
}
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [null
],
"tenant": { },
"trustPorts": [null
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [null
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"unitId": 1
}
],
"stackMembersAndFilterActiveId": [{"activeSwitch": {"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [{"byMergeDeployLogDetail": { },
"cliDeploy": true,
"cliProvisionDeploy": true,
"clis": "string",
"collectConf": true,
"configType": "PROVISIONING",
"dataSyncFail": true,
"deployExtraStatus": "string",
"deployTime": "2019-08-24T14:15:22Z",
"deployTimeFromFakeResponse": {"configType": "PROVISIONING",
"fakeReason": "TIMEOUT",
"fakeTimestamp": "2019-08-24T14:15:22Z",
"operationId": "string",
"restconf_response": "string",
"switchId": "string",
"timestamp": "string",
"transactionId": "string"
},
"dispatchConfig": {"cliTemplateId": "string"
},
"dispatchConfigBo": {"activeStackConfig": true,
"addDeployConfigs": {"aaaServers": {"configList": [ ]
},
"aaaSettings": {"configList": [ ]
},
"accessSwitchConfigs": {"configList": [ ]
},
"acls": {"configList": [ ]
},
"acxCliTemplateVariables": {"configList": [ ]
},
"commonConfigs": {"configList": [ ]
},
"configType": "PROVISIONING",
"defaultVlans": {"configList": [ ]
},
"dhcpClients": {"configList": [ ]
},
"dhcpServers": {"configList": [ ]
},
"distributionSwitchConfigs": {"configList": [ ]
},
"ipConfigs": {"configList": [ ]
},
"lags": {"configList": [ ]
},
"modelFamily": "string",
"portConfigs": {"configList": [ ]
},
"profileId": "string",
"specificSettings": {"configList": [ ]
},
"stackConfigs": {"configList": [ ]
},
"staticRoutes": {"configList": [ ]
},
"switches": [null
],
"syslogServerConfigs": {"configList": [ ]
},
"vePortConfigs": {"configList": [ ]
},
"vlans": {"configList": [ ]
}
},
"changeLogList": ["string"
],
"cliNotificationType": "SWITCH_DELETE",
"configType": "PROVISIONING",
"copyConfig": "string",
"deployMode": "REST_CONF",
"disconnectCli": true,
"enableDefaultConfig": true,
"extraConfig": "string",
"firmwareVersion": "string",
"groupOptimization": true,
"hasDefaultVlanConfig": true,
"hasIpConfig": true,
"initialVlanId": 0,
"isRouter": true,
"memberStackConfig": true,
"needMarkAsOffline": true,
"needReload": true,
"overwriteStartupConfig": true,
"removeDeployConfigs": {"aaaServers": {"configList": [ ]
},
"aaaSettings": {"configList": [ ]
},
"accessSwitchConfigs": {"configList": [ ]
},
"acls": {"configList": [ ]
},
"acxCliTemplateVariables": {"configList": [ ]
},
"commonConfigs": {"configList": [ ]
},
"configType": "PROVISIONING",
"defaultVlans": {"configList": [ ]
},
"dhcpClients": {"configList": [ ]
},
"dhcpServers": {"configList": [ ]
},
"distributionSwitchConfigs": {"configList": [ ]
},
"ipConfigs": {"configList": [ ]
},
"lags": {"configList": [ ]
},
"modelFamily": "string",
"portConfigs": {"configList": [ ]
},
"profileId": "string",
"specificSettings": {"configList": [ ]
},
"stackConfigs": {"configList": [ ]
},
"staticRoutes": {"configList": [ ]
},
"switches": [null
],
"syslogServerConfigs": {"configList": [ ]
},
"vePortConfigs": {"configList": [ ]
},
"vlans": {"configList": [ ]
}
},
"serialNumber": "string",
"switchId": "string",
"transactionId": "string",
"triggerType": "PROVISIONING"
},
"dispatchError": [{"lineNumber": "string",
"message": "string",
"status": "string"
}
],
"dispatchStatus": "PENDING",
"expireTime": "2019-08-24T14:15:22Z",
"hostnameVariable": "string",
"id": "string",
"inprogress": true,
"isActiveRole": true,
"notFinalState": true,
"overwriteDeploy": true,
"provisionDeploy": true,
"responseTime": "2019-08-24T14:15:22Z",
"retryCount": 0,
"specificDeploy": true,
"stackDeploy": true,
"startTime": "2019-08-24T14:15:22Z",
"switchId": "string",
"switchName": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [ ],
"acxCliProfile": null,
"acxVenueCliTemplate": null,
"cliProfile": null,
"description": null,
"id": null,
"name": null,
"profileType": null,
"profileVenues": [ ],
"regularProfile": null,
"tenant": null,
"trustedPorts": [ ],
"venues": [ ],
"vlans": [ ]
}
],
"venues": [{"addressLine": null,
"cliApplied": null,
"dns": [ ],
"dnsList": [ ],
"firmware": null,
"id": null,
"lastScheduleUpdateTime": null,
"name": null,
"preDownloadFirmware": null,
"profileId": [ ],
"switchFirmwareVersion": null,
"switchFirmwareVersionAboveTen": null,
"switchLoginPassword": null,
"switchLoginUsername": null,
"switches": [ ],
"syslogEnabled": null,
"syslogPrimaryServer": null,
"syslogSecondaryServer": null,
"tenant": null,
"timeZone": null,
"upgradeSchedule": null
}
]
},
"transactionId": "string",
"triggerSyncDeploy": true,
"venueId": "string"
}
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [{"addr": "string",
"pref_len": 0
}
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{ }
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [ ],
"aclType": null,
"id": null,
"name": null,
"profile": null,
"profileId": null,
"tenant": null
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": [null
],
"switchModels": "string",
"tenant": { },
"variables": [null
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": null,
"profile": null,
"tenant": null,
"venue": null
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": null,
"model": null,
"profile": null,
"slots": [ ],
"tenant": null,
"trustPorts": [ ],
"trustedPortType": null,
"vlanDemand": null
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": null,
"arpInspectionTrustPort": null,
"defaultVlan": null,
"id": null,
"igmpSnooping": null,
"ipv4DhcpSnooping": null,
"ipv4DhcpSnoopingTrustPort": null,
"multicastVersion": null,
"profile": null,
"rootBridgeFamilyId": null,
"spanningTreePriority": null,
"spanningTreeProtocol": null,
"switchFamilyModels": [ ],
"tenant": null,
"vlanId": null,
"vlanName": null
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{ }
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": null,
"id": null,
"startDateTime": null,
"status": null,
"totalCapacityVenue": null
},
"version": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"versionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
}
}
}
]
},
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [ ],
"acxCliProfile": null,
"acxVenueCliTemplate": null,
"cliProfile": null,
"description": null,
"id": null,
"name": null,
"profileType": null,
"profileVenues": [ ],
"regularProfile": null,
"tenant": null,
"trustedPorts": [ ],
"venues": [ ],
"vlans": [ ]
}
],
"venues": [{ }
]
}
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [ ],
"acxCliProfile": null,
"acxVenueCliTemplate": null,
"cliProfile": null,
"description": null,
"id": null,
"name": null,
"profileType": null,
"profileVenues": [ ],
"regularProfile": null,
"tenant": null,
"trustedPorts": [ ],
"venues": [ ],
"vlans": [ ]
}
],
"venues": [{ }
]
}
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{ }
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{ }
]
},
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [ ],
"acxCliProfile": null,
"acxVenueCliTemplate": null,
"cliProfile": null,
"description": null,
"id": null,
"name": null,
"profileType": null,
"profileVenues": [ ],
"regularProfile": null,
"tenant": null,
"trustedPorts": [ ],
"venues": [ ],
"vlans": [ ]
}
],
"venues": [{ }
]
},
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
}
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
}
}
}
},
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
},
"id": "string",
"insufficientLicense": true,
"model": "string",
"priority": 255,
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [null
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": null,
"id": null,
"ipAddressEnd": null,
"ipAddressStart": null,
"name": null,
"needUpdate": null,
"subMaskAndEndIp": [ ],
"value": null,
"variableName": null,
"variableType": null
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": {"addressLine": null,
"cliApplied": null,
"dns": [ ],
"dnsList": [ ],
"firmware": null,
"id": null,
"lastScheduleUpdateTime": null,
"name": null,
"preDownloadFirmware": null,
"profileId": [ ],
"switchFirmwareVersion": null,
"switchFirmwareVersionAboveTen": null,
"switchLoginPassword": null,
"switchLoginUsername": null,
"switches": [ ],
"syslogEnabled": null,
"syslogPrimaryServer": null,
"syslogSecondaryServer": null,
"tenant": null,
"timeZone": null,
"upgradeSchedule": null
}
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [null
],
"tenant": { },
"trustPorts": [null
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [null
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"unitId": 1
}
],
"subnetMask": "string",
"syncDataEndTime": "2019-08-24T14:15:22Z",
"syncDataId": "string",
"syncDataStartTime": "2019-08-24T14:15:22Z",
"tags": "string",
"trustPorts": ["string"
],
"venueId": "string"
}
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Create Multiple Device Requests

Execute sync venues admin password on multiple switch devices, switch id list should be provided on the request body.

Request Body schema: application/json
required

deviceRequestAction	string Enum: "sync" "reboot" "syncAdminPassword"
switchIdList	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"deviceRequestAction": "sync",
"switchIdList": ["string"
]
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Delete ICX Switch

Delete ICX switch by id.

path Parameters

switchId

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get ICX Switch

Get ICX switch by id.

path Parameters

switchId

required

string

Responses

Response samples

Content type

application/json

{"defaultGateway": "string",
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"enableStack": true,
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"firmwareVersion": "string",
"id": "string",
"igmpSnooping": "active",
"initialVlanId": 0,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"isPrimaryDeleted": true,
"jumboMode": true,
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"name": "string",
"position": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"floorplanId": "string",
"id": "string",
"xpercent": 0.1,
"ypercent": 0.1
},
"previousMembers": ["string"
],
"rearModule": "string",
"sendedHostname": true,
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 0,
"specifiedType": "AUTO",
"stackConfigTimestamp": "string",
"stackMemberViews": [{"activeSwitch": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"memberSerials": ["string"
],
"model": "string",
"rearModule": "string"
}
],
"subnetMask": "string",
"syncDataEndTime": 0,
"syncDataId": "string",
"syncDataStartTime": 0,
"tags": "string",
"trustPorts": ["string"
],
"venueId": "string"
}

Update ICX Switch

Update ICX switch. Use activity API with request id to get the status update.

path Parameters

switchId

required

string

Request Body schema: application/json
required

defaultGateway	string
description	string
dhcpClientEnabled	boolean
dhcpServerEnabled	boolean
displayOfStack	string
enableStack	boolean
firmwareVersion	string
id	string
igmpSnooping	string
initialVlanId	integer <int32>
ipAddress	string
ipAddressInterface	string
ipAddressInterfaceType	string
ipAddressType	string Enum: "static" "dynamic"
is7650Switch	boolean
is8200Switch	boolean
jumboMode	boolean
lastDataSyncTime	string <date-time>
lastDataSyncTriggerTime	string <date-time>
model	string Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C" "ICX7550-24" "ICX7550-48" "ICX7550-24P" "ICX7550-48P" "ICX7550-24ZP" "ICX7550-48ZP" "ICX7550-24F" "ICX7550-48F" "ICX8200-24" "ICX8200-24P" "ICX8200-24F" "ICX8200-24FX" "ICX8200-24ZP" "ICX8200-48" "ICX8200-48F" "ICX8200-48P" "ICX8200-48PF" "ICX8200-48PF2" "ICX8200-48ZP2" "ICX8200-C08P" "ICX8200-C08PDC" "ICX8200-C08PF" "ICX8200-C08PT" "ICX8200-C08ZP"
name	string
position	string
previousMembers	Array of strings unique
primaryDeleted	boolean
rearModule	string
sendedHostname	boolean
softDeleted	boolean
softDeletedDate	string <date-time>
spanningTreePriority	integer <int32>
specifiedType	string Enum: "AUTO" "SWITCH" "ROUTER"
stackConfigTimestamp	string
	Array of objects (Switch_Service_API_&_Model_Documentation_StackMembers)
	Array of objects (Switch_Service_API_&_Model_Documentation_StackMembers)
subnetMask	string
syncDataEndTime	string <date-time>
syncDataId	string
syncDataStartTime	string <date-time>
tags	string
trustPorts	Array of strings
venueId	string

Responses

Request samples

Payload

Content type

application/json

{"defaultGateway": "string",
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"displayOfStack": "string",
"enableStack": true,
"firmwareVersion": "string",
"id": "string",
"igmpSnooping": "string",
"initialVlanId": 0,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "string",
"ipAddressType": "static",
"is7650Switch": true,
"is8200Switch": true,
"jumboMode": true,
"lastDataSyncTime": "2019-08-24T14:15:22Z",
"lastDataSyncTriggerTime": "2019-08-24T14:15:22Z",
"model": "ICX7150-24",
"name": "string",
"position": "string",
"previousMembers": ["string"
],
"primaryDeleted": true,
"rearModule": "string",
"sendedHostname": true,
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 0,
"specifiedType": "AUTO",
"stackConfigTimestamp": "string",
"stackMembers": [{"activeSwitch": {"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [{"byMergeDeployLogDetail": { },
"cliDeploy": true,
"cliProvisionDeploy": true,
"clis": "string",
"collectConf": true,
"configType": "PROVISIONING",
"dataSyncFail": true,
"deployExtraStatus": "string",
"deployTime": "2019-08-24T14:15:22Z",
"deployTimeFromFakeResponse": {"configType": "PROVISIONING",
"fakeReason": "TIMEOUT",
"fakeTimestamp": "2019-08-24T14:15:22Z",
"operationId": "string",
"restconf_response": "string",
"switchId": "string",
"timestamp": "string",
"transactionId": "string"
},
"dispatchConfig": {"cliTemplateId": "string"
},
"dispatchConfigBo": {"activeStackConfig": true,
"addDeployConfigs": {"aaaServers": {"configList": [null
]
},
"aaaSettings": {"configList": [null
]
},
"accessSwitchConfigs": {"configList": [null
]
},
"acls": {"configList": [null
]
},
"acxCliTemplateVariables": {"configList": [null
]
},
"commonConfigs": {"configList": [null
]
},
"configType": "PROVISIONING",
"defaultVlans": {"configList": [null
]
},
"dhcpClients": {"configList": [null
]
},
"dhcpServers": {"configList": [null
]
},
"distributionSwitchConfigs": {"configList": [null
]
},
"ipConfigs": {"configList": [null
]
},
"lags": {"configList": [null
]
},
"modelFamily": "string",
"portConfigs": {"configList": [null
]
},
"profileId": "string",
"specificSettings": {"configList": [null
]
},
"stackConfigs": {"configList": [null
]
},
"staticRoutes": {"configList": [null
]
},
"switches": ["string"
],
"syslogServerConfigs": {"configList": [null
]
},
"vePortConfigs": {"configList": [null
]
},
"vlans": {"configList": [null
]
}
},
"changeLogList": ["string"
],
"cliNotificationType": "SWITCH_DELETE",
"configType": "PROVISIONING",
"copyConfig": "string",
"deployMode": "REST_CONF",
"disconnectCli": true,
"enableDefaultConfig": true,
"extraConfig": "string",
"firmwareVersion": "string",
"groupOptimization": true,
"hasDefaultVlanConfig": true,
"hasIpConfig": true,
"initialVlanId": 0,
"isRouter": true,
"memberStackConfig": true,
"needMarkAsOffline": true,
"needReload": true,
"overwriteStartupConfig": true,
"removeDeployConfigs": {"aaaServers": {"configList": [null
]
},
"aaaSettings": {"configList": [null
]
},
"accessSwitchConfigs": {"configList": [null
]
},
"acls": {"configList": [null
]
},
"acxCliTemplateVariables": {"configList": [null
]
},
"commonConfigs": {"configList": [null
]
},
"configType": "PROVISIONING",
"defaultVlans": {"configList": [null
]
},
"dhcpClients": {"configList": [null
]
},
"dhcpServers": {"configList": [null
]
},
"distributionSwitchConfigs": {"configList": [null
]
},
"ipConfigs": {"configList": [null
]
},
"lags": {"configList": [null
]
},
"modelFamily": "string",
"portConfigs": {"configList": [null
]
},
"profileId": "string",
"specificSettings": {"configList": [null
]
},
"stackConfigs": {"configList": [null
]
},
"staticRoutes": {"configList": [null
]
},
"switches": ["string"
],
"syslogServerConfigs": {"configList": [null
]
},
"vePortConfigs": {"configList": [null
]
},
"vlans": {"configList": [null
]
}
},
"serialNumber": "string",
"switchId": "string",
"transactionId": "string",
"triggerType": "PROVISIONING"
},
"dispatchError": [{"lineNumber": "string",
"message": "string",
"status": "string"
}
],
"dispatchStatus": "PENDING",
"expireTime": "2019-08-24T14:15:22Z",
"hostnameVariable": "string",
"id": "string",
"inprogress": true,
"isActiveRole": true,
"notFinalState": true,
"overwriteDeploy": true,
"provisionDeploy": true,
"responseTime": "2019-08-24T14:15:22Z",
"retryCount": 0,
"specificDeploy": true,
"stackDeploy": true,
"startTime": "2019-08-24T14:15:22Z",
"switchId": "string",
"switchName": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
]
},
"transactionId": "string",
"triggerSyncDeploy": true,
"venueId": "string"
}
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [{"addr": "string",
"pref_len": 0
}
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{ }
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [null
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": null,
"id": null,
"ipAddressEnd": null,
"ipAddressStart": null,
"name": null,
"needUpdate": null,
"subMaskAndEndIp": [ ],
"value": null,
"variableName": null,
"variableType": null
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": {"addressLine": null,
"cliApplied": null,
"dns": [ ],
"dnsList": [ ],
"firmware": null,
"id": null,
"lastScheduleUpdateTime": null,
"name": null,
"preDownloadFirmware": null,
"profileId": [ ],
"switchFirmwareVersion": null,
"switchFirmwareVersionAboveTen": null,
"switchLoginPassword": null,
"switchLoginUsername": null,
"switches": [ ],
"syslogEnabled": null,
"syslogPrimaryServer": null,
"syslogSecondaryServer": null,
"tenant": null,
"timeZone": null,
"upgradeSchedule": null
}
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [null
],
"tenant": { },
"trustPorts": [null
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [null
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{ }
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{ }
]
}
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{ }
]
}
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{ }
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [ ],
"aclType": null,
"id": null,
"name": null,
"profile": null,
"profileId": null,
"tenant": null
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": [null
],
"switchModels": "string",
"tenant": { },
"variables": [null
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": null,
"profile": null,
"tenant": null,
"venue": null
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": null,
"model": null,
"profile": null,
"slots": [ ],
"tenant": null,
"trustPorts": [ ],
"trustedPortType": null,
"vlanDemand": null
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": null,
"arpInspectionTrustPort": null,
"defaultVlan": null,
"id": null,
"igmpSnooping": null,
"ipv4DhcpSnooping": null,
"ipv4DhcpSnoopingTrustPort": null,
"multicastVersion": null,
"profile": null,
"rootBridgeFamilyId": null,
"spanningTreePriority": null,
"spanningTreeProtocol": null,
"switchFamilyModels": [ ],
"tenant": null,
"vlanId": null,
"vlanName": null
}
]
}
],
"venues": [{ }
]
},
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{ }
]
},
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [ ],
"acxCliProfile": null,
"acxVenueCliTemplate": null,
"cliProfile": null,
"description": null,
"id": null,
"name": null,
"profileType": null,
"profileVenues": [ ],
"regularProfile": null,
"tenant": null,
"trustedPorts": [ ],
"venues": [ ],
"vlans": [ ]
}
],
"venues": [{ }
]
}
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [ ],
"acxCliProfile": null,
"acxVenueCliTemplate": null,
"cliProfile": null,
"description": null,
"id": null,
"name": null,
"profileType": null,
"profileVenues": [ ],
"regularProfile": null,
"tenant": null,
"trustedPorts": [ ],
"venues": [ ],
"vlans": [ ]
}
],
"venues": [{ }
]
}
}
}
},
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
},
"id": "string",
"insufficientLicense": true,
"model": "string",
"priority": 255,
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [{"acl": null,
"action": null,
"destination": null,
"destinationPort": null,
"dscpMarking": null,
"dscpMatching": null,
"id": null,
"internalPriority": null,
"protocol": null,
"sequence": null,
"source": null,
"sourcePort": null,
"tenant": null
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": true,
"id": "string",
"ipAddressEnd": 0,
"ipAddressStart": 0,
"name": "string",
"needUpdate": true,
"subMaskAndEndIp": [null
],
"value": "string",
"variableName": "string",
"variableType": "ADDRESS"
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [{"enable": null,
"option": null,
"slotNumber": null
}
],
"tenant": { },
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": null,
"model": null,
"slots": [ ],
"taggedPorts": null,
"tenant": null,
"untaggedPorts": null,
"vlan": null
}
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [{"byMergeDeployLogDetail": null,
"cliDeploy": null,
"cliProvisionDeploy": null,
"clis": null,
"collectConf": null,
"configType": null,
"dataSyncFail": null,
"deployExtraStatus": null,
"deployTime": null,
"deployTimeFromFakeResponse": null,
"dispatchConfig": null,
"dispatchConfigBo": null,
"dispatchError": [ ],
"dispatchStatus": null,
"expireTime": null,
"hostnameVariable": null,
"id": null,
"inprogress": null,
"isActiveRole": null,
"notFinalState": null,
"overwriteDeploy": null,
"provisionDeploy": null,
"responseTime": null,
"retryCount": null,
"specificDeploy": null,
"stackDeploy": null,
"startTime": null,
"switchId": null,
"switchName": null,
"tenant": null,
"transactionId": null,
"triggerSyncDeploy": null,
"venueId": null
}
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [null
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{ }
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"unitId": 1
}
],
"stackMembersAndFilterActiveId": [{"activeSwitch": {"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [{"byMergeDeployLogDetail": { },
"cliDeploy": true,
"cliProvisionDeploy": true,
"clis": "string",
"collectConf": true,
"configType": "PROVISIONING",
"dataSyncFail": true,
"deployExtraStatus": "string",
"deployTime": "2019-08-24T14:15:22Z",
"deployTimeFromFakeResponse": {"configType": "PROVISIONING",
"fakeReason": "TIMEOUT",
"fakeTimestamp": "2019-08-24T14:15:22Z",
"operationId": "string",
"restconf_response": "string",
"switchId": "string",
"timestamp": "string",
"transactionId": "string"
},
"dispatchConfig": {"cliTemplateId": "string"
},
"dispatchConfigBo": {"activeStackConfig": true,
"addDeployConfigs": {"aaaServers": {"configList": [null
]
},
"aaaSettings": {"configList": [null
]
},
"accessSwitchConfigs": {"configList": [null
]
},
"acls": {"configList": [null
]
},
"acxCliTemplateVariables": {"configList": [null
]
},
"commonConfigs": {"configList": [null
]
},
"configType": "PROVISIONING",
"defaultVlans": {"configList": [null
]
},
"dhcpClients": {"configList": [null
]
},
"dhcpServers": {"configList": [null
]
},
"distributionSwitchConfigs": {"configList": [null
]
},
"ipConfigs": {"configList": [null
]
},
"lags": {"configList": [null
]
},
"modelFamily": "string",
"portConfigs": {"configList": [null
]
},
"profileId": "string",
"specificSettings": {"configList": [null
]
},
"stackConfigs": {"configList": [null
]
},
"staticRoutes": {"configList": [null
]
},
"switches": ["string"
],
"syslogServerConfigs": {"configList": [null
]
},
"vePortConfigs": {"configList": [null
]
},
"vlans": {"configList": [null
]
}
},
"changeLogList": ["string"
],
"cliNotificationType": "SWITCH_DELETE",
"configType": "PROVISIONING",
"copyConfig": "string",
"deployMode": "REST_CONF",
"disconnectCli": true,
"enableDefaultConfig": true,
"extraConfig": "string",
"firmwareVersion": "string",
"groupOptimization": true,
"hasDefaultVlanConfig": true,
"hasIpConfig": true,
"initialVlanId": 0,
"isRouter": true,
"memberStackConfig": true,
"needMarkAsOffline": true,
"needReload": true,
"overwriteStartupConfig": true,
"removeDeployConfigs": {"aaaServers": {"configList": [null
]
},
"aaaSettings": {"configList": [null
]
},
"accessSwitchConfigs": {"configList": [null
]
},
"acls": {"configList": [null
]
},
"acxCliTemplateVariables": {"configList": [null
]
},
"commonConfigs": {"configList": [null
]
},
"configType": "PROVISIONING",
"defaultVlans": {"configList": [null
]
},
"dhcpClients": {"configList": [null
]
},
"dhcpServers": {"configList": [null
]
},
"distributionSwitchConfigs": {"configList": [null
]
},
"ipConfigs": {"configList": [null
]
},
"lags": {"configList": [null
]
},
"modelFamily": "string",
"portConfigs": {"configList": [null
]
},
"profileId": "string",
"specificSettings": {"configList": [null
]
},
"stackConfigs": {"configList": [null
]
},
"staticRoutes": {"configList": [null
]
},
"switches": ["string"
],
"syslogServerConfigs": {"configList": [null
]
},
"vePortConfigs": {"configList": [null
]
},
"vlans": {"configList": [null
]
}
},
"serialNumber": "string",
"switchId": "string",
"transactionId": "string",
"triggerType": "PROVISIONING"
},
"dispatchError": [{"lineNumber": "string",
"message": "string",
"status": "string"
}
],
"dispatchStatus": "PENDING",
"expireTime": "2019-08-24T14:15:22Z",
"hostnameVariable": "string",
"id": "string",
"inprogress": true,
"isActiveRole": true,
"notFinalState": true,
"overwriteDeploy": true,
"provisionDeploy": true,
"responseTime": "2019-08-24T14:15:22Z",
"retryCount": 0,
"specificDeploy": true,
"stackDeploy": true,
"startTime": "2019-08-24T14:15:22Z",
"switchId": "string",
"switchName": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
]
},
"transactionId": "string",
"triggerSyncDeploy": true,
"venueId": "string"
}
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [{"addr": "string",
"pref_len": 0
}
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{ }
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [null
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": null,
"id": null,
"ipAddressEnd": null,
"ipAddressStart": null,
"name": null,
"needUpdate": null,
"subMaskAndEndIp": [ ],
"value": null,
"variableName": null,
"variableType": null
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": {"addressLine": null,
"cliApplied": null,
"dns": [ ],
"dnsList": [ ],
"firmware": null,
"id": null,
"lastScheduleUpdateTime": null,
"name": null,
"preDownloadFirmware": null,
"profileId": [ ],
"switchFirmwareVersion": null,
"switchFirmwareVersionAboveTen": null,
"switchLoginPassword": null,
"switchLoginUsername": null,
"switches": [ ],
"syslogEnabled": null,
"syslogPrimaryServer": null,
"syslogSecondaryServer": null,
"tenant": null,
"timeZone": null,
"upgradeSchedule": null
}
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [null
],
"tenant": { },
"trustPorts": [null
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [null
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{ }
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{ }
]
}
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{ }
]
}
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{ }
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [ ],
"aclType": null,
"id": null,
"name": null,
"profile": null,
"profileId": null,
"tenant": null
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": [null
],
"switchModels": "string",
"tenant": { },
"variables": [null
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": null,
"profile": null,
"tenant": null,
"venue": null
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": null,
"model": null,
"profile": null,
"slots": [ ],
"tenant": null,
"trustPorts": [ ],
"trustedPortType": null,
"vlanDemand": null
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": null,
"arpInspectionTrustPort": null,
"defaultVlan": null,
"id": null,
"igmpSnooping": null,
"ipv4DhcpSnooping": null,
"ipv4DhcpSnoopingTrustPort": null,
"multicastVersion": null,
"profile": null,
"rootBridgeFamilyId": null,
"spanningTreePriority": null,
"spanningTreeProtocol": null,
"switchFamilyModels": [ ],
"tenant": null,
"vlanId": null,
"vlanName": null
}
]
}
],
"venues": [{ }
]
},
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{ }
]
},
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [ ],
"acxCliProfile": null,
"acxVenueCliTemplate": null,
"cliProfile": null,
"description": null,
"id": null,
"name": null,
"profileType": null,
"profileVenues": [ ],
"regularProfile": null,
"tenant": null,
"trustedPorts": [ ],
"venues": [ ],
"vlans": [ ]
}
],
"venues": [{ }
]
}
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [ ],
"acxCliProfile": null,
"acxVenueCliTemplate": null,
"cliProfile": null,
"description": null,
"id": null,
"name": null,
"profileType": null,
"profileVenues": [ ],
"regularProfile": null,
"tenant": null,
"trustedPorts": [ ],
"venues": [ ],
"vlans": [ ]
}
],
"venues": [{ }
]
}
}
}
},
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
},
"id": "string",
"insufficientLicense": true,
"model": "string",
"priority": 255,
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [{"acl": null,
"action": null,
"destination": null,
"destinationPort": null,
"dscpMarking": null,
"dscpMatching": null,
"id": null,
"internalPriority": null,
"protocol": null,
"sequence": null,
"source": null,
"sourcePort": null,
"tenant": null
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": true,
"id": "string",
"ipAddressEnd": 0,
"ipAddressStart": 0,
"name": "string",
"needUpdate": true,
"subMaskAndEndIp": [null
],
"value": "string",
"variableName": "string",
"variableType": "ADDRESS"
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [{"enable": null,
"option": null,
"slotNumber": null
}
],
"tenant": { },
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": null,
"model": null,
"slots": [ ],
"taggedPorts": null,
"tenant": null,
"untaggedPorts": null,
"vlan": null
}
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [{"byMergeDeployLogDetail": null,
"cliDeploy": null,
"cliProvisionDeploy": null,
"clis": null,
"collectConf": null,
"configType": null,
"dataSyncFail": null,
"deployExtraStatus": null,
"deployTime": null,
"deployTimeFromFakeResponse": null,
"dispatchConfig": null,
"dispatchConfigBo": null,
"dispatchError": [ ],
"dispatchStatus": null,
"expireTime": null,
"hostnameVariable": null,
"id": null,
"inprogress": null,
"isActiveRole": null,
"notFinalState": null,
"overwriteDeploy": null,
"provisionDeploy": null,
"responseTime": null,
"retryCount": null,
"specificDeploy": null,
"stackDeploy": null,
"startTime": null,
"switchId": null,
"switchName": null,
"tenant": null,
"transactionId": null,
"triggerSyncDeploy": null,
"venueId": null
}
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [null
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{ }
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"unitId": 1
}
],
"subnetMask": "string",
"syncDataEndTime": "2019-08-24T14:15:22Z",
"syncDataId": "string",
"syncDataStartTime": "2019-08-24T14:15:22Z",
"tags": "string",
"trustPorts": ["string"
],
"venueId": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Troubleshoot/Debug

Perform troubleshoot/debugging commands.

path Parameters

switchId

required

string

Request Body schema: application/json
required

troubleshootingPayload	object
troubleshootingType	string Enum: "ping" "trace-route" "route-table" "mac-address-table" "dhcp-server-lease-table"

Responses

Request samples

Payload

Content type

application/json

{"troubleshootingPayload": { },
"troubleshootingType": "ping"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Troubleshoot/Debug

Retrieve troubleshoot/debugging command result.

path Parameters

switchId required	string
troubleshootingType required	string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Create Device Request

Execute sync or reboot command on particular switch device, no need to provide switch id list on the request body.

path Parameters

switchId

required

string

Request Body schema: application/json
required

deviceRequestAction	string Enum: "sync" "reboot" "syncAdminPassword"
switchIdList	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"deviceRequestAction": "sync",
"switchIdList": ["string"
]
}

Response samples

Content type

application/json

{"errors": [{"code": "string",
"message": "string"
}
],
"requestId": "string"
}

Retrieve ICX Switches

Retrieve list of venues' ICX switches.

path Parameters

venueId

required

string

Responses

Response samples

Content type

application/json

[{"defaultGateway": "string",
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"enableStack": true,
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"firmwareVersion": "string",
"id": "string",
"igmpSnooping": "active",
"initialVlanId": 0,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"isPrimaryDeleted": true,
"jumboMode": true,
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"name": "string",
"position": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"floorplanId": "string",
"id": "string",
"xpercent": 0.1,
"ypercent": 0.1
},
"previousMembers": ["string"
],
"rearModule": "string",
"sendedHostname": true,
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 0,
"specifiedType": "AUTO",
"stackConfigTimestamp": "string",
"stackMemberViews": [{"activeSwitch": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"memberSerials": ["string"
],
"model": "string",
"rearModule": "string"
}
],
"subnetMask": "string",
"syncDataEndTime": 0,
"syncDataId": "string",
"syncDataStartTime": 0,
"tags": "string",
"trustPorts": ["string"
],
"venueId": "string"
}
]

Profile VLAN

Manage VLANs (virtual local area networks) of switch profile.

Delete Multiple VLANs

Delete multiple VLANs of the switch profile.

path Parameters

switchProfileId

required

string

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Multiple VLANs

Get multiple VLANs of the switch profile.

path Parameters

switchProfileId

required

string

query Parameters

page	integer <int32>
size	integer <int32>

Responses

Response samples

Content type

application/json

[{"arpInspection": true,
"arpInspectionTrustPort": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 0,
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 0,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"taggedPorts": "string",
"untaggedPorts": "string"
}
],
"vlanId": 0,
"vlanName": "string"
}
]

Add VLAN

Create a VLAN of the switch profile.

path Parameters

switchProfileId

required

string

Request Body schema: application/json
required

arpInspection	boolean
arpInspectionTrustPort	string
arpInspectionTrustPortList	Array of strings
arpTrustPortsList	Array of strings
defaultVlan	boolean
dhcpTrustPortsList	Array of strings
dummyVlan	boolean
enableAsDefaultVlan required	boolean
id	string
igmpSnooping	string Enum: "active" "passive" "none"
igmpSnoopingTypeChanged	boolean
ipv4DhcpSnooping	boolean
ipv4DhcpSnoopingTrustPort	string
ipv4DhcpSnoopingTrustPortList	Array of strings
managementVlan	boolean
multicastVersion	integer <int32> [ 0 .. 3 ]
notDummyVlan	boolean
rapidSpanningTreeProtocol	boolean
rootBridgeFamilyId	string Enum: "__NULL" "ICX7150" "ICX7250" "ICX7650" "ICX7850" "ICX7550" "ICX8200"
spanningTreePriority	integer <int32> [ 0 .. 65535 ]
spanningTreeProtocol	string Enum: "rstp" "stp" "none"
	Array of objects (Switch_Service_API_&_Model_Documentation_SwitchFamilyModelBo) unique
switchId	string
	object (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo)
	Array of objects (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo) unique
taggedPortsList	Array of strings
untaggedPortsList	Array of strings
vlanId	integer <int32> [ 1 .. 4095 ]
vlanName	string

Responses

Request samples

Payload

Content type

application/json

{"arpInspection": true,
"arpInspectionTrustPort": "string",
"arpInspectionTrustPortList": ["string"
],
"arpTrustPortsList": ["string"
],
"defaultVlan": true,
"dhcpTrustPortsList": ["string"
],
"dummyVlan": true,
"enableAsDefaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"igmpSnoopingTypeChanged": true,
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"ipv4DhcpSnoopingTrustPortList": ["string"
],
"managementVlan": true,
"multicastVersion": 3,
"notDummyVlan": true,
"rapidSpanningTreeProtocol": true,
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"id": "string",
"option": "string",
"slotNumber": 0
}
],
"switchId": "string",
"taggedPorts": "string",
"untaggedPorts": "string"
}
],
"switchId": "string",
"switchVlanPortModel": {"id": "string",
"switchModel": "ICX7150-24",
"taggedPorts": "string",
"taggedPortsList": ["string"
],
"untaggedPorts": "string",
"untaggedPortsList": ["string"
]
},
"switchVlanPortModels": [{"id": "string",
"switchModel": "ICX7150-24",
"taggedPorts": "string",
"taggedPortsList": ["string"
],
"untaggedPorts": "string",
"untaggedPortsList": ["string"
]
}
],
"taggedPortsList": ["string"
],
"untaggedPortsList": ["string"
],
"vlanId": 1,
"vlanName": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Delete Profile VLAN

Delete a particular VLAN of the switch profile.

path Parameters

switchProfileId required	string
vlanId required	string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Profile VLAN

Get a particular VLAN of the switch profile.

path Parameters

switchProfileId required	string
vlanId required	string

Responses

Response samples

Content type

application/json

{"arpInspection": true,
"arpInspectionTrustPort": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 0,
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 0,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"taggedPorts": "string",
"untaggedPorts": "string"
}
],
"vlanId": 0,
"vlanName": "string"
}

Update VLAN

Update the VLAN of the switch profile.

path Parameters

switchProfileId required	string
vlanId required	integer <int32>

Request Body schema: application/json
required

arpInspection	boolean
arpInspectionTrustPort	string
arpInspectionTrustPortList	Array of strings
arpTrustPortsList	Array of strings
defaultVlan	boolean
dhcpTrustPortsList	Array of strings
dummyVlan	boolean
enableAsDefaultVlan required	boolean
id	string
igmpSnooping	string Enum: "active" "passive" "none"
igmpSnoopingTypeChanged	boolean
ipv4DhcpSnooping	boolean
ipv4DhcpSnoopingTrustPort	string
ipv4DhcpSnoopingTrustPortList	Array of strings
managementVlan	boolean
multicastVersion	integer <int32> [ 0 .. 3 ]
notDummyVlan	boolean
rapidSpanningTreeProtocol	boolean
rootBridgeFamilyId	string Enum: "__NULL" "ICX7150" "ICX7250" "ICX7650" "ICX7850" "ICX7550" "ICX8200"
spanningTreePriority	integer <int32> [ 0 .. 65535 ]
spanningTreeProtocol	string Enum: "rstp" "stp" "none"
	Array of objects (Switch_Service_API_&_Model_Documentation_SwitchFamilyModelBo) unique
switchId	string
	object (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo)
	Array of objects (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo) unique
taggedPortsList	Array of strings
untaggedPortsList	Array of strings
vlanId	integer <int32> [ 1 .. 4095 ]
vlanName	string

Responses

Request samples

Payload

Content type

application/json

{"arpInspection": true,
"arpInspectionTrustPort": "string",
"arpInspectionTrustPortList": ["string"
],
"arpTrustPortsList": ["string"
],
"defaultVlan": true,
"dhcpTrustPortsList": ["string"
],
"dummyVlan": true,
"enableAsDefaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"igmpSnoopingTypeChanged": true,
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"ipv4DhcpSnoopingTrustPortList": ["string"
],
"managementVlan": true,
"multicastVersion": 3,
"notDummyVlan": true,
"rapidSpanningTreeProtocol": true,
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"id": "string",
"option": "string",
"slotNumber": 0
}
],
"switchId": "string",
"taggedPorts": "string",
"untaggedPorts": "string"
}
],
"switchId": "string",
"switchVlanPortModel": {"id": "string",
"switchModel": "ICX7150-24",
"taggedPorts": "string",
"taggedPortsList": ["string"
],
"untaggedPorts": "string",
"untaggedPortsList": ["string"
]
},
"switchVlanPortModels": [{"id": "string",
"switchModel": "ICX7150-24",
"taggedPorts": "string",
"taggedPortsList": ["string"
],
"untaggedPorts": "string",
"untaggedPortsList": ["string"
]
}
],
"taggedPortsList": ["string"
],
"untaggedPortsList": ["string"
],
"vlanId": 1,
"vlanName": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Retrieve VLANs

List all usable VLANs for multiple ports of the same switch.

path Parameters

switchId

required

string

Responses

Response samples

Content type

application/json

{"profileVlan": [{"defaultVlan": true,
"profileLevel": true,
"switchId": "string",
"vlanConfigName": "string",
"vlanId": 0
}
],
"switchDefaultVlan": [{"defaultVlan": true,
"profileLevel": true,
"switchId": "string",
"vlanConfigName": "string",
"vlanId": 0
}
],
"switchVlan": [{"defaultVlan": true,
"profileLevel": true,
"switchId": "string",
"vlanConfigName": "string",
"vlanId": 0
}
]
}

Get VLANs

Get a list of VLANs in profiles with a particular venue.

path Parameters

venueId

required

string

Responses

Response samples

Content type

application/json

[{"arpInspection": true,
"arpInspectionTrustPort": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 0,
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 0,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"taggedPorts": "string",
"untaggedPorts": "string"
}
],
"vlanId": 0,
"vlanName": "string"
}
]

Retrieve Tagged-VLANs

List of venues switch-profile VLANs with specific model and tagged port.

path Parameters

venueId

required

string

Request Body schema: application/json
required

model

string

Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C" "ICX7550-24" "ICX7550-48" "ICX7550-24P" "ICX7550-48P" "ICX7550-24ZP" "ICX7550-48ZP" "ICX7550-24F" "ICX7550-48F" "ICX8200-24" "ICX8200-24P" "ICX8200-24F" "ICX8200-24FX" "ICX8200-24ZP" "ICX8200-48" "ICX8200-48F" "ICX8200-48P" "ICX8200-48PF" "ICX8200-48PF2" "ICX8200-48ZP2" "ICX8200-C08P" "ICX8200-C08PDC" "ICX8200-C08PF" "ICX8200-C08PT" "ICX8200-C08ZP"

port

string

Responses

Request samples

Payload

Content type

application/json

{"model": "ICX7150-24",
"port": "string"
}

Response samples

Content type

application/json

[{"arpInspection": true,
"arpInspectionTrustPort": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 0,
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 0,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"taggedPorts": "string",
"untaggedPorts": "string"
}
],
"vlanId": 0,
"vlanName": "string"
}
]

Retrieve Untagged-VLANs

List of venues switch-profile VLANs with specific model and untagged port.

path Parameters

venueId

required

string

Request Body schema: application/json
required

model

string

Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C" "ICX7550-24" "ICX7550-48" "ICX7550-24P" "ICX7550-48P" "ICX7550-24ZP" "ICX7550-48ZP" "ICX7550-24F" "ICX7550-48F" "ICX8200-24" "ICX8200-24P" "ICX8200-24F" "ICX8200-24FX" "ICX8200-24ZP" "ICX8200-48" "ICX8200-48F" "ICX8200-48P" "ICX8200-48PF" "ICX8200-48PF2" "ICX8200-48ZP2" "ICX8200-C08P" "ICX8200-C08PDC" "ICX8200-C08PF" "ICX8200-C08PT" "ICX8200-C08ZP"

port

string

Responses

Request samples

Payload

Content type

application/json

{"model": "ICX7150-24",
"port": "string"
}

Response samples

Content type

application/json

[{"arpInspection": true,
"arpInspectionTrustPort": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 0,
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 0,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"taggedPorts": "string",
"untaggedPorts": "string"
}
],
"vlanId": 0,
"vlanName": "string"
}
]

Get VLANs

List all of VLANs in profiles with a particular venue and the specific model.

path Parameters

venueId

required

string

query Parameters

model

required

string

Responses

Response samples

Content type

application/json

[{"arpInspection": true,
"arpInspectionTrustPort": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 0,
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 0,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"taggedPorts": "string",
"untaggedPorts": "string"
}
],
"vlanId": 0,
"vlanName": "string"
}
]

Static Route

Manage static routes.

Delete Static-Routes

Delete multiple static routes.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Delete Static-Route

Delete a particular static route.

path Parameters

staticRouteId

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Static-Route

Get a particular static route.

path Parameters

staticRouteId

required

string

Responses

Response samples

Content type

application/json

{"adminDistance": 1,
"destinationIp": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"nextHop": "string",
"staticRouteViewList": [{ }
]
}

Update Static-Route

Update a particular static route.

path Parameters

staticRouteId

required

string

Request Body schema: application/json
required

adminDistance	integer <int32> [ 1 .. 255 ]
destinationIp	string"^(\\b([0-9]\|[1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]...
id	string
nextHop	string^(\\b([0-9]\|[1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|...
uniqueValue	string

Responses

Request samples

Payload

Content type

application/json

{"adminDistance": 1,
"destinationIp": "string",
"id": "string",
"nextHop": "string",
"uniqueValue": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Static-Routes

Get multiple static routes of the switch.

path Parameters

switchId

required

string

Responses

Response samples

Content type

application/json

[{"adminDistance": 1,
"destinationIp": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"nextHop": "string",
"staticRouteViewList": [{ }
]
}
]

Add Static-Route

Add multiple static routes of the switch.

path Parameters

switchId

required

string

Request Body schema: application/json
required

Array

adminDistance	integer <int32> [ 1 .. 255 ]
destinationIp	string"^(\\b([0-9]\|[1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]...
id	string
nextHop	string^(\\b([0-9]\|[1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|...
uniqueValue	string

Responses

Request samples

Payload

Content type

application/json

[{"adminDistance": 1,
"destinationIp": "string",
"id": "string",
"nextHop": "string",
"uniqueValue": "string"
}
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Configuration Backup

Manage configuration backups.

Delete Configuration-Backups

Delete switch's configuration backups.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Compare Configuration-Backups

Compare switch's configuration backups.

Request Body schema: application/json
required

backupId1	string
backupId2	string

Responses

Request samples

Payload

Content type

application/json

{"backupId1": "string",
"backupId2": "string"
}

Response samples

Content type

application/json

{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"response": {"configBackup1": {"config": "string",
"id": "string"
},
"configBackup2": {"config": "string",
"id": "string"
}
}
}

Delete Configuration-Backup

Delete switch's configuration backup by id.

path Parameters

configBackupId

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Configuration-Backup

Get a switch's configuration backup.

path Parameters

configBackupId

required

string

Responses

Response samples

Content type

application/json

{"backupId": "string",
"backupName": "string",
"backupType": "string",
"config": "string",
"configBackupViewList": [{ }
],
"createdDate": "2019-08-24T14:15:22Z",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"failureReason": "string",
"id": "string",
"name": "string",
"restoreStatus": "string",
"restoreTimestamp": "string",
"status": "string",
"switchId": "string"
}

Restore Configuration-Backup

Restore switch's configuration backup.

path Parameters

configBackupId

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Configuration-Backups

List of switch's configuration backup.

path Parameters

switchId

required

string

Responses

Response samples

Content type

application/json

[{"backupId": "string",
"backupName": "string",
"backupType": "string",
"config": "string",
"configBackupViewList": [{ }
],
"createdDate": "2019-08-24T14:15:22Z",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"failureReason": "string",
"id": "string",
"name": "string",
"restoreStatus": "string",
"restoreTimestamp": "string",
"status": "string",
"switchId": "string"
}
]

Add Configuration-Backup

Create a switch's configuration backup.

path Parameters

switchId

required

string

Request Body schema: application/json
required

name	string^(?:(?!").){1,64}$

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Retrieve Configuration-Backups

Query the switchâs configuration backups.

path Parameters

switchId

required

string

Request Body schema: application/json
required

fields	Array of strings
filterType	string
	object
page	integer <int32>
pageSize	integer <int32>
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filterType": "string",
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"page": 0,
"pageSize": 0,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

Content type

application/json

{"data": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"fields": ["string"
],
"id": "string",
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Web Authentication Page Template

Manage web authentication page template.

Add Web Authentication Template

Add web authentication page template.

Request Body schema: application/json
required

id	string [ 0 .. 37 ] characters
name required	string [ 0 .. 32 ] characters
tag	string [ 0 .. 255 ] characters
tenantId	string
webAuthCustomBottom	string [ 0 .. 255 ] characters
webAuthCustomLoginButton	string [ 0 .. 32 ] characters
webAuthCustomTitle	string [ 0 .. 128 ] characters
webAuthCustomTop	string [ 0 .. 255 ] characters
webAuthPasswordLabel	string [ 0 .. 32 ] characters

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"tag": "string",
"tenantId": "string",
"webAuthCustomBottom": "string",
"webAuthCustomLoginButton": "string",
"webAuthCustomTitle": "string",
"webAuthCustomTop": "string",
"webAuthPasswordLabel": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Query Web Authentication Templates

List of tenant's web authentication page templates.

Request Body schema: application/json
required

fields	Array of strings
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings
serverType	string Enum: "__NULL" "RADIUS" "TACACS_PLUS" "LOCAL" "NONE_TYPE"
sortField	string
sortOrder	string Enum: "ASC" "DESC"
venueId	string

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"serverType": "__NULL",
"sortField": "string",
"sortOrder": "ASC",
"venueId": "string"
}

Response samples

Content type

application/json

{"data": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"fields": ["string"
],
"id": "string",
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Delete Web Authentication Template

Delete web authentication page template by id.

path Parameters

templateId

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Web Authentication Template

Get a web authentication page template by id.

path Parameters

templateId

required

string

Responses

Response samples

Content type

application/json

{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string",
"switchCount": 0,
"switchVenueInfos": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"serialNumber": "string",
"switchId": "string",
"switchModel": "string",
"switchName": "string",
"venueId": "string",
"venueName": "string"
}
],
"tag": "string",
"venueCount": 0,
"webAuthCustomBottom": "string",
"webAuthCustomLoginButton": "string",
"webAuthCustomTitle": "string",
"webAuthCustomTop": "string",
"webAuthPageTemplateViewList": [{ }
],
"webAuthPasswordLabel": "string",
"webAuthUserIdLabel": "string"
}

Update Web Authentication Template

Update web authentication page template by id.

path Parameters

templateId

required

string

Request Body schema: application/json
required

id	string [ 0 .. 37 ] characters
name required	string [ 0 .. 32 ] characters
tag	string [ 0 .. 255 ] characters
tenantId	string
webAuthCustomBottom	string [ 0 .. 255 ] characters
webAuthCustomLoginButton	string [ 0 .. 32 ] characters
webAuthCustomTitle	string [ 0 .. 128 ] characters
webAuthCustomTop	string [ 0 .. 255 ] characters
webAuthPasswordLabel	string [ 0 .. 32 ] characters

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"tag": "string",
"tenantId": "string",
"webAuthCustomBottom": "string",
"webAuthCustomLoginButton": "string",
"webAuthCustomTitle": "string",
"webAuthCustomTop": "string",
"webAuthPasswordLabel": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Web Authentication Template's Switch Info

Get a web authentication page template's switch info by id.

path Parameters

templateId

required

string

Responses

Response samples

Content type

application/json

{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string",
"switchCount": 0,
"switchVenueInfos": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"serialNumber": "string",
"switchId": "string",
"switchModel": "string",
"switchName": "string",
"venueId": "string",
"venueName": "string"
}
],
"tag": "string",
"venueCount": 0,
"webAuthCustomBottom": "string",
"webAuthCustomLoginButton": "string",
"webAuthCustomTitle": "string",
"webAuthCustomTop": "string",
"webAuthPageTemplateViewList": [{ }
],
"webAuthPasswordLabel": "string",
"webAuthUserIdLabel": "string"
}

Command-Line Interface Template

Manage command-line interface templates.

Delete Command-Line Interface Templates

Delete command-line interface templates.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Command-Line Interface Templates

Get a list of command-line interface templates.

Responses

Response samples

Content type

application/json

[{"acxCliTemplateViewList": [{ }
],
"applyLater": true,
"cli": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string",
"reload": true,
"variables": [{"name": "string",
"type": "ADDRESS",
"value": "string"
}
],
"venueSwitches": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"switches": ["string"
],
"venueId": "string"
}
]
}
]

Add Command-Line Interface Template

Create a command-line interface template for switches.

Request Body schema: application/json
required

	Array of objects (Switch_Service_API_&_Model_Documentation_AcxCliTemplateSwitchesBo) unique
applyLater	boolean
cli	string
id	string
name	string^.{1,64}$
reload	boolean
	Array of objects (Switch_Service_API_&_Model_Documentation_AcxCliTemplateVariableBo) unique
	Array of objects (Switch_Service_API_&_Model_Documentation_VenueSwitchBo)

Responses

Request samples

Payload

Content type

application/json

{"acxCliTemplateSwitches": [{"acxCliTemplate": {"acxCliTemplateSwitches": [{"id": "string",
"switches": ["string"
],
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
]
},
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
}
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
}
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": {"firmwareVersion": null,
"id": null,
"latestBetaVersion": null,
"latestReleaseVersion": null,
"latestReleaseVersionAboveTen": null,
"name": null,
"preDownloadFirmware": null,
"profiles": [ ],
"venues": [ ]
},
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [ ],
"acxCliProfile": null,
"acxVenueCliTemplate": null,
"cliProfile": null,
"description": null,
"id": null,
"name": null,
"profileType": null,
"profileVenues": [ ],
"regularProfile": null,
"tenant": null,
"trustedPorts": [ ],
"venues": [ ],
"vlans": [ ]
}
],
"venues": [{ }
]
},
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
},
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": null,
"id": null,
"latestBetaVersion": null,
"latestReleaseVersion": null,
"latestReleaseVersionAboveTen": null,
"name": null,
"preDownloadFirmware": null,
"profiles": [ ],
"venues": [ ]
}
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": null,
"id": null,
"latestBetaVersion": null,
"latestReleaseVersion": null,
"latestReleaseVersionAboveTen": null,
"name": null,
"preDownloadFirmware": null,
"profiles": [ ],
"venues": [ ]
}
}
}
}
}
],
"applyLater": true,
"cli": "string",
"id": "string",
"name": "string",
"reload": true,
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [null
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": null,
"id": null,
"ipAddressEnd": null,
"ipAddressStart": null,
"name": null,
"needUpdate": null,
"subMaskAndEndIp": [ ],
"value": null,
"variableName": null,
"variableType": null
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": {"addressLine": null,
"cliApplied": null,
"dns": [ ],
"dnsList": [ ],
"firmware": null,
"id": null,
"lastScheduleUpdateTime": null,
"name": null,
"preDownloadFirmware": null,
"profileId": [ ],
"switchFirmwareVersion": null,
"switchFirmwareVersionAboveTen": null,
"switchLoginPassword": null,
"switchLoginUsername": null,
"switches": [ ],
"syslogEnabled": null,
"syslogPrimaryServer": null,
"syslogSecondaryServer": null,
"tenant": null,
"timeZone": null,
"upgradeSchedule": null
}
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [null
],
"tenant": { },
"trustPorts": [null
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [null
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"variables": [{"addressType": true,
"id": "string",
"ipAddressEnd": 0,
"ipAddressStart": 0,
"name": "string",
"needUpdate": true,
"subMaskAndEndIp": ["string"
],
"value": "string",
"variableName": "string",
"variableType": "ADDRESS"
}
]
},
"id": "string",
"switches": ["string"
],
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [{"acl": null,
"action": null,
"destination": null,
"destinationPort": null,
"dscpMarking": null,
"dscpMatching": null,
"id": null,
"internalPriority": null,
"protocol": null,
"sequence": null,
"source": null,
"sourcePort": null,
"tenant": null
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": true,
"id": "string",
"ipAddressEnd": 0,
"ipAddressStart": 0,
"name": "string",
"needUpdate": true,
"subMaskAndEndIp": [null
],
"value": "string",
"variableName": "string",
"variableType": "ADDRESS"
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [{"enable": null,
"option": null,
"slotNumber": null
}
],
"tenant": { },
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": null,
"model": null,
"slots": [ ],
"taggedPorts": null,
"tenant": null,
"untaggedPorts": null,
"vlan": null
}
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [{"byMergeDeployLogDetail": null,
"cliDeploy": null,
"cliProvisionDeploy": null,
"clis": null,
"collectConf": null,
"configType": null,
"dataSyncFail": null,
"deployExtraStatus": null,
"deployTime": null,
"deployTimeFromFakeResponse": null,
"dispatchConfig": null,
"dispatchConfigBo": null,
"dispatchError": [ ],
"dispatchStatus": null,
"expireTime": null,
"hostnameVariable": null,
"id": null,
"inprogress": null,
"isActiveRole": null,
"notFinalState": null,
"overwriteDeploy": null,
"provisionDeploy": null,
"responseTime": null,
"retryCount": null,
"specificDeploy": null,
"stackDeploy": null,
"startTime": null,
"switchId": null,
"switchName": null,
"tenant": null,
"transactionId": null,
"triggerSyncDeploy": null,
"venueId": null
}
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [null
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{"activeSwitch": null,
"id": null,
"insufficientLicense": null,
"model": null,
"priority": null,
"tenant": null,
"unitId": null
}
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [ ],
"aclType": null,
"id": null,
"name": null,
"profile": null,
"profileId": null,
"tenant": null
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": [null
],
"switchModels": "string",
"tenant": { },
"variables": [null
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": null,
"profile": null,
"tenant": null,
"venue": null
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": null,
"model": null,
"profile": null,
"slots": [ ],
"tenant": null,
"trustPorts": [ ],
"trustedPortType": null,
"vlanDemand": null
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": null,
"arpInspectionTrustPort": null,
"defaultVlan": null,
"id": null,
"igmpSnooping": null,
"ipv4DhcpSnooping": null,
"ipv4DhcpSnoopingTrustPort": null,
"multicastVersion": null,
"profile": null,
"rootBridgeFamilyId": null,
"spanningTreePriority": null,
"spanningTreeProtocol": null,
"switchFamilyModels": [ ],
"tenant": null,
"vlanId": null,
"vlanName": null
}
]
}
],
"venues": [{ }
]
}
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [ ],
"aclType": null,
"id": null,
"name": null,
"profile": null,
"profileId": null,
"tenant": null
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": [null
],
"switchModels": "string",
"tenant": { },
"variables": [null
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": null,
"profile": null,
"tenant": null,
"venue": null
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": null,
"model": null,
"profile": null,
"slots": [ ],
"tenant": null,
"trustPorts": [ ],
"trustedPortType": null,
"vlanDemand": null
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": null,
"arpInspectionTrustPort": null,
"defaultVlan": null,
"id": null,
"igmpSnooping": null,
"ipv4DhcpSnooping": null,
"ipv4DhcpSnoopingTrustPort": null,
"multicastVersion": null,
"profile": null,
"rootBridgeFamilyId": null,
"spanningTreePriority": null,
"spanningTreeProtocol": null,
"switchFamilyModels": [ ],
"tenant": null,
"vlanId": null,
"vlanName": null
}
]
}
],
"venues": [{ }
]
}
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [{"byMergeDeployLogDetail": { },
"cliDeploy": true,
"cliProvisionDeploy": true,
"clis": "string",
"collectConf": true,
"configType": "PROVISIONING",
"dataSyncFail": true,
"deployExtraStatus": "string",
"deployTime": "2019-08-24T14:15:22Z",
"deployTimeFromFakeResponse": {"configType": "PROVISIONING",
"fakeReason": "TIMEOUT",
"fakeTimestamp": "2019-08-24T14:15:22Z",
"operationId": "string",
"restconf_response": "string",
"switchId": "string",
"timestamp": "string",
"transactionId": "string"
},
"dispatchConfig": {"cliTemplateId": "string"
},
"dispatchConfigBo": {"activeStackConfig": true,
"addDeployConfigs": {"aaaServers": null,
"aaaSettings": null,
"accessSwitchConfigs": null,
"acls": null,
"acxCliTemplateVariables": null,
"commonConfigs": null,
"configType": null,
"defaultVlans": null,
"dhcpClients": null,
"dhcpServers": null,
"distributionSwitchConfigs": null,
"ipConfigs": null,
"lags": null,
"modelFamily": null,
"portConfigs": null,
"profileId": null,
"specificSettings": null,
"stackConfigs": null,
"staticRoutes": null,
"switches": [ ],
"syslogServerConfigs": null,
"vePortConfigs": null,
"vlans": null
},
"changeLogList": [null
],
"cliNotificationType": "SWITCH_DELETE",
"configType": "PROVISIONING",
"copyConfig": "string",
"deployMode": "REST_CONF",
"disconnectCli": true,
"enableDefaultConfig": true,
"extraConfig": "string",
"firmwareVersion": "string",
"groupOptimization": true,
"hasDefaultVlanConfig": true,
"hasIpConfig": true,
"initialVlanId": 0,
"isRouter": true,
"memberStackConfig": true,
"needMarkAsOffline": true,
"needReload": true,
"overwriteStartupConfig": true,
"removeDeployConfigs": {"aaaServers": null,
"aaaSettings": null,
"accessSwitchConfigs": null,
"acls": null,
"acxCliTemplateVariables": null,
"commonConfigs": null,
"configType": null,
"defaultVlans": null,
"dhcpClients": null,
"dhcpServers": null,
"distributionSwitchConfigs": null,
"ipConfigs": null,
"lags": null,
"modelFamily": null,
"portConfigs": null,
"profileId": null,
"specificSettings": null,
"stackConfigs": null,
"staticRoutes": null,
"switches": [ ],
"syslogServerConfigs": null,
"vePortConfigs": null,
"vlans": null
},
"serialNumber": "string",
"switchId": "string",
"transactionId": "string",
"triggerType": "PROVISIONING"
},
"dispatchError": [{"lineNumber": null,
"message": null,
"status": null
}
],
"dispatchStatus": "PENDING",
"expireTime": "2019-08-24T14:15:22Z",
"hostnameVariable": "string",
"id": "string",
"inprogress": true,
"isActiveRole": true,
"notFinalState": true,
"overwriteDeploy": true,
"provisionDeploy": true,
"responseTime": "2019-08-24T14:15:22Z",
"retryCount": 0,
"specificDeploy": true,
"stackDeploy": true,
"startTime": "2019-08-24T14:15:22Z",
"switchId": "string",
"switchName": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
},
"transactionId": "string",
"triggerSyncDeploy": true,
"venueId": "string"
}
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [{"addr": "string",
"pref_len": 0
}
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{"activeSwitch": { },
"id": "string",
"insufficientLicense": true,
"model": "string",
"priority": 255,
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
},
"unitId": 1
}
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{ }
]
},
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [null
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": null,
"id": null,
"ipAddressEnd": null,
"ipAddressStart": null,
"name": null,
"needUpdate": null,
"subMaskAndEndIp": [ ],
"value": null,
"variableName": null,
"variableType": null
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": { }
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [null
],
"tenant": { },
"trustPorts": [null
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [null
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{ }
]
},
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [ ],
"aclType": null,
"id": null,
"name": null,
"profile": null,
"profileId": null,
"tenant": null
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": [null
],
"switchModels": "string",
"tenant": { },
"variables": [null
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": null,
"profile": null,
"tenant": null,
"venue": null
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": null,
"model": null,
"profile": null,
"slots": [ ],
"tenant": null,
"trustPorts": [ ],
"trustedPortType": null,
"vlanDemand": null
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": null,
"arpInspectionTrustPort": null,
"defaultVlan": null,
"id": null,
"igmpSnooping": null,
"ipv4DhcpSnooping": null,
"ipv4DhcpSnoopingTrustPort": null,
"multicastVersion": null,
"profile": null,
"rootBridgeFamilyId": null,
"spanningTreePriority": null,
"spanningTreeProtocol": null,
"switchFamilyModels": [ ],
"tenant": null,
"vlanId": null,
"vlanName": null
}
]
}
],
"venues": [{ }
]
},
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{ }
]
}
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{ }
]
}
}
}
}
}
],
"applyLater": true,
"cli": "string",
"id": "string",
"name": "string",
"reload": true,
"variables": [{"cliTemplateType": "CLI_TEMPLATE_PROVISION",
"currentRangeValue": {"acquire": 0,
"andDecrement": 0,
"andIncrement": 0,
"opaque": 0,
"plain": 0,
"release": 0
},
"endIpAddress": "string",
"id": "string",
"ipAddress": "string",
"name": "string",
"needUpdate": true,
"rangeEnd": 0,
"rangeStart": 0,
"subMask": "string",
"switchId": "string",
"type": "ADDRESS",
"value": "string"
}
],
"venueSwitches": [{"switches": ["string"
],
"venueId": "string"
}
]
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Command-Line Interface Template-Examples

Get a list of command-line interface template examples.

query Parameters

Responses

Response samples

Content type

application/json

[{"cli": "string",
"id": "string",
"name": "string",
"version": "string"
}
]

Query Command-Line Interface Templates

Get a list of command-line interface templates by query.

Request Body schema: application/json
required

fields	Array of strings
filterType	string
	object
page	integer <int32>
pageSize	integer <int32>
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filterType": "string",
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"page": 0,
"pageSize": 0,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

Content type

application/json

{"data": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"fields": ["string"
],
"id": "string",
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Delete Command-Line Interface Template

Delete a command-line interface template by id.

path Parameters

cliTemplateId

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Command-Line Interface Template

Get a command-line interface template by id.

path Parameters

cliTemplateId

required

string

Responses

Response samples

Content type

application/json

{"acxCliTemplateViewList": [{ }
],
"applyLater": true,
"cli": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string",
"reload": true,
"variables": [{"name": "string",
"type": "ADDRESS",
"value": "string"
}
],
"venueSwitches": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"switches": ["string"
],
"venueId": "string"
}
]
}

Update Command-Line Interface Template

Update a command-line interface template for switches by id.

path Parameters

cliTemplateId

required

string

Request Body schema: application/json
required

	Array of objects (Switch_Service_API_&_Model_Documentation_AcxCliTemplateSwitchesBo) unique
applyLater	boolean
cli	string
id	string
name	string^.{1,64}$
reload	boolean
	Array of objects (Switch_Service_API_&_Model_Documentation_AcxCliTemplateVariableBo) unique
	Array of objects (Switch_Service_API_&_Model_Documentation_VenueSwitchBo)

Responses

Request samples

Payload

Content type

application/json

{"acxCliTemplateSwitches": [{"acxCliTemplate": {"acxCliTemplateSwitches": [{"id": "string",
"switches": ["string"
],
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
]
},
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
}
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
}
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": {"firmwareVersion": null,
"id": null,
"latestBetaVersion": null,
"latestReleaseVersion": null,
"latestReleaseVersionAboveTen": null,
"name": null,
"preDownloadFirmware": null,
"profiles": [ ],
"venues": [ ]
},
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [ ],
"acxCliProfile": null,
"acxVenueCliTemplate": null,
"cliProfile": null,
"description": null,
"id": null,
"name": null,
"profileType": null,
"profileVenues": [ ],
"regularProfile": null,
"tenant": null,
"trustedPorts": [ ],
"venues": [ ],
"vlans": [ ]
}
],
"venues": [{ }
]
},
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
},
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": null,
"id": null,
"latestBetaVersion": null,
"latestReleaseVersion": null,
"latestReleaseVersionAboveTen": null,
"name": null,
"preDownloadFirmware": null,
"profiles": [ ],
"venues": [ ]
}
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": null,
"id": null,
"latestBetaVersion": null,
"latestReleaseVersion": null,
"latestReleaseVersionAboveTen": null,
"name": null,
"preDownloadFirmware": null,
"profiles": [ ],
"venues": [ ]
}
}
}
}
}
],
"applyLater": true,
"cli": "string",
"id": "string",
"name": "string",
"reload": true,
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [null
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": null,
"id": null,
"ipAddressEnd": null,
"ipAddressStart": null,
"name": null,
"needUpdate": null,
"subMaskAndEndIp": [ ],
"value": null,
"variableName": null,
"variableType": null
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": {"addressLine": null,
"cliApplied": null,
"dns": [ ],
"dnsList": [ ],
"firmware": null,
"id": null,
"lastScheduleUpdateTime": null,
"name": null,
"preDownloadFirmware": null,
"profileId": [ ],
"switchFirmwareVersion": null,
"switchFirmwareVersionAboveTen": null,
"switchLoginPassword": null,
"switchLoginUsername": null,
"switches": [ ],
"syslogEnabled": null,
"syslogPrimaryServer": null,
"syslogSecondaryServer": null,
"tenant": null,
"timeZone": null,
"upgradeSchedule": null
}
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [null
],
"tenant": { },
"trustPorts": [null
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [null
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"variables": [{"addressType": true,
"id": "string",
"ipAddressEnd": 0,
"ipAddressStart": 0,
"name": "string",
"needUpdate": true,
"subMaskAndEndIp": ["string"
],
"value": "string",
"variableName": "string",
"variableType": "ADDRESS"
}
]
},
"id": "string",
"switches": ["string"
],
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [{"acl": null,
"action": null,
"destination": null,
"destinationPort": null,
"dscpMarking": null,
"dscpMatching": null,
"id": null,
"internalPriority": null,
"protocol": null,
"sequence": null,
"source": null,
"sourcePort": null,
"tenant": null
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": true,
"id": "string",
"ipAddressEnd": 0,
"ipAddressStart": 0,
"name": "string",
"needUpdate": true,
"subMaskAndEndIp": [null
],
"value": "string",
"variableName": "string",
"variableType": "ADDRESS"
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [{"enable": null,
"option": null,
"slotNumber": null
}
],
"tenant": { },
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": null,
"model": null,
"slots": [ ],
"taggedPorts": null,
"tenant": null,
"untaggedPorts": null,
"vlan": null
}
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [{"byMergeDeployLogDetail": null,
"cliDeploy": null,
"cliProvisionDeploy": null,
"clis": null,
"collectConf": null,
"configType": null,
"dataSyncFail": null,
"deployExtraStatus": null,
"deployTime": null,
"deployTimeFromFakeResponse": null,
"dispatchConfig": null,
"dispatchConfigBo": null,
"dispatchError": [ ],
"dispatchStatus": null,
"expireTime": null,
"hostnameVariable": null,
"id": null,
"inprogress": null,
"isActiveRole": null,
"notFinalState": null,
"overwriteDeploy": null,
"provisionDeploy": null,
"responseTime": null,
"retryCount": null,
"specificDeploy": null,
"stackDeploy": null,
"startTime": null,
"switchId": null,
"switchName": null,
"tenant": null,
"transactionId": null,
"triggerSyncDeploy": null,
"venueId": null
}
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [null
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{"activeSwitch": null,
"id": null,
"insufficientLicense": null,
"model": null,
"priority": null,
"tenant": null,
"unitId": null
}
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [ ],
"aclType": null,
"id": null,
"name": null,
"profile": null,
"profileId": null,
"tenant": null
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": [null
],
"switchModels": "string",
"tenant": { },
"variables": [null
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": null,
"profile": null,
"tenant": null,
"venue": null
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": null,
"model": null,
"profile": null,
"slots": [ ],
"tenant": null,
"trustPorts": [ ],
"trustedPortType": null,
"vlanDemand": null
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": null,
"arpInspectionTrustPort": null,
"defaultVlan": null,
"id": null,
"igmpSnooping": null,
"ipv4DhcpSnooping": null,
"ipv4DhcpSnoopingTrustPort": null,
"multicastVersion": null,
"profile": null,
"rootBridgeFamilyId": null,
"spanningTreePriority": null,
"spanningTreeProtocol": null,
"switchFamilyModels": [ ],
"tenant": null,
"vlanId": null,
"vlanName": null
}
]
}
],
"venues": [{ }
]
}
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [ ],
"aclType": null,
"id": null,
"name": null,
"profile": null,
"profileId": null,
"tenant": null
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": [null
],
"switchModels": "string",
"tenant": { },
"variables": [null
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": null,
"profile": null,
"tenant": null,
"venue": null
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": null,
"model": null,
"profile": null,
"slots": [ ],
"tenant": null,
"trustPorts": [ ],
"trustedPortType": null,
"vlanDemand": null
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": null,
"arpInspectionTrustPort": null,
"defaultVlan": null,
"id": null,
"igmpSnooping": null,
"ipv4DhcpSnooping": null,
"ipv4DhcpSnoopingTrustPort": null,
"multicastVersion": null,
"profile": null,
"rootBridgeFamilyId": null,
"spanningTreePriority": null,
"spanningTreeProtocol": null,
"switchFamilyModels": [ ],
"tenant": null,
"vlanId": null,
"vlanName": null
}
]
}
],
"venues": [{ }
]
}
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [{"byMergeDeployLogDetail": { },
"cliDeploy": true,
"cliProvisionDeploy": true,
"clis": "string",
"collectConf": true,
"configType": "PROVISIONING",
"dataSyncFail": true,
"deployExtraStatus": "string",
"deployTime": "2019-08-24T14:15:22Z",
"deployTimeFromFakeResponse": {"configType": "PROVISIONING",
"fakeReason": "TIMEOUT",
"fakeTimestamp": "2019-08-24T14:15:22Z",
"operationId": "string",
"restconf_response": "string",
"switchId": "string",
"timestamp": "string",
"transactionId": "string"
},
"dispatchConfig": {"cliTemplateId": "string"
},
"dispatchConfigBo": {"activeStackConfig": true,
"addDeployConfigs": {"aaaServers": null,
"aaaSettings": null,
"accessSwitchConfigs": null,
"acls": null,
"acxCliTemplateVariables": null,
"commonConfigs": null,
"configType": null,
"defaultVlans": null,
"dhcpClients": null,
"dhcpServers": null,
"distributionSwitchConfigs": null,
"ipConfigs": null,
"lags": null,
"modelFamily": null,
"portConfigs": null,
"profileId": null,
"specificSettings": null,
"stackConfigs": null,
"staticRoutes": null,
"switches": [ ],
"syslogServerConfigs": null,
"vePortConfigs": null,
"vlans": null
},
"changeLogList": [null
],
"cliNotificationType": "SWITCH_DELETE",
"configType": "PROVISIONING",
"copyConfig": "string",
"deployMode": "REST_CONF",
"disconnectCli": true,
"enableDefaultConfig": true,
"extraConfig": "string",
"firmwareVersion": "string",
"groupOptimization": true,
"hasDefaultVlanConfig": true,
"hasIpConfig": true,
"initialVlanId": 0,
"isRouter": true,
"memberStackConfig": true,
"needMarkAsOffline": true,
"needReload": true,
"overwriteStartupConfig": true,
"removeDeployConfigs": {"aaaServers": null,
"aaaSettings": null,
"accessSwitchConfigs": null,
"acls": null,
"acxCliTemplateVariables": null,
"commonConfigs": null,
"configType": null,
"defaultVlans": null,
"dhcpClients": null,
"dhcpServers": null,
"distributionSwitchConfigs": null,
"ipConfigs": null,
"lags": null,
"modelFamily": null,
"portConfigs": null,
"profileId": null,
"specificSettings": null,
"stackConfigs": null,
"staticRoutes": null,
"switches": [ ],
"syslogServerConfigs": null,
"vePortConfigs": null,
"vlans": null
},
"serialNumber": "string",
"switchId": "string",
"transactionId": "string",
"triggerType": "PROVISIONING"
},
"dispatchError": [{"lineNumber": null,
"message": null,
"status": null
}
],
"dispatchStatus": "PENDING",
"expireTime": "2019-08-24T14:15:22Z",
"hostnameVariable": "string",
"id": "string",
"inprogress": true,
"isActiveRole": true,
"notFinalState": true,
"overwriteDeploy": true,
"provisionDeploy": true,
"responseTime": "2019-08-24T14:15:22Z",
"retryCount": 0,
"specificDeploy": true,
"stackDeploy": true,
"startTime": "2019-08-24T14:15:22Z",
"switchId": "string",
"switchName": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
},
"transactionId": "string",
"triggerSyncDeploy": true,
"venueId": "string"
}
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [{"addr": "string",
"pref_len": 0
}
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{"activeSwitch": { },
"id": "string",
"insufficientLicense": true,
"model": "string",
"priority": 255,
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
},
"unitId": 1
}
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{ }
]
},
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [null
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": null,
"id": null,
"ipAddressEnd": null,
"ipAddressStart": null,
"name": null,
"needUpdate": null,
"subMaskAndEndIp": [ ],
"value": null,
"variableName": null,
"variableType": null
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": { }
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [null
],
"tenant": { },
"trustPorts": [null
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [null
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{ }
]
},
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [ ],
"aclType": null,
"id": null,
"name": null,
"profile": null,
"profileId": null,
"tenant": null
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": [null
],
"switchModels": "string",
"tenant": { },
"variables": [null
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": null,
"profile": null,
"tenant": null,
"venue": null
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": null,
"model": null,
"profile": null,
"slots": [ ],
"tenant": null,
"trustPorts": [ ],
"trustedPortType": null,
"vlanDemand": null
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": null,
"arpInspectionTrustPort": null,
"defaultVlan": null,
"id": null,
"igmpSnooping": null,
"ipv4DhcpSnooping": null,
"ipv4DhcpSnoopingTrustPort": null,
"multicastVersion": null,
"profile": null,
"rootBridgeFamilyId": null,
"spanningTreePriority": null,
"spanningTreeProtocol": null,
"switchFamilyModels": [ ],
"tenant": null,
"vlanId": null,
"vlanName": null
}
]
}
],
"venues": [{ }
]
},
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{ }
]
}
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [null
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": null,
"id": null,
"name": null,
"overwrite": null,
"profile": null,
"switchModelArray": [ ],
"switchModels": null,
"tenant": null,
"variables": [ ]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [null
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [null
],
"venues": [null
],
"vlans": [null
]
}
],
"venues": [{ }
]
}
}
}
}
}
],
"applyLater": true,
"cli": "string",
"id": "string",
"name": "string",
"reload": true,
"variables": [{"cliTemplateType": "CLI_TEMPLATE_PROVISION",
"currentRangeValue": {"acquire": 0,
"andDecrement": 0,
"andIncrement": 0,
"opaque": 0,
"plain": 0,
"release": 0
},
"endIpAddress": "string",
"id": "string",
"ipAddress": "string",
"name": "string",
"needUpdate": true,
"rangeEnd": 0,
"rangeStart": 0,
"subMask": "string",
"switchId": "string",
"type": "ADDRESS",
"value": "string"
}
],
"venueSwitches": [{"switches": ["string"
],
"venueId": "string"
}
]
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Firmware Upgrade

Manage firmware upgrade.

Get Current Versions

Get current versions of the venues.

Responses

Response samples

Content type

application/json

{"currentVersions": ["string"
],
"currentVersionsAboveTen": ["string"
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}

Delete Upgrade Schedule

Cancel the schedule for firmware upgrade.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"response": "string"
}

Create Upgrade Schedule

Schedule the firmware upgrade for venues. Use activity API with request id to get the status update.

Request Body schema: application/json
required

date	string
	object
id	string
preDownload	boolean
switchVersion	string
switchVersionAboveTen	string
time	string
venueIds	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"date": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"preDownload": true,
"switchVersion": "string",
"switchVersionAboveTen": "string",
"time": "string",
"venueIds": ["string"
]
}

Response samples

Content type

application/json

{"response": "string"
}

Get Venues

Get all venues by tenant id for upgrading.

Request Body schema: application/json
required

firmwareType	string
firmwareVersion	string
search	string
updateAvailable	boolean

Responses

Request samples

Payload

Content type

application/json

{"firmwareType": "string",
"firmwareVersion": "string",
"search": "string",
"updateAvailable": true
}

Response samples

Content type

application/json

{"aboveTenSwitchCount": 0,
"availableVersions": [{"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [{"acl": null,
"action": null,
"destination": null,
"destinationPort": null,
"dscpMarking": null,
"dscpMatching": null,
"id": null,
"internalPriority": null,
"protocol": null,
"sequence": null,
"source": null,
"sourcePort": null,
"tenant": null
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": true,
"id": "string",
"name": "string",
"needUpdate": true,
"value": "string",
"variableName": "string",
"variableType": "ADDRESS"
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": { },
"switchFirmwareVersionAboveTen": { },
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [{"enable": null,
"option": null,
"slotNumber": null
}
],
"tenant": { },
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": null,
"model": null,
"slots": [ ],
"taggedPorts": null,
"tenant": null,
"untaggedPorts": null,
"vlan": null
}
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": { },
"switchFirmwareVersionAboveTen": { },
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [null
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{"activeSwitch": null,
"id": null,
"insufficientLicense": null,
"model": null,
"priority": null,
"tenant": null,
"unitId": null
}
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": { },
"versionAboveTen": { }
}
}
]
}
}
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"nextSchedule": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z"
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [{"acl": null,
"action": null,
"destination": null,
"destinationPort": null,
"dscpMarking": null,
"dscpMatching": null,
"id": null,
"internalPriority": null,
"protocol": null,
"sequence": null,
"source": null,
"sourcePort": null,
"tenant": null
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": true,
"id": "string",
"name": "string",
"needUpdate": true,
"value": "string",
"variableName": "string",
"variableType": "ADDRESS"
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": { },
"switchFirmwareVersionAboveTen": { },
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [{"enable": null,
"option": null,
"slotNumber": null
}
],
"tenant": { },
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": null,
"model": null,
"slots": [ ],
"taggedPorts": null,
"tenant": null,
"untaggedPorts": null,
"vlan": null
}
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": { },
"switchFirmwareVersionAboveTen": { },
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [null
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{"activeSwitch": null,
"id": null,
"insufficientLicense": null,
"model": null,
"priority": null,
"tenant": null,
"unitId": null
}
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": { },
"versionAboveTen": { }
}
}
]
}
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [{"acl": null,
"action": null,
"destination": null,
"destinationPort": null,
"dscpMarking": null,
"dscpMatching": null,
"id": null,
"internalPriority": null,
"protocol": null,
"sequence": null,
"source": null,
"sourcePort": null,
"tenant": null
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": true,
"id": "string",
"name": "string",
"needUpdate": true,
"value": "string",
"variableName": "string",
"variableType": "ADDRESS"
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": { },
"switchFirmwareVersionAboveTen": { },
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [{"enable": null,
"option": null,
"slotNumber": null
}
],
"tenant": { },
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": null,
"model": null,
"slots": [ ],
"taggedPorts": null,
"tenant": null,
"untaggedPorts": null,
"vlan": null
}
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": { },
"switchFirmwareVersionAboveTen": { },
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [null
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{"activeSwitch": null,
"id": null,
"insufficientLicense": null,
"model": null,
"priority": null,
"tenant": null,
"unitId": null
}
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": { },
"versionAboveTen": { }
}
}
]
}
}
},
"preDownload": true,
"switchCount": 0,
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [{"acl": { },
"action": "permit",
"destination": "string",
"destinationPort": 65535,
"dscpMarking": 0,
"dscpMatching": 0,
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 1,
"source": "string",
"sourcePort": 65535,
"tenant": { }
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": true,
"id": "string",
"name": "string",
"needUpdate": true,
"value": "string",
"variableName": "string",
"variableType": "ADDRESS"
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": { },
"switchFirmwareVersionAboveTen": { },
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [ ],
"ackRemoveStackMember": [ ],
"aclCustomize": null,
"activeId": null,
"activeSwitch": null,
"activeUnitId": null,
"andCheckOnboardType": [ ],
"brandNew": null,
"brandNewCase": null,
"brandNewVeId": null,
"cacheFactoryDefault": null,
"cliApplied": null,
"cloudPort": null,
"collectInterval": null,
"collectIntervalCustomize": null,
"communityString": null,
"configApplying": null,
"connectPort": null,
"defaultGateway": null,
"deployFailInfo": null,
"description": null,
"dhcpClientEnabled": null,
"dhcpServerEnabled": null,
"discovery": null,
"displayOfStack": null,
"dns": null,
"downloadVersion": null,
"enableStack": null,
"extraStatus": null,
"factoryDefault": null,
"familyId": null,
"firmwareUpgrading": null,
"firmwareVersion": null,
"firstJoin": null,
"formedStack": null,
"fromDeviceDiscoveryRequest": null,
"getBackStackCase": null,
"id": null,
"igmpSnooping": null,
"initDns": null,
"initialCli": null,
"initialVlanId": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipAddressType": null,
"ipDhcpClientVeId": null,
"ipFromIpConfigBo": null,
"ipInterfaceByInitialConfig": null,
"is7150Switch": null,
"is7650Switch": null,
"is8200Switch": null,
"isPrimaryDeleted": null,
"isStack": null,
"joinedIpStatus": null,
"joinedIpStatusFullIpSet": null,
"jumboMode": null,
"lastCollectTime": null,
"lastConfigCompleteTime": null,
"lastConfigNotifyTime": null,
"lastConfigStatus": null,
"lastDataSyncTime": null,
"lastDataSyncTriggerTime": null,
"lastOfflineAlarmTime": null,
"lastOfflineTime": null,
"lastOnlineTime": null,
"lastTriggerSyncTime": null,
"memberJoinCase": null,
"mgmtInterfaceEnabled": null,
"migration": null,
"model": null,
"modelFamily": null,
"name": null,
"networkSegmentationId": null,
"notCustomizeVlan": null,
"notOnline": null,
"notSyncedPortConfig": null,
"notSyncedSwitchConfig": null,
"numOfUnits": null,
"offline": null,
"onboardType": null,
"online": null,
"operational": null,
"overwriteCase": null,
"overwriteDoneCase": null,
"policy": null,
"preProvisionStatus": null,
"previousMembers": [ ],
"provisionCase": null,
"provisionDoneCase": null,
"rearModule": null,
"removedIpInterfaceIfChanged": null,
"router": null,
"runningIpAddress": null,
"sendedHostname": null,
"serialNumber": null,
"softDeleted": null,
"softDeletedDate": null,
"spanningTreePriority": null,
"specifiedType": null,
"stack": null,
"stackConfigTimestamp": null,
"stackMember": null,
"stackMembers": [ ],
"stackPriority": null,
"stackUnitIds": null,
"stagingSwitch": null,
"streamingDataInterval": null,
"subnetMask": null,
"supportedCsl": null,
"suspendingDeployTime": null,
"switch": null,
"switchPosition": null,
"switchStatus": null,
"syncedPortConfig": null,
"syncedSwitchConfig": null,
"tags": null,
"tenant": null,
"tenantSync": null,
"trustPorts": [ ],
"unknown": null,
"venue": null,
"vlanCustomize": null,
"waitConfigurationCollectTime": null,
"waitingConfigurationCollect": null,
"waitingRunningConfig": null
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": null,
"id": null,
"startDateTime": null,
"status": null,
"totalCapacityVenue": null
},
"version": { },
"versionAboveTen": { }
}
}
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"tenant": { },
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": "string",
"model": "ICX7150-24",
"slots": [null
],
"taggedPorts": "string",
"tenant": { },
"untaggedPorts": "string",
"vlan": { }
}
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": { },
"switchFirmwareVersionAboveTen": { },
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [{"addr": null,
"pref_len": null
}
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{"activeSwitch": { },
"id": "string",
"insufficientLicense": true,
"model": "string",
"priority": 255,
"tenant": { },
"unitId": 1
}
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": { },
"versionAboveTen": { }
}
}
]
}
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{"acls": [{"aclRules": [{"acl": { },
"action": "permit",
"destination": "string",
"destinationPort": 65535,
"dscpMarking": 0,
"dscpMatching": 0,
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 1,
"source": "string",
"sourcePort": 65535,
"tenant": { }
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": { }
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": { },
"variables": [{"addressType": true,
"id": "string",
"name": "string",
"needUpdate": true,
"value": "string",
"variableName": "string",
"variableType": "ADDRESS"
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": { },
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": { },
"switchFirmwareVersionAboveTen": { },
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [ ],
"ackRemoveStackMember": [ ],
"aclCustomize": null,
"activeId": null,
"activeSwitch": null,
"activeUnitId": null,
"andCheckOnboardType": [ ],
"brandNew": null,
"brandNewCase": null,
"brandNewVeId": null,
"cacheFactoryDefault": null,
"cliApplied": null,
"cloudPort": null,
"collectInterval": null,
"collectIntervalCustomize": null,
"communityString": null,
"configApplying": null,
"connectPort": null,
"defaultGateway": null,
"deployFailInfo": null,
"description": null,
"dhcpClientEnabled": null,
"dhcpServerEnabled": null,
"discovery": null,
"displayOfStack": null,
"dns": null,
"downloadVersion": null,
"enableStack": null,
"extraStatus": null,
"factoryDefault": null,
"familyId": null,
"firmwareUpgrading": null,
"firmwareVersion": null,
"firstJoin": null,
"formedStack": null,
"fromDeviceDiscoveryRequest": null,
"getBackStackCase": null,
"id": null,
"igmpSnooping": null,
"initDns": null,
"initialCli": null,
"initialVlanId": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipAddressType": null,
"ipDhcpClientVeId": null,
"ipFromIpConfigBo": null,
"ipInterfaceByInitialConfig": null,
"is7150Switch": null,
"is7650Switch": null,
"is8200Switch": null,
"isPrimaryDeleted": null,
"isStack": null,
"joinedIpStatus": null,
"joinedIpStatusFullIpSet": null,
"jumboMode": null,
"lastCollectTime": null,
"lastConfigCompleteTime": null,
"lastConfigNotifyTime": null,
"lastConfigStatus": null,
"lastDataSyncTime": null,
"lastDataSyncTriggerTime": null,
"lastOfflineAlarmTime": null,
"lastOfflineTime": null,
"lastOnlineTime": null,
"lastTriggerSyncTime": null,
"memberJoinCase": null,
"mgmtInterfaceEnabled": null,
"migration": null,
"model": null,
"modelFamily": null,
"name": null,
"networkSegmentationId": null,
"notCustomizeVlan": null,
"notOnline": null,
"notSyncedPortConfig": null,
"notSyncedSwitchConfig": null,
"numOfUnits": null,
"offline": null,
"onboardType": null,
"online": null,
"operational": null,
"overwriteCase": null,
"overwriteDoneCase": null,
"policy": null,
"preProvisionStatus": null,
"previousMembers": [ ],
"provisionCase": null,
"provisionDoneCase": null,
"rearModule": null,
"removedIpInterfaceIfChanged": null,
"router": null,
"runningIpAddress": null,
"sendedHostname": null,
"serialNumber": null,
"softDeleted": null,
"softDeletedDate": null,
"spanningTreePriority": null,
"specifiedType": null,
"stack": null,
"stackConfigTimestamp": null,
"stackMember": null,
"stackMembers": [ ],
"stackPriority": null,
"stackUnitIds": null,
"stagingSwitch": null,
"streamingDataInterval": null,
"subnetMask": null,
"supportedCsl": null,
"suspendingDeployTime": null,
"switch": null,
"switchPosition": null,
"switchStatus": null,
"syncedPortConfig": null,
"syncedSwitchConfig": null,
"tags": null,
"tenant": null,
"tenantSync": null,
"trustPorts": [ ],
"unknown": null,
"venue": null,
"vlanCustomize": null,
"waitConfigurationCollectTime": null,
"waitingConfigurationCollect": null,
"waitingRunningConfig": null
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": null,
"id": null,
"startDateTime": null,
"status": null,
"totalCapacityVenue": null
},
"version": { },
"versionAboveTen": { }
}
}
}
],
"regularProfile": true,
"tenant": { },
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"tenant": { },
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": "string",
"model": "ICX7150-24",
"slots": [null
],
"taggedPorts": "string",
"tenant": { },
"untaggedPorts": "string",
"vlan": { }
}
],
"tenant": { },
"vlanId": 1,
"vlanName": "string"
}
]
}
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": { },
"switchFirmwareVersionAboveTen": { },
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [{"addr": null,
"pref_len": null
}
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{"activeSwitch": { },
"id": "string",
"insufficientLicense": true,
"model": "string",
"priority": 255,
"tenant": { },
"unitId": 1
}
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": { },
"versionAboveTen": { }
}
}
]
}
},
"upgradeVenueViewList": [{ }
]
}

Get Versions

Get different version type of firmware.

path Parameters

versionType

required

string

Responses

Response samples

Content type

application/json

[{"category": "RECOMMENDED",
"createdDate": "2019-08-24T14:15:22Z",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string"
}
]

VE Port

Manage VE (Virtual Ethernet) port settings.

Delete VE Settings

Delete multiple virtual ethernet ports.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Delete VE Setting

Delete virtual ethernet port.

path Parameters

vePortId

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get VE Setting

Get particular virtual ethernet port.

path Parameters

vePortId

required

string

Responses

Response samples

Content type

application/json

{"defaultVlan": true,
"dhcpRelayAgent": "string",
"egressAcl": "string",
"id": "string",
"ingressAcl": "string",
"ipAddress": "string",
"ipAddressType": "static",
"ipSubnetMask": "string",
"name": "string",
"ospfArea": "string",
"switchId": "string",
"veId": 0,
"vlanId": 0
}

Update VE Setting

Update virtual ethernet port.

path Parameters

vePortId

required

string

Request Body schema: application/json
required

defaultVlan	boolean
dhcpRelayAgent	string
egressAcl	string
id	string
ifIsDhcpVEDefaultCase	integer <int32>
ingressAcl	string
ipAddress	string
ipAddressType	string Enum: "static" "dynamic"
ipSubnetMask	string
name	string
ospfArea	string
switchId	string
veId	integer <int32>
vlanId	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"defaultVlan": true,
"dhcpRelayAgent": "string",
"egressAcl": "string",
"id": "string",
"ifIsDhcpVEDefaultCase": 0,
"ingressAcl": "string",
"ipAddress": "string",
"ipAddressType": "static",
"ipSubnetMask": "string",
"name": "string",
"ospfArea": "string",
"switchId": "string",
"veId": 0,
"vlanId": 0
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Retrieve VE Settings

Retrieve virtual ethernet ports of particular switch.

path Parameters

switchId

required

string

Responses

Response samples

Content type

application/json

[{"connectedVe": true,
"defaultVlan": true,
"deviceStatus": "string",
"dhcpRelayAgent": "string",
"egressAclName": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"ingressAclName": "string",
"ipAddress": "string",
"ipAddressType": "static",
"ipSubnetMask": "string",
"name": "string",
"ospfArea": "string",
"portType": "NONE",
"stack": true,
"switchId": "string",
"switchName": "string",
"syncedSwitchConfig": true,
"tenantId": "string",
"veId": 0,
"vePortViewList": [{ }
],
"vlanId": 0
}
]

Add VE Settings

Add virtual ethernet ports of the switch.

path Parameters

switchId

required

string

Request Body schema: application/json
required

Array

defaultVlan	boolean
dhcpRelayAgent	string
egressAcl	string
id	string
ifIsDhcpVEDefaultCase	integer <int32>
ingressAcl	string
ipAddress	string
ipAddressType	string Enum: "static" "dynamic"
ipSubnetMask	string
name	string
ospfArea	string
switchId	string
veId	integer <int32>
vlanId	integer <int32>

Responses

Request samples

Payload

Content type

application/json

[{"defaultVlan": true,
"dhcpRelayAgent": "string",
"egressAcl": "string",
"id": "string",
"ifIsDhcpVEDefaultCase": 0,
"ingressAcl": "string",
"ipAddress": "string",
"ipAddressType": "static",
"ipSubnetMask": "string",
"name": "string",
"ospfArea": "string",
"switchId": "string",
"veId": 0,
"vlanId": 0
}
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Retrieve VE Settings

Retrieve virtual ethernet ports of switch by query.

path Parameters

switchId

required

string

Request Body schema: application/json
required

fields	Array of strings
filterType	string
	object
page	integer <int32>
pageSize	integer <int32>
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filterType": "string",
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"page": 0,
"pageSize": 0,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

Content type

application/json

{"data": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"fields": ["string"
],
"id": "string",
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Retrieve VE Settings

Retrieve virtual ethernet ports of venue by query.

path Parameters

venueId

required

string

Request Body schema: application/json
required

fields	Array of strings
filterType	string
	object
page	integer <int32>
pageSize	integer <int32>
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filterType": "string",
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"page": 0,
"pageSize": 0,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

Content type

application/json

{"data": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"fields": ["string"
],
"id": "string",
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Port

Manage Ports.

Get Ports

Get port settings of different switches.

Request Body schema: application/json
required

Array

ports	Array of strings
switchId	string

Responses

Request samples

Payload

Content type

application/json

[{"ports": ["string"
],
"switchId": "string"
}
]

Response samples

Content type

application/json

{"requestId": "string",
"response": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
]
}

Update Ports

Update ports of different switches. Use activity API with request id to get the status update.

Request Body schema: application/json
required

Array

	object (Switch_Service_API_&_Model_Documentation_UpdatePortBo)
switchId	string

Responses

Request samples

Payload

Content type

application/json

[{"port": {"dhcpSnoopingTrust": true,
"egressAcl": "string",
"id": "string",
"ignoreFieldSet": ["string"
],
"ignoreFields": "string",
"ingressAcl": "string",
"ipsg": true,
"lldpEnable": true,
"lldpQos": [{"applicationType": "GUEST_VOICE",
"dscp": 0,
"hasTaggedVlan": true,
"hasUntaggedVlan": true,
"id": "string",
"priority": 0,
"qosVlanType": "PRIORITY_TAGGED",
"vlanId": 0
}
],
"name": "string",
"poeBudget": 0,
"poeCapability": true,
"poeClass": "__NULL",
"poeEnable": true,
"poePriority": 0,
"port": "string",
"portEnable": true,
"portProtected": true,
"portSet": ["string"
],
"portSpeed": "__NULL",
"ports": ["string"
],
"revert": true,
"rstpAdminEdgePort": true,
"stpBpduGuard": true,
"stpRootGuard": true,
"switchSerialNumber": "string",
"taggedVlans": ["string"
],
"tags": "string",
"untaggedVlan": "string",
"voiceVlan": 1
},
"switchId": "string"
}
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Ports

Get switch's port settings by switch id.

path Parameters

switchId

required

string

Responses

Response samples

Content type

application/json

[{"dhcpSnoopingTrust": true,
"egressAcl": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"ignoreFields": "string",
"ingressAcl": "string",
"ipsg": true,
"lag": {"addPorts": ["string"
],
"defaultVlanId": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"lagId": 0,
"lagViewList": [{ }
],
"lastName": "string",
"name": "string",
"originalUntaggedVlan": "string",
"portAddVlans": [{"needRemoveUntaggedDefaultVlan": true,
"portId": "string",
"taggedVlans": ["string"
],
"untaggedVlan": "string"
}
],
"portVlans": [{"needRemoveUntaggedDefaultVlan": true,
"portId": "string",
"taggedVlans": ["string"
],
"untaggedVlan": "string"
}
],
"ports": ["string"
],
"realRemove": true,
"removePorts": ["string"
],
"switchId": "string",
"taggedVlans": ["string"
],
"tenantId": "string",
"type": "static",
"untaggedVlan": "string"
},
"lldpEnable": true,
"lldpQos": [{"applicationType": "GUEST_VOICE",
"dscp": 0,
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"priority": 0,
"qosVlanType": "PRIORITY_TAGGED",
"vlanId": 0
}
],
"name": "string",
"poeBudget": 0.1,
"poeCapability": true,
"poeClass": "__NULL",
"poeEnable": true,
"poePriority": 0,
"port": "string",
"portEnable": true,
"portProtected": true,
"portSpeed": "__NULL",
"ports": ["string"
],
"revert": true,
"rstpAdminEdgePort": true,
"stpBpduGuard": true,
"stpRootGuard": true,
"switchId": "string",
"switchMac": "string",
"taggedVlans": ["string"
],
"tags": "string",
"untaggedVlan": "string",
"voiceVlan": 0
}
]

Get Ports

Get switch's port settings with port ids.

path Parameters

switchId

required

string

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string",
"response": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
]
}

Update Port

Update switch's port setting. Use activity API with request id to get the status update.

path Parameters

switchId

required

string

Request Body schema: application/json
required

dhcpSnoopingTrust	boolean
egressAcl	string
id	string
ignoreFieldSet	Array of strings unique
ignoreFields	string
ingressAcl	string
ipsg	boolean
lldpEnable	boolean
	Array of objects (Switch_Service_API_&_Model_Documentation_LldpQosBo) unique
name	string
poeBudget	integer <int32>
poeCapability	boolean
poeClass	string Enum: "__NULL" "UNSET" "ZERO" "ONE" "TWO" "THREE" "FOUR" "FIVE" "SIX" "SEVEN" "EIGHT"
poeEnable	boolean
poePriority	integer <int32>
port	string^(\d{1,2}/\d{1,2}/\d{1,2})(:\d{1,})?$
portEnable	boolean
portProtected	boolean
portSet	Array of strings unique
portSpeed	string Enum: "__NULL" "UNSET" "NONE" "AUTO" "TEN_M_FULL" "TEN_M_HALF" "ONE_HUNDRED_M_FULL" "ONE_HUNDRED_M_HALF" "ONE_G_FULL" "ONE_G_FULL_MASTER" "ONE_G_FULL_SLAVE" "TWO_POINT_FIVE_G_FULL" "TWO_POINT_FIVE_G_FULL_MASTER" "TWO_POINT_FIVE_G_FULL_SLAVE" "FIVE_G_FULL" "FIVE_G_FULL_MASTER" "FIVE_G_FULL_SLAVE" "TEN_G_FULL" "TEN_G_FULL_MASTER" "TEN_G_FULL_SLAVE" "TWENTY_FIVE_G_FULL" "FORTY_G_FULL" "ONE_HUNDRED_G_FULL" "OPTIC"
ports	Array of strings unique
revert	boolean
rstpAdminEdgePort	boolean
stpBpduGuard	boolean
stpRootGuard	boolean
switchSerialNumber	string
taggedVlans	Array of strings unique
tags	string
untaggedVlan	string
voiceVlan	integer <int32> [ 1 .. 4095 ]

Responses

Request samples

Payload

Content type

application/json

{"dhcpSnoopingTrust": true,
"egressAcl": "string",
"id": "string",
"ignoreFieldSet": ["string"
],
"ignoreFields": "string",
"ingressAcl": "string",
"ipsg": true,
"lldpEnable": true,
"lldpQos": [{"applicationType": "GUEST_VOICE",
"dscp": 0,
"hasTaggedVlan": true,
"hasUntaggedVlan": true,
"id": "string",
"priority": 0,
"qosVlanType": "PRIORITY_TAGGED",
"vlanId": 0
}
],
"name": "string",
"poeBudget": 0,
"poeCapability": true,
"poeClass": "__NULL",
"poeEnable": true,
"poePriority": 0,
"port": "string",
"portEnable": true,
"portProtected": true,
"portSet": ["string"
],
"portSpeed": "__NULL",
"ports": ["string"
],
"revert": true,
"rstpAdminEdgePort": true,
"stpBpduGuard": true,
"stpRootGuard": true,
"switchSerialNumber": "string",
"taggedVlans": ["string"
],
"tags": "string",
"untaggedVlan": "string",
"voiceVlan": 1
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Trusted Port

Manage a port's trust settings.

Delete Trusted Ports

Delete multiple trusted ports of particular switch profile.

path Parameters

switchProfileId

required

string

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Add Trusted Port

Add the trusted port of the switch profile.

path Parameters

switchProfileId

required

string

Request Body schema: application/json
required

id	string
model	string Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C" "ICX7550-24" "ICX7550-48" "ICX7550-24P" "ICX7550-48P" "ICX7550-24ZP" "ICX7550-48ZP" "ICX7550-24F" "ICX7550-48F" "ICX8200-24" "ICX8200-24P" "ICX8200-24F" "ICX8200-24FX" "ICX8200-24ZP" "ICX8200-48" "ICX8200-48F" "ICX8200-48P" "ICX8200-48PF" "ICX8200-48PF2" "ICX8200-48ZP2" "ICX8200-C08P" "ICX8200-C08PDC" "ICX8200-C08PF" "ICX8200-C08PT" "ICX8200-C08ZP"
	object (Switch_Service_API_&_Model_Documentation_Profile)
	Array of objects (Switch_Service_API_&_Model_Documentation_FamilyModelSlotBo) unique
tenantId	string
trustPorts	Array of strings
trustedPortType	string Enum: "all" "dhcp" "arp"
vlanDemand	boolean

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"model": "ICX7150-24",
"profile": {"acls": [{"aclRules": [{"acl": { },
"action": "permit",
"destination": "string",
"destinationPort": 65535,
"dscpMarking": 0,
"dscpMatching": 0,
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 1,
"source": "string",
"sourcePort": 65535,
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
]
}
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
}
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [{"byMergeDeployLogDetail": null,
"cliDeploy": null,
"cliProvisionDeploy": null,
"clis": null,
"collectConf": null,
"configType": null,
"dataSyncFail": null,
"deployExtraStatus": null,
"deployTime": null,
"deployTimeFromFakeResponse": null,
"dispatchConfig": null,
"dispatchConfigBo": null,
"dispatchError": [ ],
"dispatchStatus": null,
"expireTime": null,
"hostnameVariable": null,
"id": null,
"inprogress": null,
"isActiveRole": null,
"notFinalState": null,
"overwriteDeploy": null,
"provisionDeploy": null,
"responseTime": null,
"retryCount": null,
"specificDeploy": null,
"stackDeploy": null,
"startTime": null,
"switchId": null,
"switchName": null,
"tenant": null,
"transactionId": null,
"triggerSyncDeploy": null,
"venueId": null
}
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [null
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{"activeSwitch": null,
"id": null,
"insufficientLicense": null,
"model": null,
"priority": null,
"tenant": null,
"unitId": null
}
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"variables": [{"addressType": true,
"id": "string",
"ipAddressEnd": 0,
"ipAddressStart": 0,
"name": "string",
"needUpdate": true,
"subMaskAndEndIp": ["string"
],
"value": "string",
"variableName": "string",
"variableType": "ADDRESS"
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{ }
]
}
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{ }
]
}
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [{"byMergeDeployLogDetail": { },
"cliDeploy": true,
"cliProvisionDeploy": true,
"clis": "string",
"collectConf": true,
"configType": "PROVISIONING",
"dataSyncFail": true,
"deployExtraStatus": "string",
"deployTime": "2019-08-24T14:15:22Z",
"deployTimeFromFakeResponse": {"configType": null,
"fakeReason": null,
"fakeTimestamp": null,
"operationId": null,
"restconf_response": null,
"switchId": null,
"timestamp": null,
"transactionId": null
},
"dispatchConfig": {"cliTemplateId": null
},
"dispatchConfigBo": {"activeStackConfig": null,
"addDeployConfigs": null,
"changeLogList": [ ],
"cliNotificationType": null,
"configType": null,
"copyConfig": null,
"deployMode": null,
"disconnectCli": null,
"enableDefaultConfig": null,
"extraConfig": null,
"firmwareVersion": null,
"groupOptimization": null,
"hasDefaultVlanConfig": null,
"hasIpConfig": null,
"initialVlanId": null,
"isRouter": null,
"memberStackConfig": null,
"needMarkAsOffline": null,
"needReload": null,
"overwriteStartupConfig": null,
"removeDeployConfigs": null,
"serialNumber": null,
"switchId": null,
"transactionId": null,
"triggerType": null
},
"dispatchError": [null
],
"dispatchStatus": "PENDING",
"expireTime": "2019-08-24T14:15:22Z",
"hostnameVariable": "string",
"id": "string",
"inprogress": true,
"isActiveRole": true,
"notFinalState": true,
"overwriteDeploy": true,
"provisionDeploy": true,
"responseTime": "2019-08-24T14:15:22Z",
"retryCount": 0,
"specificDeploy": true,
"stackDeploy": true,
"startTime": "2019-08-24T14:15:22Z",
"switchId": "string",
"switchName": "string",
"tenant": {"firmwareVersion": null,
"id": null,
"latestBetaVersion": null,
"latestReleaseVersion": null,
"latestReleaseVersionAboveTen": null,
"name": null,
"preDownloadFirmware": null,
"profiles": [ ],
"venues": [ ]
},
"transactionId": "string",
"triggerSyncDeploy": true,
"venueId": "string"
}
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [{"addr": null,
"pref_len": null
}
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{"activeSwitch": { },
"id": "string",
"insufficientLicense": true,
"model": "string",
"priority": 255,
"tenant": {"firmwareVersion": null,
"id": null,
"latestBetaVersion": null,
"latestReleaseVersion": null,
"latestReleaseVersionAboveTen": null,
"name": null,
"preDownloadFirmware": null,
"profiles": [ ],
"venues": [ ]
},
"unitId": 1
}
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{ }
]
},
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{ }
]
},
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{ }
]
},
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{ }
]
}
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{ }
]
}
}
}
}
}
],
"regularProfile": true,
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [{"byMergeDeployLogDetail": { },
"cliDeploy": true,
"cliProvisionDeploy": true,
"clis": "string",
"collectConf": true,
"configType": "PROVISIONING",
"dataSyncFail": true,
"deployExtraStatus": "string",
"deployTime": "2019-08-24T14:15:22Z",
"deployTimeFromFakeResponse": {"configType": null,
"fakeReason": null,
"fakeTimestamp": null,
"operationId": null,
"restconf_response": null,
"switchId": null,
"timestamp": null,
"transactionId": null
},
"dispatchConfig": {"cliTemplateId": null
},
"dispatchConfigBo": {"activeStackConfig": null,
"addDeployConfigs": null,
"changeLogList": [ ],
"cliNotificationType": null,
"configType": null,
"copyConfig": null,
"deployMode": null,
"disconnectCli": null,
"enableDefaultConfig": null,
"extraConfig": null,
"firmwareVersion": null,
"groupOptimization": null,
"hasDefaultVlanConfig": null,
"hasIpConfig": null,
"initialVlanId": null,
"isRouter": null,
"memberStackConfig": null,
"needMarkAsOffline": null,
"needReload": null,
"overwriteStartupConfig": null,
"removeDeployConfigs": null,
"serialNumber": null,
"switchId": null,
"transactionId": null,
"triggerType": null
},
"dispatchError": [null
],
"dispatchStatus": "PENDING",
"expireTime": "2019-08-24T14:15:22Z",
"hostnameVariable": "string",
"id": "string",
"inprogress": true,
"isActiveRole": true,
"notFinalState": true,
"overwriteDeploy": true,
"provisionDeploy": true,
"responseTime": "2019-08-24T14:15:22Z",
"retryCount": 0,
"specificDeploy": true,
"stackDeploy": true,
"startTime": "2019-08-24T14:15:22Z",
"switchId": "string",
"switchName": "string",
"tenant": { },
"transactionId": "string",
"triggerSyncDeploy": true,
"venueId": "string"
}
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [{"addr": null,
"pref_len": null
}
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{"activeSwitch": { },
"id": "string",
"insufficientLicense": true,
"model": "string",
"priority": 255,
"tenant": { },
"unitId": 1
}
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"taggedPorts": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
]
},
"untaggedPorts": "string",
"vlan": { }
}
],
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"vlanId": 1,
"vlanName": "string"
}
]
},
"slots": [{"enable": true,
"id": "string",
"option": "string",
"slotNumber": 0
}
],
"tenantId": "string",
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Delete Trusted Port

Delete the particular trusted port of the switch profile.

path Parameters

switchProfileId required	string
trustedPortId required	string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Trusted Port

Get the particular trusted port of the switch profile.

path Parameters

switchProfileId required	string
trustedPortId required	string

Responses

Response samples

Content type

application/json

{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}

Update Trusted Port

Update the trusted port of the switch profile.

path Parameters

switchProfileId required	string
trustedPortId required	string

Request Body schema: application/json
required

id	string
model	string Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C" "ICX7550-24" "ICX7550-48" "ICX7550-24P" "ICX7550-48P" "ICX7550-24ZP" "ICX7550-48ZP" "ICX7550-24F" "ICX7550-48F" "ICX8200-24" "ICX8200-24P" "ICX8200-24F" "ICX8200-24FX" "ICX8200-24ZP" "ICX8200-48" "ICX8200-48F" "ICX8200-48P" "ICX8200-48PF" "ICX8200-48PF2" "ICX8200-48ZP2" "ICX8200-C08P" "ICX8200-C08PDC" "ICX8200-C08PF" "ICX8200-C08PT" "ICX8200-C08ZP"
	object (Switch_Service_API_&_Model_Documentation_Profile)
	Array of objects (Switch_Service_API_&_Model_Documentation_FamilyModelSlotBo) unique
tenantId	string
trustPorts	Array of strings
trustedPortType	string Enum: "all" "dhcp" "arp"
vlanDemand	boolean

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"model": "ICX7150-24",
"profile": {"acls": [{"aclRules": [{"acl": { },
"action": "permit",
"destination": "string",
"destinationPort": 65535,
"dscpMarking": 0,
"dscpMatching": 0,
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 1,
"source": "string",
"sourcePort": 65535,
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
]
}
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
}
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [{"byMergeDeployLogDetail": null,
"cliDeploy": null,
"cliProvisionDeploy": null,
"clis": null,
"collectConf": null,
"configType": null,
"dataSyncFail": null,
"deployExtraStatus": null,
"deployTime": null,
"deployTimeFromFakeResponse": null,
"dispatchConfig": null,
"dispatchConfigBo": null,
"dispatchError": [ ],
"dispatchStatus": null,
"expireTime": null,
"hostnameVariable": null,
"id": null,
"inprogress": null,
"isActiveRole": null,
"notFinalState": null,
"overwriteDeploy": null,
"provisionDeploy": null,
"responseTime": null,
"retryCount": null,
"specificDeploy": null,
"stackDeploy": null,
"startTime": null,
"switchId": null,
"switchName": null,
"tenant": null,
"transactionId": null,
"triggerSyncDeploy": null,
"venueId": null
}
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [null
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": [null
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": [null
],
"subnetMask": "string",
"ve": [null
],
"vlan": [null
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{"activeSwitch": null,
"id": null,
"insufficientLicense": null,
"model": null,
"priority": null,
"tenant": null,
"unitId": null
}
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"variables": [{"addressType": true,
"id": "string",
"ipAddressEnd": 0,
"ipAddressStart": 0,
"name": "string",
"needUpdate": true,
"subMaskAndEndIp": ["string"
],
"value": "string",
"variableName": "string",
"variableType": "ADDRESS"
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{ }
]
}
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{ }
]
}
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [{"byMergeDeployLogDetail": { },
"cliDeploy": true,
"cliProvisionDeploy": true,
"clis": "string",
"collectConf": true,
"configType": "PROVISIONING",
"dataSyncFail": true,
"deployExtraStatus": "string",
"deployTime": "2019-08-24T14:15:22Z",
"deployTimeFromFakeResponse": {"configType": null,
"fakeReason": null,
"fakeTimestamp": null,
"operationId": null,
"restconf_response": null,
"switchId": null,
"timestamp": null,
"transactionId": null
},
"dispatchConfig": {"cliTemplateId": null
},
"dispatchConfigBo": {"activeStackConfig": null,
"addDeployConfigs": null,
"changeLogList": [ ],
"cliNotificationType": null,
"configType": null,
"copyConfig": null,
"deployMode": null,
"disconnectCli": null,
"enableDefaultConfig": null,
"extraConfig": null,
"firmwareVersion": null,
"groupOptimization": null,
"hasDefaultVlanConfig": null,
"hasIpConfig": null,
"initialVlanId": null,
"isRouter": null,
"memberStackConfig": null,
"needMarkAsOffline": null,
"needReload": null,
"overwriteStartupConfig": null,
"removeDeployConfigs": null,
"serialNumber": null,
"switchId": null,
"transactionId": null,
"triggerType": null
},
"dispatchError": [null
],
"dispatchStatus": "PENDING",
"expireTime": "2019-08-24T14:15:22Z",
"hostnameVariable": "string",
"id": "string",
"inprogress": true,
"isActiveRole": true,
"notFinalState": true,
"overwriteDeploy": true,
"provisionDeploy": true,
"responseTime": "2019-08-24T14:15:22Z",
"retryCount": 0,
"specificDeploy": true,
"stackDeploy": true,
"startTime": "2019-08-24T14:15:22Z",
"switchId": "string",
"switchName": "string",
"tenant": {"firmwareVersion": null,
"id": null,
"latestBetaVersion": null,
"latestReleaseVersion": null,
"latestReleaseVersionAboveTen": null,
"name": null,
"preDownloadFirmware": null,
"profiles": [ ],
"venues": [ ]
},
"transactionId": "string",
"triggerSyncDeploy": true,
"venueId": "string"
}
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [{"addr": null,
"pref_len": null
}
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{"activeSwitch": { },
"id": "string",
"insufficientLicense": true,
"model": "string",
"priority": 255,
"tenant": {"firmwareVersion": null,
"id": null,
"latestBetaVersion": null,
"latestReleaseVersion": null,
"latestReleaseVersionAboveTen": null,
"name": null,
"preDownloadFirmware": null,
"profiles": [ ],
"venues": [ ]
},
"unitId": 1
}
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{ }
]
},
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{ }
]
},
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{ }
]
},
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{ }
]
}
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{ }
]
}
}
}
}
}
],
"regularProfile": true,
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": ["string"
],
"ackRemoveStackMember": ["string"
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [{"byMergeDeployLogDetail": { },
"cliDeploy": true,
"cliProvisionDeploy": true,
"clis": "string",
"collectConf": true,
"configType": "PROVISIONING",
"dataSyncFail": true,
"deployExtraStatus": "string",
"deployTime": "2019-08-24T14:15:22Z",
"deployTimeFromFakeResponse": {"configType": null,
"fakeReason": null,
"fakeTimestamp": null,
"operationId": null,
"restconf_response": null,
"switchId": null,
"timestamp": null,
"transactionId": null
},
"dispatchConfig": {"cliTemplateId": null
},
"dispatchConfigBo": {"activeStackConfig": null,
"addDeployConfigs": null,
"changeLogList": [ ],
"cliNotificationType": null,
"configType": null,
"copyConfig": null,
"deployMode": null,
"disconnectCli": null,
"enableDefaultConfig": null,
"extraConfig": null,
"firmwareVersion": null,
"groupOptimization": null,
"hasDefaultVlanConfig": null,
"hasIpConfig": null,
"initialVlanId": null,
"isRouter": null,
"memberStackConfig": null,
"needMarkAsOffline": null,
"needReload": null,
"overwriteStartupConfig": null,
"removeDeployConfigs": null,
"serialNumber": null,
"switchId": null,
"transactionId": null,
"triggerType": null
},
"dispatchError": [null
],
"dispatchStatus": "PENDING",
"expireTime": "2019-08-24T14:15:22Z",
"hostnameVariable": "string",
"id": "string",
"inprogress": true,
"isActiveRole": true,
"notFinalState": true,
"overwriteDeploy": true,
"provisionDeploy": true,
"responseTime": "2019-08-24T14:15:22Z",
"retryCount": 0,
"specificDeploy": true,
"stackDeploy": true,
"startTime": "2019-08-24T14:15:22Z",
"switchId": "string",
"switchName": "string",
"tenant": { },
"transactionId": "string",
"triggerSyncDeploy": true,
"venueId": "string"
}
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": "PROVISIONING"
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": "string",
"cslVersion": 0.1,
"extIp": "string",
"factoryDefault": true,
"fwVersion": "string",
"ip": "string",
"ipv6List": [{"addr": null,
"pref_len": null
}
],
"mac": "string",
"model": "string",
"modelFamily": "__NULL",
"name": "string",
"numOfUnits": 0,
"physical": true,
"serial": "string",
"switchStackSpx": "string",
"tenantId": "string",
"timestamp": 0,
"type": "WIFI",
"vlanCount": 0
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": "string",
"id": "string",
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressType": "static",
"serialNumber": "string",
"subnetMask": "string"
},
"ipInterfaceByInitialConfig": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": ["string"
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": "string",
"dns": ["string"
],
"dnsJoinComma": "string",
"hasBeenObtainedTheCorrectDefaultGateway": true,
"hasBeenObtainedTheCorrectIPAddressConfig": true,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipDhcpClientVeId": "string",
"ipInterfaceChanged": true,
"ipInterfaceOnManagement": true,
"ipInterfaceOnPort": true,
"ipInterfaceOnVE": true,
"ipInterfaceVeId": 0,
"originalIpAddressInterface": "string",
"originalIpAddressInterfaceNewIpAddress": "string",
"originalIpAddressInterfaceNewSubnetMask": "string",
"originalIpAddressInterfaceType": "NONE",
"originalIpInterface": true,
"removedIpAddressInterface": "string",
"removedIpAddressInterfaceType": "NONE",
"removedIpInterfaceOnManagement": true,
"removedIpInterfaceOnPort": true,
"removedIpInterfaceOnVE": true,
"staticOrDynamic": "string",
"staticRoute": ["string"
],
"subnetMask": "string",
"ve": ["string"
],
"vlan": ["string"
],
"wrongConfig": true
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [{"activeSwitch": { },
"id": "string",
"insufficientLicense": true,
"model": "string",
"priority": 255,
"tenant": { },
"unitId": 1
}
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": ["string"
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"taggedPorts": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
]
},
"untaggedPorts": "string",
"vlan": { }
}
],
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"vlanId": 1,
"vlanName": "string"
}
]
},
"slots": [{"enable": true,
"id": "string",
"option": "string",
"slotNumber": 0
}
],
"tenantId": "string",
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Trusted Ports

Retrieve trusted ports with particular venue.

path Parameters

venueId

required

string

Responses

Response samples

Content type

application/json

[{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
]

DHCP Server

Manage ICX DHCP servers.

Query DHCP Servers

List of venue's DHCP servers.

Request Body schema: application/json
required

fields	Array of strings
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string Enum: "ASC" "DESC"
venueId	string

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "ASC",
"venueId": "string"
}

Response samples

Content type

application/json

{"data": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"fields": ["string"
],
"id": "string",
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Get DHCP Server-Setting

Get switch's DHCP server setting.

path Parameters

dhcpServerId

required

string

Responses

Response samples

Content type

application/json

{"defaultRouterIp": "string",
"dhcpOptions": [{"seq": 0,
"type": "ASCII",
"value": "string"
}
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"excludedEnd": "string",
"excludedStart": "string",
"id": "string",
"leaseDays": 0,
"leaseHrs": 0,
"leaseMins": 0,
"network": "string",
"poolName": "string",
"subnetAddress": "string",
"subnetMask": "string"
}

Update DHCP Server

Change switch's DHCP server state. Use activity API with request id to get the status update.

path Parameters

switchId

required

string

Request Body schema: application/json
required

state

boolean

Responses

Request samples

Payload

Content type

application/json

{"state": true
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Delete DHCP Servers

Delete switch's DHCP servers.

path Parameters

switchId

required

string

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Add DHCP Server

Add switch's DHCP server settings. Use activity API with request id to get the status update.

path Parameters

switchId

required

string

Request Body schema: application/json
required

defaultRouterIp	string
	Array of objects (Switch_Service_API_&_Model_Documentation_DhcpOptionBo)
dhcpServerEnabled	boolean
excludedEnd	string
excludedStart	string
id	string
leaseDays	integer <int32>
leaseHrs	integer <int32>
leaseMins	integer <int32>
network	string
poolName	string
prefixLength	string
subnetAddress	string^(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\...
subnetMask	string^(?:(?:(?:255\.){3}(?:252\|248\|240\|224\|192\|128...
switchId	string

Responses

Request samples

Payload

Content type

application/json

{"defaultRouterIp": "string",
"dhcpOptions": [{"seq": 0,
"type": "ASCII",
"value": "string"
}
],
"dhcpServerEnabled": true,
"excludedEnd": "string",
"excludedStart": "string",
"id": "string",
"leaseDays": 0,
"leaseHrs": 0,
"leaseMins": 0,
"network": "string",
"poolName": "string",
"prefixLength": "string",
"subnetAddress": "string",
"subnetMask": "string",
"switchId": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Update DHCP Server-Setting

Update switch's DHCP server setting.

path Parameters

switchId

required

string

Request Body schema: application/json
required

defaultRouterIp	string
	Array of objects (Switch_Service_API_&_Model_Documentation_DhcpOptionBo)
dhcpServerEnabled	boolean
excludedEnd	string
excludedStart	string
id	string
leaseDays	integer <int32>
leaseHrs	integer <int32>
leaseMins	integer <int32>
network	string
poolName	string
prefixLength	string
subnetAddress	string^(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\...
subnetMask	string^(?:(?:(?:255\.){3}(?:252\|248\|240\|224\|192\|128...
switchId	string

Responses

Request samples

Payload

Content type

application/json

{"defaultRouterIp": "string",
"dhcpOptions": [{"seq": 0,
"type": "ASCII",
"value": "string"
}
],
"dhcpServerEnabled": true,
"excludedEnd": "string",
"excludedStart": "string",
"id": "string",
"leaseDays": 0,
"leaseHrs": 0,
"leaseMins": 0,
"network": "string",
"poolName": "string",
"prefixLength": "string",
"subnetAddress": "string",
"subnetMask": "string",
"switchId": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get DHCP Servers Lease Table

Get switch's DHCP server lease table.

path Parameters

switchId

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Query DHCP Servers

List of ICX's DHCP servers.

path Parameters

switchId

required

string

Request Body schema: application/json
required

fields	Array of strings
page	integer <int32>
pageSize	integer <int32>
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string Enum: "ASC" "DESC"
venueId	string

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"page": 0,
"pageSize": 0,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "ASC",
"venueId": "string"
}

Response samples

Content type

application/json

{"data": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"fields": ["string"
],
"id": "string",
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Delete DHCP Server-Setting

Delete switch's DHCP server setting.

path Parameters

switchId required	string
dhcpServerId required	string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

ACL

Manage switch ACLs (access control lists).

Get ACL

Get the ACL of the switch.

path Parameters

aclId

required

string

Responses

Response samples

Content type

application/json

{"aclRules": [{"action": "permit",
"destination": "string",
"destinationPort": 0,
"dscpMarking": 0,
"dscpMatching": 0,
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 0,
"source": "string",
"sourcePort": 0
}
],
"aclType": "standard",
"aclViewList": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string"
}

Get ACL Union

List all usable ACLs for this switch (the union of venue and device levels).

path Parameters

switchId

required

string

Responses

Response samples

Content type

application/json

{"profileAcl": ["string"
],
"switchAcl": ["string"
]
}

Get ACLs

Get all ACLs of the switch.

path Parameters

switchId

required

string

Responses

Response samples

Content type

application/json

[{"aclRules": [{"action": "permit",
"destination": "string",
"destinationPort": 0,
"dscpMarking": 0,
"dscpMatching": 0,
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 0,
"source": "string",
"sourcePort": 0
}
],
"aclType": "standard",
"aclViewList": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string"
}
]

Retrieve ACLs

Query the switchâs switch-level ACLs.

path Parameters

switchId

required

string

Request Body schema: application/json
required

fields	Array of strings
filterType	string
	object
page	integer <int32>
pageSize	integer <int32>
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filterType": "string",
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"page": 0,
"pageSize": 0,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

Content type

application/json

{"data": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"fields": ["string"
],
"id": "string",
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Profile

Manage switch profiles.

Delete Switch Profiles

Delete multiple regular switch profiles or command-line interface profiles.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Switch Profiles

Get multiple regular switch profiles or command-line interface profiles.

Responses

Response samples

Content type

application/json

[{"acls": [{"aclRules": [{"action": "permit",
"destination": "string",
"destinationPort": 0,
"dscpMarking": 0,
"dscpMatching": 0,
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
],
"suppressed": [{"localizedMessage": null,
"message": null,
"stackTrace": [ ]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{ }
]
}
]
},
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 0,
"source": "string",
"sourcePort": 0
}
],
"aclType": "standard",
"aclViewList": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string"
}
],
"description": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string",
"profileType": "Regular",
"trustedPorts": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venueCliTemplate": {"cli": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string",
"overwrite": true,
"switchModels": "string",
"variables": [{"name": "string",
"type": "ADDRESS",
"value": "string"
}
]
},
"venueCount": 0,
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 0,
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 0,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
],
"suppressed": [{"localizedMessage": null,
"message": null,
"stackTrace": [ ]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{ }
]
}
]
},
"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"taggedPorts": "string",
"untaggedPorts": "string"
}
],
"vlanId": 0,
"vlanName": "string"
}
]
}
]

Add Switch Profile

Add a regular switch profile or command-line interface profile. Use activity API with request id to get the status update.

Request Body schema: application/json
required

	Array of objects (Switch_Service_API_&_Model_Documentation_AclBo) unique
description	string
id	string
name	string^.{1,64}$
profileType	string Enum: "Regular" "CLI"
regularProfile	boolean
	Array of objects (Switch_Service_API_&_Model_Documentation_TrustedPortBo) unique
	object (Switch_Service_API_&_Model_Documentation_AcxVenueCliTemplateBo)
venues	Array of strings
	Array of objects (Switch_Service_API_&_Model_Documentation_VlanBo) unique

Responses

Request samples

Payload

Content type

application/json

{"acls": [{"aclRules": [{"action": "permit",
"destination": "string",
"destinationPort": "string",
"dscpMarking": 0,
"dscpMatching": 0,
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 0,
"source": "string",
"sourcePort": "string",
"typeIp": true
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"switchId": "string"
}
],
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"regularProfile": true,
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": {"acls": [{"aclRules": [{"acl": { },
"action": "permit",
"destination": "string",
"destinationPort": 65535,
"dscpMarking": 0,
"dscpMatching": 0,
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 1,
"source": "string",
"sourcePort": 65535,
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
}
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
]
}
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [ ],
"ackRemoveStackMember": [ ],
"aclCustomize": null,
"activeId": null,
"activeSwitch": null,
"activeUnitId": null,
"andCheckOnboardType": [ ],
"brandNew": null,
"brandNewCase": null,
"brandNewVeId": null,
"cacheFactoryDefault": null,
"cliApplied": null,
"cloudPort": null,
"collectInterval": null,
"collectIntervalCustomize": null,
"communityString": null,
"configApplying": null,
"connectPort": null,
"defaultGateway": null,
"deployFailInfo": null,
"description": null,
"dhcpClientEnabled": null,
"dhcpServerEnabled": null,
"discovery": null,
"displayOfStack": null,
"dns": null,
"downloadVersion": null,
"enableStack": null,
"extraStatus": null,
"factoryDefault": null,
"familyId": null,
"firmwareUpgrading": null,
"firmwareVersion": null,
"firstJoin": null,
"formedStack": null,
"fromDeviceDiscoveryRequest": null,
"getBackStackCase": null,
"id": null,
"igmpSnooping": null,
"initDns": null,
"initialCli": null,
"initialVlanId": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipAddressType": null,
"ipDhcpClientVeId": null,
"ipFromIpConfigBo": null,
"ipInterfaceByInitialConfig": null,
"is7150Switch": null,
"is7650Switch": null,
"is8200Switch": null,
"isPrimaryDeleted": null,
"isStack": null,
"joinedIpStatus": null,
"joinedIpStatusFullIpSet": null,
"jumboMode": null,
"lastCollectTime": null,
"lastConfigCompleteTime": null,
"lastConfigNotifyTime": null,
"lastConfigStatus": null,
"lastDataSyncTime": null,
"lastDataSyncTriggerTime": null,
"lastOfflineAlarmTime": null,
"lastOfflineTime": null,
"lastOnlineTime": null,
"lastTriggerSyncTime": null,
"memberJoinCase": null,
"mgmtInterfaceEnabled": null,
"migration": null,
"model": null,
"modelFamily": null,
"name": null,
"networkSegmentationId": null,
"notCustomizeVlan": null,
"notOnline": null,
"notSyncedPortConfig": null,
"notSyncedSwitchConfig": null,
"numOfUnits": null,
"offline": null,
"onboardType": null,
"online": null,
"operational": null,
"overwriteCase": null,
"overwriteDoneCase": null,
"policy": null,
"preProvisionStatus": null,
"previousMembers": [ ],
"provisionCase": null,
"provisionDoneCase": null,
"rearModule": null,
"removedIpInterfaceIfChanged": null,
"router": null,
"runningIpAddress": null,
"sendedHostname": null,
"serialNumber": null,
"softDeleted": null,
"softDeletedDate": null,
"spanningTreePriority": null,
"specifiedType": null,
"stack": null,
"stackConfigTimestamp": null,
"stackMember": null,
"stackMembers": [ ],
"stackPriority": null,
"stackUnitIds": null,
"stagingSwitch": null,
"streamingDataInterval": null,
"subnetMask": null,
"supportedCsl": null,
"suspendingDeployTime": null,
"switch": null,
"switchPosition": null,
"switchStatus": null,
"syncedPortConfig": null,
"syncedSwitchConfig": null,
"tags": null,
"tenant": null,
"tenantSync": null,
"trustPorts": [ ],
"unknown": null,
"venue": null,
"vlanCustomize": null,
"waitConfigurationCollectTime": null,
"waitingConfigurationCollect": null,
"waitingRunningConfig": null
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": null,
"id": null,
"startDateTime": null,
"status": null,
"totalCapacityVenue": null
},
"version": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"versionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
}
}
}
]
},
"variables": [{"addressType": true,
"id": "string",
"ipAddressEnd": 0,
"ipAddressStart": 0,
"name": "string",
"needUpdate": true,
"subMaskAndEndIp": ["string"
],
"value": "string",
"variableName": "string",
"variableType": "ADDRESS"
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
]
},
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
}
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
}
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": {"firmwareVersion": null,
"id": null,
"latestBetaVersion": null,
"latestReleaseVersion": null,
"latestReleaseVersionAboveTen": null,
"name": null,
"preDownloadFirmware": null,
"profiles": [ ],
"venues": [ ]
},
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{ }
]
},
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
},
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": null,
"id": null,
"latestBetaVersion": null,
"latestReleaseVersion": null,
"latestReleaseVersionAboveTen": null,
"name": null,
"preDownloadFirmware": null,
"profiles": [ ],
"venues": [ ]
}
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": null,
"id": null,
"latestBetaVersion": null,
"latestReleaseVersion": null,
"latestReleaseVersionAboveTen": null,
"name": null,
"preDownloadFirmware": null,
"profiles": [ ],
"venues": [ ]
}
}
}
}
}
],
"regularProfile": true,
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
]
},
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": null,
"option": null,
"slotNumber": null
}
],
"taggedPorts": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
},
"untaggedPorts": "string",
"vlan": { }
}
],
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
]
},
"vlanId": 1,
"vlanName": "string"
}
]
},
"slots": [{"enable": true,
"id": "string",
"option": "string",
"slotNumber": 0
}
],
"tenantId": "string",
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModels": "string",
"variables": [{"cliTemplateType": "CLI_TEMPLATE_PROVISION",
"currentRangeValue": {"acquire": 0,
"andDecrement": 0,
"andIncrement": 0,
"opaque": 0,
"plain": 0,
"release": 0
},
"endIpAddress": "string",
"id": "string",
"ipAddress": "string",
"name": "string",
"needUpdate": true,
"rangeEnd": 0,
"rangeStart": 0,
"subMask": "string",
"switchId": "string",
"type": "ADDRESS",
"value": "string"
}
]
},
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"arpInspectionTrustPortList": ["string"
],
"arpTrustPortsList": ["string"
],
"defaultVlan": true,
"dhcpTrustPortsList": ["string"
],
"dummyVlan": true,
"enableAsDefaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"igmpSnoopingTypeChanged": true,
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"ipv4DhcpSnoopingTrustPortList": ["string"
],
"managementVlan": true,
"multicastVersion": 3,
"notDummyVlan": true,
"rapidSpanningTreeProtocol": true,
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"id": "string",
"option": "string",
"slotNumber": 0
}
],
"switchId": "string",
"taggedPorts": "string",
"untaggedPorts": "string"
}
],
"switchId": "string",
"switchVlanPortModel": {"id": "string",
"switchModel": "ICX7150-24",
"taggedPorts": "string",
"taggedPortsList": ["string"
],
"untaggedPorts": "string",
"untaggedPortsList": ["string"
]
},
"switchVlanPortModels": [{"id": "string",
"switchModel": "ICX7150-24",
"taggedPorts": "string",
"taggedPortsList": ["string"
],
"untaggedPorts": "string",
"untaggedPortsList": ["string"
]
}
],
"taggedPortsList": ["string"
],
"untaggedPortsList": ["string"
],
"vlanId": 1,
"vlanName": "string"
}
]
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Query Switch Profiles

List the regular switch profiles or command-line interface profiles.

Request Body schema: application/json
required

fields	Array of strings
filterType	string
	object
page	integer <int32>
pageSize	integer <int32>
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filterType": "string",
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"page": 0,
"pageSize": 0,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

Content type

application/json

{"data": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"fields": ["string"
],
"id": "string",
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Delete Switch Profile

Delete a regular switch profile or command-line interface profile.

path Parameters

switchProfileId

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Switch Profile

Get a regular switch profile or command-line interface profile.

path Parameters

switchProfileId

required

string

Responses

Response samples

Content type

application/json

{"acls": [{"aclRules": [{"action": "permit",
"destination": "string",
"destinationPort": 0,
"dscpMarking": 0,
"dscpMatching": 0,
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{ }
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 0,
"source": "string",
"sourcePort": 0
}
],
"aclType": "standard",
"aclViewList": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string"
}
],
"description": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string",
"profileType": "Regular",
"trustedPorts": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venueCliTemplate": {"cli": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string",
"overwrite": true,
"switchModels": "string",
"variables": [{"name": "string",
"type": "ADDRESS",
"value": "string"
}
]
},
"venueCount": 0,
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 0,
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 0,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{ }
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"taggedPorts": "string",
"untaggedPorts": "string"
}
],
"vlanId": 0,
"vlanName": "string"
}
]
}

Update Switch Profile

Update a regular switch profile or command-line interface profile. Use activity API with request id to get the status update.

path Parameters

switchProfileId

required

string

Request Body schema: application/json
required

	Array of objects (Switch_Service_API_&_Model_Documentation_AclBo) unique
description	string
id	string
name	string^.{1,64}$
profileType	string Enum: "Regular" "CLI"
regularProfile	boolean
	Array of objects (Switch_Service_API_&_Model_Documentation_TrustedPortBo) unique
	object (Switch_Service_API_&_Model_Documentation_AcxVenueCliTemplateBo)
venues	Array of strings
	Array of objects (Switch_Service_API_&_Model_Documentation_VlanBo) unique

Responses

Request samples

Payload

Content type

application/json

{"acls": [{"aclRules": [{"action": "permit",
"destination": "string",
"destinationPort": "string",
"dscpMarking": 0,
"dscpMatching": 0,
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 0,
"source": "string",
"sourcePort": "string",
"typeIp": true
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"switchId": "string"
}
],
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"regularProfile": true,
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": {"acls": [{"aclRules": [{"acl": { },
"action": "permit",
"destination": "string",
"destinationPort": 65535,
"dscpMarking": 0,
"dscpMatching": 0,
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 1,
"source": "string",
"sourcePort": 65535,
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
}
}
],
"aclType": "standard",
"id": "string",
"name": "string",
"profile": { },
"profileId": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
]
}
}
],
"acxCliProfile": true,
"acxVenueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModelArray": ["string"
],
"switchModels": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [ ],
"ackRemoveStackMember": [ ],
"aclCustomize": null,
"activeId": null,
"activeSwitch": null,
"activeUnitId": null,
"andCheckOnboardType": [ ],
"brandNew": null,
"brandNewCase": null,
"brandNewVeId": null,
"cacheFactoryDefault": null,
"cliApplied": null,
"cloudPort": null,
"collectInterval": null,
"collectIntervalCustomize": null,
"communityString": null,
"configApplying": null,
"connectPort": null,
"defaultGateway": null,
"deployFailInfo": null,
"description": null,
"dhcpClientEnabled": null,
"dhcpServerEnabled": null,
"discovery": null,
"displayOfStack": null,
"dns": null,
"downloadVersion": null,
"enableStack": null,
"extraStatus": null,
"factoryDefault": null,
"familyId": null,
"firmwareUpgrading": null,
"firmwareVersion": null,
"firstJoin": null,
"formedStack": null,
"fromDeviceDiscoveryRequest": null,
"getBackStackCase": null,
"id": null,
"igmpSnooping": null,
"initDns": null,
"initialCli": null,
"initialVlanId": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipAddressType": null,
"ipDhcpClientVeId": null,
"ipFromIpConfigBo": null,
"ipInterfaceByInitialConfig": null,
"is7150Switch": null,
"is7650Switch": null,
"is8200Switch": null,
"isPrimaryDeleted": null,
"isStack": null,
"joinedIpStatus": null,
"joinedIpStatusFullIpSet": null,
"jumboMode": null,
"lastCollectTime": null,
"lastConfigCompleteTime": null,
"lastConfigNotifyTime": null,
"lastConfigStatus": null,
"lastDataSyncTime": null,
"lastDataSyncTriggerTime": null,
"lastOfflineAlarmTime": null,
"lastOfflineTime": null,
"lastOnlineTime": null,
"lastTriggerSyncTime": null,
"memberJoinCase": null,
"mgmtInterfaceEnabled": null,
"migration": null,
"model": null,
"modelFamily": null,
"name": null,
"networkSegmentationId": null,
"notCustomizeVlan": null,
"notOnline": null,
"notSyncedPortConfig": null,
"notSyncedSwitchConfig": null,
"numOfUnits": null,
"offline": null,
"onboardType": null,
"online": null,
"operational": null,
"overwriteCase": null,
"overwriteDoneCase": null,
"policy": null,
"preProvisionStatus": null,
"previousMembers": [ ],
"provisionCase": null,
"provisionDoneCase": null,
"rearModule": null,
"removedIpInterfaceIfChanged": null,
"router": null,
"runningIpAddress": null,
"sendedHostname": null,
"serialNumber": null,
"softDeleted": null,
"softDeletedDate": null,
"spanningTreePriority": null,
"specifiedType": null,
"stack": null,
"stackConfigTimestamp": null,
"stackMember": null,
"stackMembers": [ ],
"stackPriority": null,
"stackUnitIds": null,
"stagingSwitch": null,
"streamingDataInterval": null,
"subnetMask": null,
"supportedCsl": null,
"suspendingDeployTime": null,
"switch": null,
"switchPosition": null,
"switchStatus": null,
"syncedPortConfig": null,
"syncedSwitchConfig": null,
"tags": null,
"tenant": null,
"tenantSync": null,
"trustPorts": [ ],
"unknown": null,
"venue": null,
"vlanCustomize": null,
"waitConfigurationCollectTime": null,
"waitingConfigurationCollect": null,
"waitingRunningConfig": null
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": null,
"id": null,
"startDateTime": null,
"status": null,
"totalCapacityVenue": null
},
"version": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"versionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
}
}
}
]
},
"variables": [{"addressType": true,
"id": "string",
"ipAddressEnd": 0,
"ipAddressStart": 0,
"name": "string",
"needUpdate": true,
"subMaskAndEndIp": ["string"
],
"value": "string",
"variableName": "string",
"variableType": "ADDRESS"
}
]
},
"cliProfile": true,
"description": "string",
"id": "string",
"name": "string",
"profileType": "Regular",
"profileVenues": [{"id": "string",
"profile": { },
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
]
},
"venue": {"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
}
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": { },
"latestReleaseVersion": { },
"latestReleaseVersionAboveTen": { },
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
}
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": {"firmwareVersion": null,
"id": null,
"latestBetaVersion": null,
"latestReleaseVersion": null,
"latestReleaseVersionAboveTen": null,
"name": null,
"preDownloadFirmware": null,
"profiles": [ ],
"venues": [ ]
},
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{ }
]
},
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
},
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": null,
"id": null,
"latestBetaVersion": null,
"latestReleaseVersion": null,
"latestReleaseVersionAboveTen": null,
"name": null,
"preDownloadFirmware": null,
"profiles": [ ],
"venues": [ ]
}
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": {"firmwareVersion": null,
"id": null,
"latestBetaVersion": null,
"latestReleaseVersion": null,
"latestReleaseVersionAboveTen": null,
"name": null,
"preDownloadFirmware": null,
"profiles": [ ],
"venues": [ ]
}
}
}
}
}
],
"regularProfile": true,
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": ["string"
],
"dnsList": ["string"
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": ["string"
],
"switchFirmwareVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchFirmwareVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [{"ackAddStackMember": [null
],
"ackRemoveStackMember": [null
],
"aclCustomize": true,
"activeId": "string",
"activeSwitch": true,
"activeUnitId": "string",
"andCheckOnboardType": [null
],
"brandNew": true,
"brandNewCase": true,
"brandNewVeId": "string",
"cacheFactoryDefault": true,
"cliApplied": true,
"cloudPort": "string",
"collectInterval": 0,
"collectIntervalCustomize": 0,
"communityString": "string",
"configApplying": true,
"connectPort": true,
"defaultGateway": "string",
"deployFailInfo": {"configType": null
},
"description": "string",
"dhcpClientEnabled": true,
"dhcpServerEnabled": true,
"discovery": true,
"displayOfStack": "string",
"dns": "string",
"downloadVersion": "string",
"enableStack": true,
"extraStatus": "NONE",
"factoryDefault": true,
"familyId": "__NULL",
"firmwareUpgrading": true,
"firmwareVersion": "string",
"firstJoin": true,
"formedStack": true,
"fromDeviceDiscoveryRequest": {"cloudPort": null,
"cslVersion": null,
"extIp": null,
"factoryDefault": null,
"fwVersion": null,
"ip": null,
"ipv6List": [ ],
"mac": null,
"model": null,
"modelFamily": null,
"name": null,
"numOfUnits": null,
"physical": null,
"serial": null,
"switchStackSpx": null,
"tenantId": null,
"timestamp": null,
"type": null,
"vlanCount": null
},
"getBackStackCase": true,
"id": "string",
"igmpSnooping": "active",
"initDns": "string",
"initialCli": "string",
"initialVlanId": 1,
"ipAddress": "string",
"ipAddressInterface": "string",
"ipAddressInterfaceType": "NONE",
"ipAddressType": "static",
"ipDhcpClientVeId": "string",
"ipFromIpConfigBo": {"defaultGateway": null,
"id": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressType": null,
"serialNumber": null,
"subnetMask": null
},
"ipInterfaceByInitialConfig": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"is7150Switch": true,
"is7650Switch": true,
"is8200Switch": true,
"isPrimaryDeleted": true,
"isStack": true,
"joinedIpStatus": "NONE",
"joinedIpStatusFullIpSet": true,
"jumboMode": true,
"lastCollectTime": "2019-08-24T14:15:22Z",
"lastConfigCompleteTime": "2019-08-24T14:15:22Z",
"lastConfigNotifyTime": "2019-08-24T14:15:22Z",
"lastConfigStatus": "SUCCESS",
"lastDataSyncTime": 0,
"lastDataSyncTriggerTime": 0,
"lastOfflineAlarmTime": "2019-08-24T14:15:22Z",
"lastOfflineTime": "2019-08-24T14:15:22Z",
"lastOnlineTime": "2019-08-24T14:15:22Z",
"lastTriggerSyncTime": "2019-08-24T14:15:22Z",
"memberJoinCase": true,
"mgmtInterfaceEnabled": true,
"migration": true,
"model": "ICX7150-24",
"modelFamily": "string",
"name": "string",
"networkSegmentationId": "string",
"notCustomizeVlan": true,
"notOnline": true,
"notSyncedPortConfig": true,
"notSyncedSwitchConfig": true,
"numOfUnits": 0,
"offline": true,
"onboardType": "PROVISION",
"online": true,
"operational": true,
"overwriteCase": true,
"overwriteDoneCase": true,
"policy": "PENDING",
"preProvisionStatus": true,
"previousMembers": [null
],
"provisionCase": true,
"provisionDoneCase": true,
"rearModule": "stack-40g",
"removedIpInterfaceIfChanged": {"defaultGateway": null,
"dns": [ ],
"dnsJoinComma": null,
"hasBeenObtainedTheCorrectDefaultGateway": null,
"hasBeenObtainedTheCorrectIPAddressConfig": null,
"ipAddress": null,
"ipAddressInterface": null,
"ipAddressInterfaceType": null,
"ipDhcpClientVeId": null,
"ipInterfaceChanged": null,
"ipInterfaceOnManagement": null,
"ipInterfaceOnPort": null,
"ipInterfaceOnVE": null,
"ipInterfaceVeId": null,
"originalIpAddressInterface": null,
"originalIpAddressInterfaceNewIpAddress": null,
"originalIpAddressInterfaceNewSubnetMask": null,
"originalIpAddressInterfaceType": null,
"originalIpInterface": null,
"removedIpAddressInterface": null,
"removedIpAddressInterfaceType": null,
"removedIpInterfaceOnManagement": null,
"removedIpInterfaceOnPort": null,
"removedIpInterfaceOnVE": null,
"staticOrDynamic": null,
"staticRoute": [ ],
"subnetMask": null,
"ve": [ ],
"vlan": [ ],
"wrongConfig": null
},
"router": true,
"runningIpAddress": "string",
"sendedHostname": true,
"serialNumber": "string",
"softDeleted": true,
"softDeletedDate": "2019-08-24T14:15:22Z",
"spanningTreePriority": 65535,
"specifiedType": "AUTO",
"stack": true,
"stackConfigTimestamp": "string",
"stackMember": true,
"stackMembers": [null
],
"stackPriority": 255,
"stackUnitIds": "string",
"stagingSwitch": "Staging",
"streamingDataInterval": 0,
"subnetMask": "string",
"supportedCsl": 0.1,
"suspendingDeployTime": 0,
"switch": true,
"switchPosition": {"floorplanId": null,
"xPercent": null,
"yPercent": null
},
"switchStatus": "ONLINE",
"syncedPortConfig": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenant": { },
"tenantSync": true,
"trustPorts": [null
],
"unknown": true,
"venue": { },
"vlanCustomize": true,
"waitConfigurationCollectTime": 0,
"waitingConfigurationCollect": true,
"waitingRunningConfig": true
}
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": "string",
"downloadTime": "2019-08-24T14:15:22Z",
"id": "string",
"status": "PENDING",
"tenant": { },
"timeSlot": {"endDateTime": "2019-08-24T14:15:22Z",
"id": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"status": "WAITING_REMINDER",
"totalCapacityVenue": 0
},
"version": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"versionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
}
}
}
]
},
"trustedPorts": [{"id": "string",
"model": "ICX7150-24",
"profile": { },
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
]
},
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"defaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 3,
"profile": { },
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": null,
"option": null,
"slotNumber": null
}
],
"taggedPorts": "string",
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"latestReleaseVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [null
],
"venues": [null
]
},
"untaggedPorts": "string",
"vlan": { }
}
],
"tenant": {"firmwareVersion": "string",
"id": "string",
"latestBetaVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersion": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"latestReleaseVersionAboveTen": {"category": "RECOMMENDED",
"id": "string",
"name": "string",
"tenant": { }
},
"name": "string",
"preDownloadFirmware": true,
"profiles": [{ }
],
"venues": [{"addressLine": "string",
"cliApplied": true,
"dns": [null
],
"dnsList": [null
],
"firmware": "string",
"id": "string",
"lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
"name": "string",
"preDownloadFirmware": true,
"profileId": [null
],
"switchFirmwareVersion": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchFirmwareVersionAboveTen": {"category": null,
"id": null,
"name": null,
"tenant": null
},
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"switches": [null
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string",
"tenant": { },
"timeZone": "string",
"upgradeSchedule": {"downloadJobId": null,
"downloadTime": null,
"id": null,
"status": null,
"tenant": null,
"timeSlot": null,
"version": null,
"versionAboveTen": null
}
}
]
},
"vlanId": 1,
"vlanName": "string"
}
]
},
"slots": [{"enable": true,
"id": "string",
"option": "string",
"slotNumber": 0
}
],
"tenantId": "string",
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venueCliTemplate": {"cli": "string",
"id": "string",
"name": "string",
"overwrite": true,
"profile": { },
"switchModels": "string",
"variables": [{"cliTemplateType": "CLI_TEMPLATE_PROVISION",
"currentRangeValue": {"acquire": 0,
"andDecrement": 0,
"andIncrement": 0,
"opaque": 0,
"plain": 0,
"release": 0
},
"endIpAddress": "string",
"id": "string",
"ipAddress": "string",
"name": "string",
"needUpdate": true,
"rangeEnd": 0,
"rangeStart": 0,
"subMask": "string",
"switchId": "string",
"type": "ADDRESS",
"value": "string"
}
]
},
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"arpInspectionTrustPortList": ["string"
],
"arpTrustPortsList": ["string"
],
"defaultVlan": true,
"dhcpTrustPortsList": ["string"
],
"dummyVlan": true,
"enableAsDefaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"igmpSnoopingTypeChanged": true,
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"ipv4DhcpSnoopingTrustPortList": ["string"
],
"managementVlan": true,
"multicastVersion": 3,
"notDummyVlan": true,
"rapidSpanningTreeProtocol": true,
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"id": "string",
"option": "string",
"slotNumber": 0
}
],
"switchId": "string",
"taggedPorts": "string",
"untaggedPorts": "string"
}
],
"switchId": "string",
"switchVlanPortModel": {"id": "string",
"switchModel": "ICX7150-24",
"taggedPorts": "string",
"taggedPortsList": ["string"
],
"untaggedPorts": "string",
"untaggedPortsList": ["string"
]
},
"switchVlanPortModels": [{"id": "string",
"switchModel": "ICX7150-24",
"taggedPorts": "string",
"taggedPortsList": ["string"
],
"untaggedPorts": "string",
"untaggedPortsList": ["string"
]
}
],
"taggedPortsList": ["string"
],
"untaggedPortsList": ["string"
],
"vlanId": 1,
"vlanName": "string"
}
]
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Switch Profiles

Get regular switch profiles or command-line interface profiles of the venue.

path Parameters

venueId

required

string

Responses

Response samples

Content type

application/json

[{"acls": [{"aclRules": [{"action": "permit",
"destination": "string",
"destinationPort": 0,
"dscpMarking": 0,
"dscpMatching": 0,
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
],
"suppressed": [{"localizedMessage": null,
"message": null,
"stackTrace": [ ]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{ }
]
}
]
},
"id": "string",
"internalPriority": 0,
"protocol": "ip",
"sequence": 0,
"source": "string",
"sourcePort": 0
}
],
"aclType": "standard",
"aclViewList": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string"
}
],
"description": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string",
"profileType": "Regular",
"trustedPorts": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"trustPorts": ["string"
],
"trustedPortType": "all",
"vlanDemand": true
}
],
"venueCliTemplate": {"cli": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string",
"overwrite": true,
"switchModels": "string",
"variables": [{"name": "string",
"type": "ADDRESS",
"value": "string"
}
]
},
"venueCount": 0,
"venues": ["string"
],
"vlans": [{"arpInspection": true,
"arpInspectionTrustPort": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"multicastVersion": 0,
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 0,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": null,
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"moduleName": null,
"moduleVersion": null,
"nativeMethod": null
}
],
"suppressed": [{"localizedMessage": null,
"message": null,
"stackTrace": [ ]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{ }
]
}
]
},
"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"option": "string",
"slotNumber": 0
}
],
"taggedPorts": "string",
"untaggedPorts": "string"
}
],
"vlanId": 0,
"vlanName": "string"
}
]
}
]

Venue Switch-Setting

Manage a switch's venue-level settings.

Delete Venue Switch-Settings

Delete switch settings of the venue.

path Parameters

venueId

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Venue Switch-Setting

Get the switch settings of the venue.

path Parameters

venueId

required

string

Responses

Response samples

Content type

application/json

{"cliApplied": true,
"dns": ["string"
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"name": "string",
"profileId": ["string"
],
"switchLoginPassword": "string",
"switchLoginUsername": "string",
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string"
}

Update Venue Switch-Setting

Update the switch settings of the venue. Use activity API with request id to get the status update.

path Parameters

venueId

required

string

Request Body schema: application/json
required

dns	Array of strings
id	string
profileId	Array of strings
syslogEnabled	boolean
syslogPrimaryServer	string
syslogSecondaryServer	string

Responses

Request samples

Payload

Content type

application/json

{"dns": ["string"
],
"id": "string",
"profileId": ["string"
],
"syslogEnabled": true,
"syslogPrimaryServer": "string",
"syslogSecondaryServer": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

VLAN

Manage VLANs (virtual local area networks).

Delete VLANs

Delete multiple VLANs of the switch.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get Default VLANs

Retrieve multiple default VLAN list by switches.

Request Body schema: application/json
required

isDefault	boolean
switchIds	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"isDefault": true,
"switchIds": ["string"
]
}

Response samples

Content type

application/json

[{"defaultVlanId": 0,
"switchId": "string"
}
]

Delete VLAN

Delete a VLAN of the switch.

path Parameters

vlanId

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get VLAN

Get particular switch-level VLAN by id.

path Parameters

vlanId

required

string

Responses

Response samples

Content type

application/json

{"arpInspection": true,
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"multicastVersion": 0,
"spanningTreeProtocol": "rstp",
"switchVlanPortModels": [{"id": "string",
"switchModel": "ICX7150-24",
"taggedPorts": "string",
"taggedPortsList": ["string"
],
"untaggedPorts": "string",
"untaggedPortsList": ["string"
]
}
],
"taggedPorts": "string",
"untaggedPorts": "string",
"vePort": {"connectedVe": true,
"defaultVlan": true,
"deviceStatus": "string",
"dhcpRelayAgent": "string",
"egressAclName": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"ingressAclName": "string",
"ipAddress": "string",
"ipAddressType": "static",
"ipSubnetMask": "string",
"name": "string",
"ospfArea": "string",
"portType": "NONE",
"stack": true,
"switchId": "string",
"switchName": "string",
"syncedSwitchConfig": true,
"tenantId": "string",
"veId": 0,
"vePortViewList": [{ }
],
"vlanId": 0
},
"vlanId": 0,
"vlanName": "string"
}

Update VLAN

Update a VLAN of the switch.

path Parameters

vlanId

required

string

Request Body schema: application/json
required

arpInspection	boolean
arpInspectionTrustPort	string
arpInspectionTrustPortList	Array of strings
arpTrustPortsList	Array of strings
defaultVlan	boolean
dhcpTrustPortsList	Array of strings
dummyVlan	boolean
enableAsDefaultVlan required	boolean
id	string
igmpSnooping	string Enum: "active" "passive" "none"
igmpSnoopingTypeChanged	boolean
ipv4DhcpSnooping	boolean
ipv4DhcpSnoopingTrustPort	string
ipv4DhcpSnoopingTrustPortList	Array of strings
managementVlan	boolean
multicastVersion	integer <int32> [ 0 .. 3 ]
notDummyVlan	boolean
rapidSpanningTreeProtocol	boolean
rootBridgeFamilyId	string Enum: "__NULL" "ICX7150" "ICX7250" "ICX7650" "ICX7850" "ICX7550" "ICX8200"
spanningTreePriority	integer <int32> [ 0 .. 65535 ]
spanningTreeProtocol	string Enum: "rstp" "stp" "none"
	Array of objects (Switch_Service_API_&_Model_Documentation_SwitchFamilyModelBo) unique
switchId	string
	object (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo)
	Array of objects (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo) unique
taggedPortsList	Array of strings
untaggedPortsList	Array of strings
vlanId	integer <int32> [ 1 .. 4095 ]
vlanName	string

Responses

Request samples

Payload

Content type

application/json

{"arpInspection": true,
"arpInspectionTrustPort": "string",
"arpInspectionTrustPortList": ["string"
],
"arpTrustPortsList": ["string"
],
"defaultVlan": true,
"dhcpTrustPortsList": ["string"
],
"dummyVlan": true,
"enableAsDefaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"igmpSnoopingTypeChanged": true,
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"ipv4DhcpSnoopingTrustPortList": ["string"
],
"managementVlan": true,
"multicastVersion": 3,
"notDummyVlan": true,
"rapidSpanningTreeProtocol": true,
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"id": "string",
"option": "string",
"slotNumber": 0
}
],
"switchId": "string",
"taggedPorts": "string",
"untaggedPorts": "string"
}
],
"switchId": "string",
"switchVlanPortModel": {"id": "string",
"switchModel": "ICX7150-24",
"taggedPorts": "string",
"taggedPortsList": ["string"
],
"untaggedPorts": "string",
"untaggedPortsList": ["string"
]
},
"switchVlanPortModels": [{"id": "string",
"switchModel": "ICX7150-24",
"taggedPorts": "string",
"taggedPortsList": ["string"
],
"untaggedPorts": "string",
"untaggedPortsList": ["string"
]
}
],
"taggedPortsList": ["string"
],
"untaggedPortsList": ["string"
],
"vlanId": 1,
"vlanName": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Get VLANs

Get switch-level VLANs by switch.

path Parameters

switchId

required

string

Responses

Response samples

Content type

application/json

[{"arpInspection": true,
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"igmpSnooping": "active",
"ipv4DhcpSnooping": true,
"multicastVersion": 0,
"spanningTreeProtocol": "rstp",
"switchVlanPortModels": [{"id": "string",
"switchModel": "ICX7150-24",
"taggedPorts": "string",
"taggedPortsList": ["string"
],
"untaggedPorts": "string",
"untaggedPortsList": ["string"
]
}
],
"taggedPorts": "string",
"untaggedPorts": "string",
"vePort": {"connectedVe": true,
"defaultVlan": true,
"deviceStatus": "string",
"dhcpRelayAgent": "string",
"egressAclName": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"ingressAclName": "string",
"ipAddress": "string",
"ipAddressType": "static",
"ipSubnetMask": "string",
"name": "string",
"ospfArea": "string",
"portType": "NONE",
"stack": true,
"switchId": "string",
"switchName": "string",
"syncedSwitchConfig": true,
"tenantId": "string",
"veId": 0,
"vePortViewList": [{ }
],
"vlanId": 0
},
"vlanId": 0,
"vlanName": "string"
}
]

Add VLAN

Create a VLAN of the switch.

path Parameters

switchId

required

string

Request Body schema: application/json
required

arpInspection	boolean
arpInspectionTrustPort	string
arpInspectionTrustPortList	Array of strings
arpTrustPortsList	Array of strings
defaultVlan	boolean
dhcpTrustPortsList	Array of strings
dummyVlan	boolean
enableAsDefaultVlan required	boolean
id	string
igmpSnooping	string Enum: "active" "passive" "none"
igmpSnoopingTypeChanged	boolean
ipv4DhcpSnooping	boolean
ipv4DhcpSnoopingTrustPort	string
ipv4DhcpSnoopingTrustPortList	Array of strings
managementVlan	boolean
multicastVersion	integer <int32> [ 0 .. 3 ]
notDummyVlan	boolean
rapidSpanningTreeProtocol	boolean
rootBridgeFamilyId	string Enum: "__NULL" "ICX7150" "ICX7250" "ICX7650" "ICX7850" "ICX7550" "ICX8200"
spanningTreePriority	integer <int32> [ 0 .. 65535 ]
spanningTreeProtocol	string Enum: "rstp" "stp" "none"
	Array of objects (Switch_Service_API_&_Model_Documentation_SwitchFamilyModelBo) unique
switchId	string
	object (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo)
	Array of objects (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo) unique
taggedPortsList	Array of strings
untaggedPortsList	Array of strings
vlanId	integer <int32> [ 1 .. 4095 ]
vlanName	string

Responses

Request samples

Payload

Content type

application/json

{"arpInspection": true,
"arpInspectionTrustPort": "string",
"arpInspectionTrustPortList": ["string"
],
"arpTrustPortsList": ["string"
],
"defaultVlan": true,
"dhcpTrustPortsList": ["string"
],
"dummyVlan": true,
"enableAsDefaultVlan": true,
"id": "string",
"igmpSnooping": "active",
"igmpSnoopingTypeChanged": true,
"ipv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "string",
"ipv4DhcpSnoopingTrustPortList": ["string"
],
"managementVlan": true,
"multicastVersion": 3,
"notDummyVlan": true,
"rapidSpanningTreeProtocol": true,
"rootBridgeFamilyId": "__NULL",
"spanningTreePriority": 65535,
"spanningTreeProtocol": "rstp",
"switchFamilyModels": [{"id": "string",
"model": "ICX7150-24",
"slots": [{"enable": true,
"id": "string",
"option": "string",
"slotNumber": 0
}
],
"switchId": "string",
"taggedPorts": "string",
"untaggedPorts": "string"
}
],
"switchId": "string",
"switchVlanPortModel": {"id": "string",
"switchModel": "ICX7150-24",
"taggedPorts": "string",
"taggedPortsList": ["string"
],
"untaggedPorts": "string",
"untaggedPortsList": ["string"
]
},
"switchVlanPortModels": [{"id": "string",
"switchModel": "ICX7150-24",
"taggedPorts": "string",
"taggedPortsList": ["string"
],
"untaggedPorts": "string",
"untaggedPortsList": ["string"
]
}
],
"taggedPortsList": ["string"
],
"untaggedPortsList": ["string"
],
"vlanId": 1,
"vlanName": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Retrieve VLANs

Query the switchâs switch-level VLANs.

path Parameters

switchId

required

string

Request Body schema: application/json
required

fields	Array of strings
filterType	string
	object
page	integer <int32>
pageSize	integer <int32>
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"filterType": "string",
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"page": 0,
"pageSize": 0,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

Content type

application/json

{"data": [{ }
],
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"fields": ["string"
],
"id": "string",
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Get VLAN-VE-Ports

List all usable VLANs that are available for the VE setting.

path Parameters

venueId required	string
switchId required	string

Responses

Response samples

Content type

application/json

[{"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string",
"usedByVePort": true,
"vlanId": "string",
"vlanName": "string"
}
]

Get Switch VLANs

List all usable VLANs under this venue.

path Parameters

venueId

required

string

Responses

Response samples

Content type

application/json

[{"vlanConfigName": "string",
"vlanId": 1
}
]

Import Switch

Import Switches.

Add Switches

Add switches by CSV file. Use activity API with request id to get the status update.

Request Body schema: multipart/form-data

file	string <binary>

Responses

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

AAA Setting

Manage AAA (authentication, authorization, and accounting) Settings.

Retrieve AAA Setting

Retrieve venue's authentication, authorization, and accounting setting.

path Parameters

venueId

required

string

Responses

Response samples

Content type

application/json

{"acctCommonsFirstServer": "string",
"acctCommonsLevel": "string",
"acctCommonsSecondServer": "string",
"acctCommonsThirdServer": "string",
"acctEnabledCommand": true,
"acctEnabledExec": true,
"acctExecFirstServer": "string",
"acctExecSecondServer": "string",
"acctExecThirdServer": "string",
"authnEnableTelnet": true,
"authnEnabledSsh": true,
"authnFirstPref": "string",
"authnFourthPref": "string",
"authnSecondPref": "string",
"authnThirdPref": "string",
"authzCommonsFirstServer": "string",
"authzCommonsLevel": "string",
"authzCommonsSecondServer": "string",
"authzCommonsThirdServer": "string",
"authzEnabledCommand": true,
"authzEnabledExec": true,
"authzExecFirstServer": "string",
"authzExecSecondServer": "string",
"authzExecThirdServer": "string",
"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}

Update AAA Setting

Update authentication, authorization, and accounting setting by id. Use activity API with request id to get the status update.

path Parameters

venueId required	string
aaaSettingId required	string

Request Body schema: application/json
required

acctCommonsFirstServer	string
acctCommonsLevel	string
acctCommonsSecondServer	string
acctCommonsThirdServer	string
acctEnabledCommand	boolean
acctEnabledExec	boolean
acctExecFirstServer	string
acctExecSecondServer	string
acctExecThirdServer	string
authnEnableTelnet	boolean
authnEnabledSsh	boolean
authnFirstPref	string
authnFourthPref	string
authnSecondPref	string
authnThirdPref	string
authzCommonsFirstServer	string
authzCommonsLevel	string
authzCommonsSecondServer	string
authzCommonsThirdServer	string
authzEnabledCommand	boolean
authzEnabledExec	boolean
authzExecFirstServer	string
authzExecSecondServer	string
authzExecThirdServer	string

Responses

Request samples

Payload

Content type

application/json

{"acctCommonsFirstServer": "string",
"acctCommonsLevel": "string",
"acctCommonsSecondServer": "string",
"acctCommonsThirdServer": "string",
"acctEnabledCommand": true,
"acctEnabledExec": true,
"acctExecFirstServer": "string",
"acctExecSecondServer": "string",
"acctExecThirdServer": "string",
"authnEnableTelnet": true,
"authnEnabledSsh": true,
"authnFirstPref": "string",
"authnFourthPref": "string",
"authnSecondPref": "string",
"authnThirdPref": "string",
"authzCommonsFirstServer": "string",
"authzCommonsLevel": "string",
"authzCommonsSecondServer": "string",
"authzCommonsThirdServer": "string",
"authzEnabledCommand": true,
"authzEnabledExec": true,
"authzExecFirstServer": "string",
"authzExecSecondServer": "string",
"authzExecThirdServer": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"exception": {"cause": {"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
],
"suppressed": [{"localizedMessage": "string",
"message": "string",
"stackTrace": [{"classLoaderName": "string",
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"moduleName": "string",
"moduleVersion": "string",
"nativeMethod": true
}
]
}
]
},
"id": "string"
}
}

Floor-Plan

Manage floor-plans and calibration-points (calibrations-points are used to establish, for example, precise AP positioning).

Get Floor Plans

Get floor plans by a venue ID.

path Parameters

venueId

required

string

Responses

Response samples

200

Content type

application/json

[{"createdDate": "2019-08-24T14:15:22Z",
"floorNumber": 0,
"id": "string",
"imageId": "string",
"imageName": "string",
"imageUrl": "string",
"name": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
]

Create Floor Plan

Create floor plan.

path Parameters

venueId

required

string

Request Body schema: application/json
required

floorNumber	integer <int32>
imageId	string
imageName	string
name	string
	object (Venue_Service_API_&_Model_Documentation_VenueView)

Responses

Request samples

Payload

Content type

application/json

{"floorNumber": 0,
"imageId": "string",
"imageName": "string",
"name": "string",
"venue": {"address": {"addressLine": "string",
"city": "string",
"country": "string",
"countryCode": "string",
"latitude": 0.1,
"longitude": 0.1,
"notes": "string",
"timezone": "string"
},
"description": "string",
"floorPlans": [{ }
],
"name": "string"
}
}

Response samples

202

Content type

application/json

{"requestId": "string",
"response": {"createdDate": "2019-08-24T14:15:22Z",
"floorNumber": 0,
"id": "string",
"imageId": "string",
"imageName": "string",
"imageUrl": "string",
"name": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
}

Delete Floor Plan

Delete floor plan.

path Parameters

venueId required	string
floorPlanId required	string

Responses

Response samples

202

Content type

application/json

{"requestId": "string",
"response": { }
}

Get Floor Plan

Get floor plan by ID.

path Parameters

venueId required	string
floorPlanId required	string

Responses

Response samples

200

Content type

application/json

{"createdDate": "2019-08-24T14:15:22Z",
"floorNumber": 0,
"id": "string",
"imageId": "string",
"imageName": "string",
"imageUrl": "string",
"name": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}

Update Floor Plan

Update floor plan.

path Parameters

venueId required	string
floorPlanId required	string

Request Body schema: application/json
required

floorNumber	integer <int32>
imageId	string
imageName	string
name	string
	object (Venue_Service_API_&_Model_Documentation_VenueView)

Responses

Request samples

Payload

Content type

application/json

{"floorNumber": 0,
"imageId": "string",
"imageName": "string",
"name": "string",
"venue": {"address": {"addressLine": "string",
"city": "string",
"country": "string",
"countryCode": "string",
"latitude": 0.1,
"longitude": 0.1,
"notes": "string",
"timezone": "string"
},
"description": "string",
"floorPlans": [{ }
],
"name": "string"
}
}

Response samples

202

Content type

application/json

{"requestId": "string",
"response": {"createdDate": "2019-08-24T14:15:22Z",
"floorNumber": 0,
"id": "string",
"imageId": "string",
"imageName": "string",
"imageUrl": "string",
"name": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
}

Venue

Manage venue.

Delete Venues by IDs

Delete venues by list. WARNING: Note that all network devices under these venues will be removed as well.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

202

Content type

application/json

{"requestId": "string",
"response": { }
}

Get Venues

Get venue list.

Responses

Response samples

200

Content type

application/json

[{"address": {"addressLine": "string",
"city": "string",
"country": "string",
"countryCode": "string",
"latitude": 0.1,
"longitude": 0.1,
"notes": "string",
"timezone": "string"
},
"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"floorPlans": [{"createdDate": "2019-08-24T14:15:22Z",
"floorNumber": 0,
"id": "string",
"imageId": "string",
"imageName": "string",
"imageUrl": "string",
"name": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"id": "string",
"name": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
]

Create Venue

Create venue.

Request Body schema: application/json
required

	object (Venue_Service_API_&_Model_Documentation_AddressView)
description	string
	Array of objects (Venue_Service_API_&_Model_Documentation_FloorPlanView)
name required	string [ 2 .. 32 ] characters \s\S+\s\S+.*

Responses

Request samples

Payload

Content type

application/json

{"address": {"addressLine": "string",
"city": "string",
"country": "string",
"countryCode": "string",
"latitude": 0.1,
"longitude": 0.1,
"notes": "string",
"timezone": "string"
},
"description": "string",
"floorPlans": [{"floorNumber": 0,
"imageId": "string",
"imageName": "string",
"name": "string",
"venue": { }
}
],
"name": "string"
}

Response samples

202

Content type

application/json

{"requestId": "string",
"response": {"address": {"addressLine": "string",
"city": "string",
"country": "string",
"countryCode": "string",
"latitude": 0.1,
"longitude": 0.1,
"notes": "string",
"timezone": "string"
},
"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"floorPlans": [{"createdDate": "2019-08-24T14:15:22Z",
"floorNumber": 0,
"id": "string",
"imageId": "string",
"imageName": "string",
"imageUrl": "string",
"name": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"id": "string",
"name": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
}

Delete Venue by ID

Delete venues by ID. WARNING: Note that all network devices under this venue will be removed as well.

path Parameters

venueId

required

string

Responses

Response samples

202

Content type

application/json

{"requestId": "string",
"response": { }
}

Get Venue by ID

Get venue.

path Parameters

venueId

required

string

Responses

Response samples

200

Content type

application/json

{"address": {"addressLine": "string",
"city": "string",
"country": "string",
"countryCode": "string",
"latitude": 0.1,
"longitude": 0.1,
"notes": "string",
"timezone": "string"
},
"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"floorPlans": [{"createdDate": "2019-08-24T14:15:22Z",
"floorNumber": 0,
"id": "string",
"imageId": "string",
"imageName": "string",
"imageUrl": "string",
"name": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"id": "string",
"name": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}

Update Venue

Update venue.

path Parameters

venueId

required

string

Request Body schema: application/json
required

	object (Venue_Service_API_&_Model_Documentation_AddressView)
description	string
	Array of objects (Venue_Service_API_&_Model_Documentation_FloorPlanView)
name required	string [ 2 .. 32 ] characters \s\S+\s\S+.*

Responses

Request samples

Payload

Content type

application/json

{"address": {"addressLine": "string",
"city": "string",
"country": "string",
"countryCode": "string",
"latitude": 0.1,
"longitude": 0.1,
"notes": "string",
"timezone": "string"
},
"description": "string",
"floorPlans": [{"floorNumber": 0,
"imageId": "string",
"imageName": "string",
"name": "string",
"venue": { }
}
],
"name": "string"
}

Response samples

202

Content type

application/json

{"requestId": "string",
"response": {"address": {"addressLine": "string",
"city": "string",
"country": "string",
"countryCode": "string",
"latitude": 0.1,
"longitude": 0.1,
"notes": "string",
"timezone": "string"
},
"createdDate": "2019-08-24T14:15:22Z",
"description": "string",
"floorPlans": [{"createdDate": "2019-08-24T14:15:22Z",
"floorNumber": 0,
"id": "string",
"imageId": "string",
"imageName": "string",
"imageUrl": "string",
"name": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
],
"id": "string",
"name": "string",
"updatedDate": "2019-08-24T14:15:22Z"
}
}

View MSP

View MSP and VAR information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Get Delegations

Get the list of customer delegations.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"alarmCount": 0,
"crtTime": "string",
"delegatedToEmail": "string",
"delegatedToId": "string",
"delegatedToName": "string",
"delegationType": "string",
"earlyExpirationDate": "string",
"entitlements": [{"accountType": "string",
"adaptivePolicyCount": "string",
"consumed": "string",
"edgeDeviceCount": "string",
"entitlementDeviceSubType": "string",
"entitlementDeviceType": "string",
"expirationDate": "string",
"expirationDateTs": "string",
"futureOfComplianceDate": "string",
"futureOutOfComplianceDevices": "string",
"outOfComplianceDevices": "string",
"piNetworkCount": "string",
"quantity": "string",
"rwgDeviceCount": "string",
"switchDeviceCount": "string",
"tenantId": "string",
"toBeRemovedQuantity": 0,
"type": "string",
"virtualEdgeDeviceCount": "string",
"wifiDeviceCount": "string"
}
],
"id": "string",
"lastUpdTime": "string",
"priorityIncidents": {"p1": "string",
"p2": "string",
"p3": "string",
"p4": "string"
},
"status": "string",
"switchLicenses": 0,
"tenantEmail": "string",
"tenantId": "string",
"tenantName": "string",
"type": "string",
"wifiLicenses": 0
}

Query MSP-ECs

Query MSP-ECs.

query Parameters

delegation

string

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"accountTier": "string",
"accountType": "string",
"apSwLicenses": 0,
"assignedMspEcList": ["string"
],
"city": "string",
"country": "string",
"creationDate": "string",
"customerCount": 0,
"delegatedTo": "string",
"delegationExpiryDate": 0,
"edgeLicenses": 0,
"entitlements": [{"accountType": "string",
"adaptivePolicyCount": "string",
"consumed": "string",
"edgeDeviceCount": "string",
"entitlementDeviceSubType": "string",
"entitlementDeviceType": "string",
"expirationDate": "string",
"expirationDateTs": "string",
"futureOfComplianceDate": "string",
"futureOutOfComplianceDevices": "string",
"outOfComplianceDevices": "string",
"piNetworkCount": "string",
"quantity": "string",
"rwgDeviceCount": "string",
"switchDeviceCount": "string",
"tenantId": "string",
"toBeRemovedQuantity": 0,
"type": "string",
"virtualEdgeDeviceCount": "string",
"wifiDeviceCount": "string"
}
],
"id": "string",
"installer": "string",
"installerCount": 0,
"installers": ["string"
],
"integrator": "string",
"integratorCount": 0,
"integrators": ["string"
],
"lastUpdTime": "string",
"mspAdminCount": 0,
"mspAdmins": ["string"
],
"mspEcAdminCount": 0,
"mspInstallerAdminCount": 0,
"mspInstallerAdmins": ["string"
],
"mspIntegratorAdminCount": 0,
"mspIntegratorAdmins": ["string"
],
"mspLabel": "string",
"mspName": "string",
"mspTenantId": "string",
"mspecId": "string",
"mspecName": "string",
"name": "string",
"postalCode": "string",
"priorityIncidents": {"p1": "string",
"p2": "string",
"p3": "string",
"p4": "string"
},
"rwgLicenses": 0,
"state": "string",
"status": "string",
"streetAddress": "string",
"switchLicenses": 0,
"tenantType": "string",
"virtualEdgeLicenses": 0,
"wifiLicenses": 0
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get EC Inventory

View the list of networking devices installed in our end customers venues.

path Parameters

mspTenantId

required

string

Tenant Id of the MSP.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apStatusData": {"APRadio": [{"Rssi": 0,
"actualTxPower": 0,
"band": "string",
"calibrationTxPower": 0,
"channel": 0,
"operativeChannelBandwidth": "string",
"radioId": 0,
"txPower": "string"
}
],
"APSystem": {"gateway": "string",
"ipType": "string",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string",
"uptime": 0
},
"afcInfo": {"afcStatus": "string",
"availableChannel": 0,
"availableChannels": [0
],
"geoLocation": {"height": 0.1,
"lateralUncertainty": 0.1,
"latitude": 0.1,
"longitude": 0.1,
"source": "string",
"verticalUncertainty": 0.1
},
"maxPowerDbm": 0,
"minPowerDbm": 0,
"powerMode": "string"
},
"cellularInfo": {"cellular3G4GChannel": 0,
"cellularActiveSim": "string",
"cellularBand": "string",
"cellularCardRemovalCountSIM0": "string",
"cellularCardRemovalCountSIM1": "string",
"cellularConnectionStatus": "string",
"cellularCountry": "string",
"cellularDHCPTimeoutCountSIM0": "string",
"cellularDHCPTimeoutCountSIM1": "string",
"cellularDefaultGateway": "string",
"cellularDownlinkBandwidth": "string",
"cellularECIO": 0,
"cellularICCIDSIM0": "string",
"cellularICCIDSIM1": "string",
"cellularIMEI": "string",
"cellularIMSISIM0": "string",
"cellularIMSISIM1": "string",
"cellularIPaddress": "string",
"cellularIsSIM0Present": "string",
"cellularIsSIM1Present": "string",
"cellularLTEFirmware": "string",
"cellularNWLostCountSIM0": "string",
"cellularNWLostCountSIM1": "string",
"cellularOperator": "string",
"cellularRSCP": 0,
"cellularRSRP": 0,
"cellularRSRQ": 0,
"cellularRadioUptime": 0,
"cellularRoamingStatus": "string",
"cellularRxBytesSIM0": "string",
"cellularRxBytesSIM1": "string",
"cellularSINR": 0,
"cellularSignalStrength": "string",
"cellularSubnetMask": "string",
"cellularSwitchCountSIM0": "string",
"cellularSwitchCountSIM1": "string",
"cellularTxBytesSIM0": "string",
"cellularTxBytesSIM1": "string",
"cellularUplinkBandwidth": "string",
"cellularWanInterface": "string"
},
"lanPortStatus": [{"phyLink": "string",
"port": "string"
}
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"customerName": "string",
"description": "string",
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"deviceType": "string",
"downlink": [{"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [{"Rssi": 0,
"actualTxPower": 0,
"band": "string",
"calibrationTxPower": 0,
"channel": 0,
"operativeChannelBandwidth": "string",
"radioId": 0,
"txPower": "string"
}
],
"APSystem": {"gateway": "string",
"ipType": "string",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string",
"uptime": 0
},
"afcInfo": {"afcStatus": "string",
"availableChannel": 0,
"availableChannels": [0
],
"geoLocation": {"height": 0.1,
"lateralUncertainty": 0.1,
"latitude": 0.1,
"longitude": 0.1,
"source": "string",
"verticalUncertainty": 0.1
},
"maxPowerDbm": 0,
"minPowerDbm": 0,
"powerMode": "string"
},
"cellularInfo": {"cellular3G4GChannel": 0,
"cellularActiveSim": "string",
"cellularBand": "string",
"cellularCardRemovalCountSIM0": "string",
"cellularCardRemovalCountSIM1": "string",
"cellularConnectionStatus": "string",
"cellularCountry": "string",
"cellularDHCPTimeoutCountSIM0": "string",
"cellularDHCPTimeoutCountSIM1": "string",
"cellularDefaultGateway": "string",
"cellularDownlinkBandwidth": "string",
"cellularECIO": 0,
"cellularICCIDSIM0": "string",
"cellularICCIDSIM1": "string",
"cellularIMEI": "string",
"cellularIMSISIM0": "string",
"cellularIMSISIM1": "string",
"cellularIPaddress": "string",
"cellularIsSIM0Present": "string",
"cellularIsSIM1Present": "string",
"cellularLTEFirmware": "string",
"cellularNWLostCountSIM0": "string",
"cellularNWLostCountSIM1": "string",
"cellularOperator": "string",
"cellularRSCP": 0,
"cellularRSRP": 0,
"cellularRSRQ": 0,
"cellularRadioUptime": 0,
"cellularRoamingStatus": "string",
"cellularRxBytesSIM0": "string",
"cellularRxBytesSIM1": "string",
"cellularSINR": 0,
"cellularSignalStrength": "string",
"cellularSubnetMask": "string",
"cellularSwitchCountSIM0": "string",
"cellularSwitchCountSIM1": "string",
"cellularTxBytesSIM0": "string",
"cellularTxBytesSIM1": "string",
"cellularUplinkBandwidth": "string",
"cellularWanInterface": "string"
},
"lanPortStatus": [{"phyLink": "string",
"port": "string"
}
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceDto": {"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [{"Rssi": 0,
"actualTxPower": 0,
"band": "string",
"calibrationTxPower": 0,
"channel": 0,
"operativeChannelBandwidth": "string",
"radioId": 0,
"txPower": "string"
}
],
"APSystem": {"gateway": "string",
"ipType": "string",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string",
"uptime": 0
},
"afcInfo": {"afcStatus": "string",
"availableChannel": 0,
"availableChannels": [0
],
"geoLocation": {"height": 0.1,
"lateralUncertainty": 0.1,
"latitude": 0.1,
"longitude": 0.1,
"source": "string",
"verticalUncertainty": 0.1
},
"maxPowerDbm": 0,
"minPowerDbm": 0,
"powerMode": "string"
},
"cellularInfo": {"cellular3G4GChannel": 0,
"cellularActiveSim": "string",
"cellularBand": "string",
"cellularCardRemovalCountSIM0": "string",
"cellularCardRemovalCountSIM1": "string",
"cellularConnectionStatus": "string",
"cellularCountry": "string",
"cellularDHCPTimeoutCountSIM0": "string",
"cellularDHCPTimeoutCountSIM1": "string",
"cellularDefaultGateway": "string",
"cellularDownlinkBandwidth": "string",
"cellularECIO": 0,
"cellularICCIDSIM0": "string",
"cellularICCIDSIM1": "string",
"cellularIMEI": "string",
"cellularIMSISIM0": "string",
"cellularIMSISIM1": "string",
"cellularIPaddress": "string",
"cellularIsSIM0Present": "string",
"cellularIsSIM1Present": "string",
"cellularLTEFirmware": "string",
"cellularNWLostCountSIM0": "string",
"cellularNWLostCountSIM1": "string",
"cellularOperator": "string",
"cellularRSCP": 0,
"cellularRSRP": 0,
"cellularRSRQ": 0,
"cellularRadioUptime": 0,
"cellularRoamingStatus": "string",
"cellularRxBytesSIM0": "string",
"cellularRxBytesSIM1": "string",
"cellularSINR": 0,
"cellularSignalStrength": "string",
"cellularSubnetMask": "string",
"cellularSwitchCountSIM0": "string",
"cellularSwitchCountSIM1": "string",
"cellularTxBytesSIM0": "string",
"cellularTxBytesSIM1": "string",
"cellularUplinkBandwidth": "string",
"cellularWanInterface": "string"
},
"lanPortStatus": [{"phyLink": "string",
"port": "string"
}
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": "string",
"mac": "string",
"rssi": 0
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"uplink": [{"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [null
],
"APSystem": {"gateway": null,
"ipType": null,
"netmask": null,
"primaryDnsServer": null,
"secondaryDnsServer": null,
"uptime": null
},
"afcInfo": {"afcStatus": null,
"availableChannel": null,
"availableChannels": [ ],
"geoLocation": null,
"maxPowerDbm": null,
"minPowerDbm": null,
"powerMode": null
},
"cellularInfo": {"cellular3G4GChannel": null,
"cellularActiveSim": null,
"cellularBand": null,
"cellularCardRemovalCountSIM0": null,
"cellularCardRemovalCountSIM1": null,
"cellularConnectionStatus": null,
"cellularCountry": null,
"cellularDHCPTimeoutCountSIM0": null,
"cellularDHCPTimeoutCountSIM1": null,
"cellularDefaultGateway": null,
"cellularDownlinkBandwidth": null,
"cellularECIO": null,
"cellularICCIDSIM0": null,
"cellularICCIDSIM1": null,
"cellularIMEI": null,
"cellularIMSISIM0": null,
"cellularIMSISIM1": null,
"cellularIPaddress": null,
"cellularIsSIM0Present": null,
"cellularIsSIM1Present": null,
"cellularLTEFirmware": null,
"cellularNWLostCountSIM0": null,
"cellularNWLostCountSIM1": null,
"cellularOperator": null,
"cellularRSCP": null,
"cellularRSRP": null,
"cellularRSRQ": null,
"cellularRadioUptime": null,
"cellularRoamingStatus": null,
"cellularRxBytesSIM0": null,
"cellularRxBytesSIM1": null,
"cellularSINR": null,
"cellularSignalStrength": null,
"cellularSubnetMask": null,
"cellularSwitchCountSIM0": null,
"cellularSwitchCountSIM1": null,
"cellularTxBytesSIM0": null,
"cellularTxBytesSIM1": null,
"cellularUplinkBandwidth": null,
"cellularWanInterface": null
},
"lanPortStatus": [null
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceDto": { },
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": null,
"mac": null,
"rssi": null
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"rssi": 0,
"rxBytes": "string",
"rxFrames": "string",
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"txBytes": "string",
"txFrames": "string",
"type": 0,
"upMac": "string",
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": null,
"wlanGroupId": null,
"wlanGroupName": null
}
],
"xPercent": 0.1,
"yPercent": 0.1
}
],
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": 0,
"wlanGroupId": "string",
"wlanGroupName": "string"
}
],
"xPercent": 0.1,
"yPercent": 0.1
},
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downMac": "string",
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": "string",
"mac": "string",
"rssi": 0
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"rssi": 0,
"rxBytes": "string",
"rxFrames": "string",
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"txBytes": "string",
"txFrames": "string",
"type": 0,
"uplink": [{"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [{"Rssi": null,
"actualTxPower": null,
"band": null,
"calibrationTxPower": null,
"channel": null,
"operativeChannelBandwidth": null,
"radioId": null,
"txPower": null
}
],
"APSystem": {"gateway": "string",
"ipType": "string",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string",
"uptime": 0
},
"afcInfo": {"afcStatus": "string",
"availableChannel": 0,
"availableChannels": [null
],
"geoLocation": {"height": null,
"lateralUncertainty": null,
"latitude": null,
"longitude": null,
"source": null,
"verticalUncertainty": null
},
"maxPowerDbm": 0,
"minPowerDbm": 0,
"powerMode": "string"
},
"cellularInfo": {"cellular3G4GChannel": 0,
"cellularActiveSim": "string",
"cellularBand": "string",
"cellularCardRemovalCountSIM0": "string",
"cellularCardRemovalCountSIM1": "string",
"cellularConnectionStatus": "string",
"cellularCountry": "string",
"cellularDHCPTimeoutCountSIM0": "string",
"cellularDHCPTimeoutCountSIM1": "string",
"cellularDefaultGateway": "string",
"cellularDownlinkBandwidth": "string",
"cellularECIO": 0,
"cellularICCIDSIM0": "string",
"cellularICCIDSIM1": "string",
"cellularIMEI": "string",
"cellularIMSISIM0": "string",
"cellularIMSISIM1": "string",
"cellularIPaddress": "string",
"cellularIsSIM0Present": "string",
"cellularIsSIM1Present": "string",
"cellularLTEFirmware": "string",
"cellularNWLostCountSIM0": "string",
"cellularNWLostCountSIM1": "string",
"cellularOperator": "string",
"cellularRSCP": 0,
"cellularRSRP": 0,
"cellularRSRQ": 0,
"cellularRadioUptime": 0,
"cellularRoamingStatus": "string",
"cellularRxBytesSIM0": "string",
"cellularRxBytesSIM1": "string",
"cellularSINR": 0,
"cellularSignalStrength": "string",
"cellularSubnetMask": "string",
"cellularSwitchCountSIM0": "string",
"cellularSwitchCountSIM1": "string",
"cellularTxBytesSIM0": "string",
"cellularTxBytesSIM1": "string",
"cellularUplinkBandwidth": "string",
"cellularWanInterface": "string"
},
"lanPortStatus": [{"phyLink": null,
"port": null
}
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceDto": {"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [null
],
"APSystem": {"gateway": null,
"ipType": null,
"netmask": null,
"primaryDnsServer": null,
"secondaryDnsServer": null,
"uptime": null
},
"afcInfo": {"afcStatus": null,
"availableChannel": null,
"availableChannels": [ ],
"geoLocation": null,
"maxPowerDbm": null,
"minPowerDbm": null,
"powerMode": null
},
"cellularInfo": {"cellular3G4GChannel": null,
"cellularActiveSim": null,
"cellularBand": null,
"cellularCardRemovalCountSIM0": null,
"cellularCardRemovalCountSIM1": null,
"cellularConnectionStatus": null,
"cellularCountry": null,
"cellularDHCPTimeoutCountSIM0": null,
"cellularDHCPTimeoutCountSIM1": null,
"cellularDefaultGateway": null,
"cellularDownlinkBandwidth": null,
"cellularECIO": null,
"cellularICCIDSIM0": null,
"cellularICCIDSIM1": null,
"cellularIMEI": null,
"cellularIMSISIM0": null,
"cellularIMSISIM1": null,
"cellularIPaddress": null,
"cellularIsSIM0Present": null,
"cellularIsSIM1Present": null,
"cellularLTEFirmware": null,
"cellularNWLostCountSIM0": null,
"cellularNWLostCountSIM1": null,
"cellularOperator": null,
"cellularRSCP": null,
"cellularRSRP": null,
"cellularRSRQ": null,
"cellularRadioUptime": null,
"cellularRoamingStatus": null,
"cellularRxBytesSIM0": null,
"cellularRxBytesSIM1": null,
"cellularSINR": null,
"cellularSignalStrength": null,
"cellularSubnetMask": null,
"cellularSwitchCountSIM0": null,
"cellularSwitchCountSIM1": null,
"cellularTxBytesSIM0": null,
"cellularTxBytesSIM1": null,
"cellularUplinkBandwidth": null,
"cellularWanInterface": null
},
"lanPortStatus": [null
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": null,
"mac": null,
"rssi": null
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"uplink": [{ }
],
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": null,
"wlanGroupId": null,
"wlanGroupName": null
}
],
"xPercent": 0.1,
"yPercent": 0.1
},
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": "string",
"mac": "string",
"rssi": 0
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"rssi": 0,
"rxBytes": "string",
"rxFrames": "string",
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"txBytes": "string",
"txFrames": "string",
"type": 0,
"upMac": "string",
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": 0,
"wlanGroupId": "string",
"wlanGroupName": "string"
}
],
"xPercent": 0.1,
"yPercent": 0.1
}
],
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": 0,
"wlanGroupId": "string",
"wlanGroupName": "string"
}
],
"xPercent": 0.1,
"yPercent": 0.1
}
],
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"managedAs": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"rogueCategory": {"property1": 0,
"property2": 0
},
"serialNumber": "string",
"switchMac": "string",
"switchName": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"uplink": [{"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [{"Rssi": 0,
"actualTxPower": 0,
"band": "string",
"calibrationTxPower": 0,
"channel": 0,
"operativeChannelBandwidth": "string",
"radioId": 0,
"txPower": "string"
}
],
"APSystem": {"gateway": "string",
"ipType": "string",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string",
"uptime": 0
},
"afcInfo": {"afcStatus": "string",
"availableChannel": 0,
"availableChannels": [0
],
"geoLocation": {"height": 0.1,
"lateralUncertainty": 0.1,
"latitude": 0.1,
"longitude": 0.1,
"source": "string",
"verticalUncertainty": 0.1
},
"maxPowerDbm": 0,
"minPowerDbm": 0,
"powerMode": "string"
},
"cellularInfo": {"cellular3G4GChannel": 0,
"cellularActiveSim": "string",
"cellularBand": "string",
"cellularCardRemovalCountSIM0": "string",
"cellularCardRemovalCountSIM1": "string",
"cellularConnectionStatus": "string",
"cellularCountry": "string",
"cellularDHCPTimeoutCountSIM0": "string",
"cellularDHCPTimeoutCountSIM1": "string",
"cellularDefaultGateway": "string",
"cellularDownlinkBandwidth": "string",
"cellularECIO": 0,
"cellularICCIDSIM0": "string",
"cellularICCIDSIM1": "string",
"cellularIMEI": "string",
"cellularIMSISIM0": "string",
"cellularIMSISIM1": "string",
"cellularIPaddress": "string",
"cellularIsSIM0Present": "string",
"cellularIsSIM1Present": "string",
"cellularLTEFirmware": "string",
"cellularNWLostCountSIM0": "string",
"cellularNWLostCountSIM1": "string",
"cellularOperator": "string",
"cellularRSCP": 0,
"cellularRSRP": 0,
"cellularRSRQ": 0,
"cellularRadioUptime": 0,
"cellularRoamingStatus": "string",
"cellularRxBytesSIM0": "string",
"cellularRxBytesSIM1": "string",
"cellularSINR": 0,
"cellularSignalStrength": "string",
"cellularSubnetMask": "string",
"cellularSwitchCountSIM0": "string",
"cellularSwitchCountSIM1": "string",
"cellularTxBytesSIM0": "string",
"cellularTxBytesSIM1": "string",
"cellularUplinkBandwidth": "string",
"cellularWanInterface": "string"
},
"lanPortStatus": [{"phyLink": "string",
"port": "string"
}
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceDto": {"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [{"Rssi": 0,
"actualTxPower": 0,
"band": "string",
"calibrationTxPower": 0,
"channel": 0,
"operativeChannelBandwidth": "string",
"radioId": 0,
"txPower": "string"
}
],
"APSystem": {"gateway": "string",
"ipType": "string",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string",
"uptime": 0
},
"afcInfo": {"afcStatus": "string",
"availableChannel": 0,
"availableChannels": [0
],
"geoLocation": {"height": 0.1,
"lateralUncertainty": 0.1,
"latitude": 0.1,
"longitude": 0.1,
"source": "string",
"verticalUncertainty": 0.1
},
"maxPowerDbm": 0,
"minPowerDbm": 0,
"powerMode": "string"
},
"cellularInfo": {"cellular3G4GChannel": 0,
"cellularActiveSim": "string",
"cellularBand": "string",
"cellularCardRemovalCountSIM0": "string",
"cellularCardRemovalCountSIM1": "string",
"cellularConnectionStatus": "string",
"cellularCountry": "string",
"cellularDHCPTimeoutCountSIM0": "string",
"cellularDHCPTimeoutCountSIM1": "string",
"cellularDefaultGateway": "string",
"cellularDownlinkBandwidth": "string",
"cellularECIO": 0,
"cellularICCIDSIM0": "string",
"cellularICCIDSIM1": "string",
"cellularIMEI": "string",
"cellularIMSISIM0": "string",
"cellularIMSISIM1": "string",
"cellularIPaddress": "string",
"cellularIsSIM0Present": "string",
"cellularIsSIM1Present": "string",
"cellularLTEFirmware": "string",
"cellularNWLostCountSIM0": "string",
"cellularNWLostCountSIM1": "string",
"cellularOperator": "string",
"cellularRSCP": 0,
"cellularRSRP": 0,
"cellularRSRQ": 0,
"cellularRadioUptime": 0,
"cellularRoamingStatus": "string",
"cellularRxBytesSIM0": "string",
"cellularRxBytesSIM1": "string",
"cellularSINR": 0,
"cellularSignalStrength": "string",
"cellularSubnetMask": "string",
"cellularSwitchCountSIM0": "string",
"cellularSwitchCountSIM1": "string",
"cellularTxBytesSIM0": "string",
"cellularTxBytesSIM1": "string",
"cellularUplinkBandwidth": "string",
"cellularWanInterface": "string"
},
"lanPortStatus": [{"phyLink": "string",
"port": "string"
}
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": "string",
"mac": "string",
"rssi": 0
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"uplink": [{ }
],
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": 0,
"wlanGroupId": "string",
"wlanGroupName": "string"
}
],
"xPercent": 0.1,
"yPercent": 0.1
},
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": "string",
"mac": "string",
"rssi": 0
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"rssi": 0,
"rxBytes": "string",
"rxFrames": "string",
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"txBytes": "string",
"txFrames": "string",
"type": 0,
"upMac": "string",
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": 0,
"wlanGroupId": "string",
"wlanGroupName": "string"
}
],
"xPercent": 0.1,
"yPercent": 0.1
}
],
"uplink.rssi": 0,
"uplink.upMac": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"xPercent": 0.1,
"yPercent": 0.1
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Export EC Inventory

Export the list of networking devices installed in our end customers venues.

path Parameters

mspTenantId

required

string

Tenant Id of the MSP.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{ }

Query MSP-ECs for Tech Partner

Query MSP-ECs for tech partner.

query Parameters

delegation

string

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"accountTier": "string",
"accountType": "string",
"apSwLicenses": 0,
"assignedMspEcList": ["string"
],
"city": "string",
"country": "string",
"creationDate": "string",
"customerCount": 0,
"delegatedTo": "string",
"delegationExpiryDate": 0,
"edgeLicenses": 0,
"entitlements": [{"accountType": "string",
"adaptivePolicyCount": "string",
"consumed": "string",
"edgeDeviceCount": "string",
"entitlementDeviceSubType": "string",
"entitlementDeviceType": "string",
"expirationDate": "string",
"expirationDateTs": "string",
"futureOfComplianceDate": "string",
"futureOutOfComplianceDevices": "string",
"outOfComplianceDevices": "string",
"piNetworkCount": "string",
"quantity": "string",
"rwgDeviceCount": "string",
"switchDeviceCount": "string",
"tenantId": "string",
"toBeRemovedQuantity": 0,
"type": "string",
"virtualEdgeDeviceCount": "string",
"wifiDeviceCount": "string"
}
],
"id": "string",
"installer": "string",
"installerCount": 0,
"installers": ["string"
],
"integrator": "string",
"integratorCount": 0,
"integrators": ["string"
],
"lastUpdTime": "string",
"mspAdminCount": 0,
"mspAdmins": ["string"
],
"mspEcAdminCount": 0,
"mspInstallerAdminCount": 0,
"mspInstallerAdmins": ["string"
],
"mspIntegratorAdminCount": 0,
"mspIntegratorAdmins": ["string"
],
"mspLabel": "string",
"mspName": "string",
"mspTenantId": "string",
"mspecId": "string",
"mspecName": "string",
"name": "string",
"postalCode": "string",
"priorityIncidents": {"p1": "string",
"p2": "string",
"p3": "string",
"p4": "string"
},
"rwgLicenses": 0,
"state": "string",
"status": "string",
"streetAddress": "string",
"switchLicenses": 0,
"tenantType": "string",
"virtualEdgeLicenses": 0,
"wifiLicenses": 0
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

View VLAN Pool Profiles

Manage VLAN Pool Profile.

Query VLAN Pool Profiles

Query VLAN pool profiles.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"id": "string",
"name": "string",
"vlanMembers": ["string"
],
"wifiNetworkIds": ["string"
],
"wifiNetworkVenueApGroups": [{"apGroupIds": ["string"
],
"isAllApGroups": true,
"venueId": "string",
"wifiNetworkId": "string"
}
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

View Switch

View Switch information. Note: this set of endpoints is used to view operational data. They don't provide the means to manage configuration.

Get Switches Aggregation Details Deprecated

Get parameters and operational data for a list of switches with aggregation details.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"clients": 0,
"deviceStatus": "string",
"incidents": 0,
"members": 0,
"model": "string",
"switches": [{"activeSerial": "string",
"adminPassword": "string",
"alerts": 0,
"cliApplied": true,
"clientCount": 0,
"cloudPort": "string",
"configReady": true,
"cpu": "string",
"crtTime": "string",
"defaultGateway": "string",
"deviceStatus": "string",
"deviceType": "string",
"dns": "string",
"domainId": "string",
"domainName": "string",
"extIp": "string",
"family": "string",
"fanGroups": "string",
"firmware": "string",
"firmwareVersion": "string",
"floorplanId": "string",
"formStacking": true,
"id": "string",
"ipAddress": "string",
"ipFullContentParsed": true,
"isStack": true,
"lastUpdTime": "string",
"lastUpdateTimeInMillis": "string",
"memory": "string",
"model": "string",
"modules": "string",
"name": "string",
"numOfPorts": 0,
"numOfUnits": 0,
"operationalStackMembers": "string",
"operationalWarning": true,
"poeFree": 0,
"poeTotal": 0,
"poeUtilization": 0,
"portStatuses": [{"adminStatus": "string",
"authDefaultVlan": "string",
"broadcastIn": "string",
"broadcastOut": "string",
"cloudPort": true,
"crcErr": "string",
"deviceStatus": "string",
"egressAclName": "string",
"errorDisableStatus": "string",
"id": "string",
"inDiscard": "string",
"inErr": "string",
"ingressAclName": "string",
"lagId": "string",
"lagName": "string",
"lagStatus": "string",
"mediaType": "string",
"multicastIn": "string",
"multicastOut": "string",
"name": "string",
"neighborMacAddress": "string",
"neighborName": "string",
"neighborPortMacAddress": "string",
"opticsType": "string",
"outErr": "string",
"poeEnabled": true,
"poeTotal": 0,
"poeType": "string",
"poeUsage": "string",
"poeUsed": 0,
"port": "string",
"portConnectorType": "string",
"portId": "string",
"portIdentifier": "string",
"portIdentifierFormatted": "string",
"portMac": "string",
"portSpeed": "string",
"portSpeedCapacity": "string",
"portSpeedConfig": "string",
"rx": "string",
"signalIn": 0,
"signalOut": 0,
"spanningTreeStatus": "string",
"stack": true,
"status": "string",
"switchMac": "string",
"switchModel": "string",
"switchName": "string",
"switchPortProfileName": "string",
"switchPortProfileType": "string",
"switchSerial": "string",
"switchUnitId": "string",
"syncedSwitchConfig": true,
"tags": "string",
"tenantId": "string",
"tx": "string",
"unTaggedVlan": "string",
"unitState": "string",
"unitStatus": "string",
"usedInFormingStack": true,
"venueId": "string",
"vlanIds": "string",
"vsixEgressAclName": "string",
"vsixIngressAclName": "string"
}
],
"powerSupplyGroups": "string",
"provisionName": "string",
"rearModule": "string",
"serialNumber": "string",
"stackMemberOrder": "string",
"stackMembers": [{"id": "string",
"model": "string"
}
],
"stackMembersStatus": [{"domainId": "string",
"domainName": "string",
"id": "string",
"poeFree": 0,
"poeTotal": 0,
"poeUtilization": 0,
"switchGroupLevelOneId": "string",
"switchGroupLevelOneName": "string",
"switchGroupLevelTwoId": "string",
"switchId": "string",
"unitId": 0,
"unitName": "string",
"unitState": "string",
"unitStatus": "string"
}
],
"staticOrDynamic": "string",
"subnetMask": "string",
"suspendingDeployTime": "string",
"switchGroupLevelOneId": "string",
"switchGroupLevelOneName": "string",
"switchGroupLevelTwoId": "string",
"switchMac": "string",
"switchName": "string",
"switchType": "string",
"syncDataEndTime": "string",
"syncDataId": "string",
"syncDataStartTime": "string",
"syncedAdminPassword": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenantId": "string",
"type": "string",
"unitId": 0,
"unitSerialNumbers": "string",
"uptime": "string",
"veCount": 0,
"venueId": "string",
"venueName": "string",
"vlanMapping": "string",
"xPercent": 0.1,
"yPercent": 0.1
}
],
"venueId": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Switch Clients Deprecated

Get a list of switch clients (i.e., end-user devices).

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"clientAuthType": "string",
"clientDesc": "string",
"clientIpv4Addr": "string",
"clientIpv6Addr": "string",
"clientMac": "string",
"clientName": "string",
"clientType": "string",
"clientVlan": "string",
"dhcpClientDeviceTypeName": "string",
"dhcpClientHostName": "string",
"dhcpClientModelName": "string",
"dhcpClientOsVendorName": "string",
"id": "string",
"isRuckusAP": true,
"switchId": "string",
"switchMac": "string",
"switchName": "string",
"switchPort": "string",
"switchPortId": "string",
"switchSerialNumber": "string",
"venueId": "string",
"venueName": "string",
"vlanName": "string",
"vni": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Ports Deprecated

Get a list of parameters for the switch's ports.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"adminStatus": "string",
"authDefaultVlan": "string",
"broadcastIn": "string",
"broadcastOut": "string",
"cloudPort": true,
"crcErr": "string",
"deviceStatus": "string",
"egressAclName": "string",
"errorDisableStatus": "string",
"id": "string",
"inDiscard": "string",
"inErr": "string",
"ingressAclName": "string",
"lagId": "string",
"lagName": "string",
"lagStatus": "string",
"mediaType": "string",
"multicastIn": "string",
"multicastOut": "string",
"name": "string",
"neighborMacAddress": "string",
"neighborName": "string",
"neighborPortMacAddress": "string",
"opticsType": "string",
"outErr": "string",
"poeEnabled": true,
"poeTotal": 0,
"poeType": "string",
"poeUsage": "string",
"poeUsed": 0,
"port": "string",
"portConnectorType": "string",
"portId": "string",
"portIdentifier": "string",
"portIdentifierFormatted": "string",
"portMac": "string",
"portSpeed": "string",
"portSpeedCapacity": "string",
"portSpeedConfig": "string",
"rx": "string",
"signalIn": 0,
"signalOut": 0,
"spanningTreeStatus": "string",
"stack": true,
"status": "string",
"switchMac": "string",
"switchModel": "string",
"switchName": "string",
"switchPortProfileName": "string",
"switchPortProfileType": "string",
"switchSerial": "string",
"switchUnitId": "string",
"syncedSwitchConfig": true,
"tags": "string",
"tenantId": "string",
"tx": "string",
"unTaggedVlan": "string",
"unitState": "string",
"unitStatus": "string",
"usedInFormingStack": true,
"venueId": "string",
"vlanIds": "string",
"vsixEgressAclName": "string",
"vsixIngressAclName": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Export Switch Inventory Deprecated

Export the list of switches belong to the tenant.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{ }

Get Switches Aggregation Details

Get parameters and operational data for a list of switches with aggregation details.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"clients": 0,
"deviceStatus": "string",
"incidents": 0,
"members": 0,
"model": "string",
"switches": [{"activeSerial": "string",
"adminPassword": "string",
"alerts": 0,
"cliApplied": true,
"clientCount": 0,
"cloudPort": "string",
"configReady": true,
"cpu": "string",
"crtTime": "string",
"defaultGateway": "string",
"deviceStatus": "string",
"deviceType": "string",
"dns": "string",
"domainId": "string",
"domainName": "string",
"extIp": "string",
"family": "string",
"fanGroups": "string",
"firmware": "string",
"firmwareVersion": "string",
"floorplanId": "string",
"formStacking": true,
"id": "string",
"ipAddress": "string",
"ipFullContentParsed": true,
"isStack": true,
"lastUpdTime": "string",
"lastUpdateTimeInMillis": "string",
"memory": "string",
"model": "string",
"modules": "string",
"name": "string",
"numOfPorts": 0,
"numOfUnits": 0,
"operationalStackMembers": "string",
"operationalWarning": true,
"poeFree": 0,
"poeTotal": 0,
"poeUtilization": 0,
"portStatuses": [{"adminStatus": "string",
"authDefaultVlan": "string",
"broadcastIn": "string",
"broadcastOut": "string",
"cloudPort": true,
"crcErr": "string",
"deviceStatus": "string",
"egressAclName": "string",
"errorDisableStatus": "string",
"id": "string",
"inDiscard": "string",
"inErr": "string",
"ingressAclName": "string",
"lagId": "string",
"lagName": "string",
"lagStatus": "string",
"mediaType": "string",
"multicastIn": "string",
"multicastOut": "string",
"name": "string",
"neighborMacAddress": "string",
"neighborName": "string",
"neighborPortMacAddress": "string",
"opticsType": "string",
"outErr": "string",
"poeEnabled": true,
"poeTotal": 0,
"poeType": "string",
"poeUsage": "string",
"poeUsed": 0,
"port": "string",
"portConnectorType": "string",
"portId": "string",
"portIdentifier": "string",
"portIdentifierFormatted": "string",
"portMac": "string",
"portSpeed": "string",
"portSpeedCapacity": "string",
"portSpeedConfig": "string",
"rx": "string",
"signalIn": 0,
"signalOut": 0,
"spanningTreeStatus": "string",
"stack": true,
"status": "string",
"switchMac": "string",
"switchModel": "string",
"switchName": "string",
"switchPortProfileName": "string",
"switchPortProfileType": "string",
"switchSerial": "string",
"switchUnitId": "string",
"syncedSwitchConfig": true,
"tags": "string",
"tenantId": "string",
"tx": "string",
"unTaggedVlan": "string",
"unitState": "string",
"unitStatus": "string",
"usedInFormingStack": true,
"venueId": "string",
"vlanIds": "string",
"vsixEgressAclName": "string",
"vsixIngressAclName": "string"
}
],
"powerSupplyGroups": "string",
"provisionName": "string",
"rearModule": "string",
"serialNumber": "string",
"stackMemberOrder": "string",
"stackMembers": [{"id": "string",
"model": "string"
}
],
"stackMembersStatus": [{"domainId": "string",
"domainName": "string",
"id": "string",
"poeFree": 0,
"poeTotal": 0,
"poeUtilization": 0,
"switchGroupLevelOneId": "string",
"switchGroupLevelOneName": "string",
"switchGroupLevelTwoId": "string",
"switchId": "string",
"unitId": 0,
"unitName": "string",
"unitState": "string",
"unitStatus": "string"
}
],
"staticOrDynamic": "string",
"subnetMask": "string",
"suspendingDeployTime": "string",
"switchGroupLevelOneId": "string",
"switchGroupLevelOneName": "string",
"switchGroupLevelTwoId": "string",
"switchMac": "string",
"switchName": "string",
"switchType": "string",
"syncDataEndTime": "string",
"syncDataId": "string",
"syncDataStartTime": "string",
"syncedAdminPassword": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenantId": "string",
"type": "string",
"unitId": 0,
"unitSerialNumbers": "string",
"uptime": "string",
"veCount": 0,
"venueId": "string",
"venueName": "string",
"vlanMapping": "string",
"xPercent": 0.1,
"yPercent": 0.1
}
],
"venueId": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Switch Clients

Get a list of switch clients (i.e., end-user devices).

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"clientAuthType": "string",
"clientDesc": "string",
"clientIpv4Addr": "string",
"clientIpv6Addr": "string",
"clientMac": "string",
"clientName": "string",
"clientType": "string",
"clientVlan": "string",
"dhcpClientDeviceTypeName": "string",
"dhcpClientHostName": "string",
"dhcpClientModelName": "string",
"dhcpClientOsVendorName": "string",
"id": "string",
"isRuckusAP": true,
"switchId": "string",
"switchMac": "string",
"switchName": "string",
"switchPort": "string",
"switchPortId": "string",
"switchSerialNumber": "string",
"venueId": "string",
"venueName": "string",
"vlanName": "string",
"vni": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Switches of Venue

Get a list of switches of venue.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"activeSerial": "string",
"adminPassword": "string",
"alerts": 0,
"cliApplied": true,
"clientCount": 0,
"cloudPort": "string",
"configReady": true,
"cpu": "string",
"crtTime": "string",
"defaultGateway": "string",
"deviceStatus": "string",
"deviceType": "string",
"dns": "string",
"domainId": "string",
"domainName": "string",
"extIp": "string",
"family": "string",
"fanGroups": "string",
"firmware": "string",
"firmwareVersion": "string",
"floorplanId": "string",
"formStacking": true,
"id": "string",
"ipAddress": "string",
"ipFullContentParsed": true,
"isStack": true,
"lastUpdTime": "string",
"lastUpdateTimeInMillis": "string",
"memory": "string",
"model": "string",
"modules": "string",
"name": "string",
"numOfPorts": 0,
"numOfUnits": 0,
"operationalStackMembers": "string",
"operationalWarning": true,
"poeFree": 0,
"poeTotal": 0,
"poeUtilization": 0,
"portStatuses": [{"adminStatus": "string",
"authDefaultVlan": "string",
"broadcastIn": "string",
"broadcastOut": "string",
"cloudPort": true,
"crcErr": "string",
"deviceStatus": "string",
"egressAclName": "string",
"errorDisableStatus": "string",
"id": "string",
"inDiscard": "string",
"inErr": "string",
"ingressAclName": "string",
"lagId": "string",
"lagName": "string",
"lagStatus": "string",
"mediaType": "string",
"multicastIn": "string",
"multicastOut": "string",
"name": "string",
"neighborMacAddress": "string",
"neighborName": "string",
"neighborPortMacAddress": "string",
"opticsType": "string",
"outErr": "string",
"poeEnabled": true,
"poeTotal": 0,
"poeType": "string",
"poeUsage": "string",
"poeUsed": 0,
"port": "string",
"portConnectorType": "string",
"portId": "string",
"portIdentifier": "string",
"portIdentifierFormatted": "string",
"portMac": "string",
"portSpeed": "string",
"portSpeedCapacity": "string",
"portSpeedConfig": "string",
"rx": "string",
"signalIn": 0,
"signalOut": 0,
"spanningTreeStatus": "string",
"stack": true,
"status": "string",
"switchMac": "string",
"switchModel": "string",
"switchName": "string",
"switchPortProfileName": "string",
"switchPortProfileType": "string",
"switchSerial": "string",
"switchUnitId": "string",
"syncedSwitchConfig": true,
"tags": "string",
"tenantId": "string",
"tx": "string",
"unTaggedVlan": "string",
"unitState": "string",
"unitStatus": "string",
"usedInFormingStack": true,
"venueId": "string",
"vlanIds": "string",
"vsixEgressAclName": "string",
"vsixIngressAclName": "string"
}
],
"powerSupplyGroups": "string",
"provisionName": "string",
"rearModule": "string",
"serialNumber": "string",
"stackMemberOrder": "string",
"stackMembers": [{"id": "string",
"model": "string"
}
],
"stackMembersStatus": [{"domainId": "string",
"domainName": "string",
"id": "string",
"poeFree": 0,
"poeTotal": 0,
"poeUtilization": 0,
"switchGroupLevelOneId": "string",
"switchGroupLevelOneName": "string",
"switchGroupLevelTwoId": "string",
"switchId": "string",
"unitId": 0,
"unitName": "string",
"unitState": "string",
"unitStatus": "string"
}
],
"staticOrDynamic": "string",
"subnetMask": "string",
"suspendingDeployTime": "string",
"switchGroupLevelOneId": "string",
"switchGroupLevelOneName": "string",
"switchGroupLevelTwoId": "string",
"switchMac": "string",
"switchName": "string",
"switchType": "string",
"syncDataEndTime": "string",
"syncDataId": "string",
"syncDataStartTime": "string",
"syncedAdminPassword": true,
"syncedSwitchConfig": true,
"tags": "string",
"tenantId": "string",
"type": "string",
"unitId": 0,
"unitSerialNumbers": "string",
"uptime": "string",
"veCount": 0,
"venueId": "string",
"venueName": "string",
"vlanMapping": "string",
"xPercent": 0.1,
"yPercent": 0.1
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Export Switch Inventory

Export the list of switches belong to the tenant.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{ }

Query Switch Ports

Get a list of parameters for the switch's ports.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"adminStatus": "string",
"authDefaultVlan": "string",
"broadcastIn": "string",
"broadcastOut": "string",
"cloudPort": true,
"crcErr": "string",
"deviceStatus": "string",
"egressAclName": "string",
"errorDisableStatus": "string",
"id": "string",
"inDiscard": "string",
"inErr": "string",
"ingressAclName": "string",
"lagId": "string",
"lagName": "string",
"lagStatus": "string",
"mediaType": "string",
"multicastIn": "string",
"multicastOut": "string",
"name": "string",
"neighborMacAddress": "string",
"neighborName": "string",
"neighborPortMacAddress": "string",
"opticsType": "string",
"outErr": "string",
"poeEnabled": true,
"poeTotal": 0,
"poeType": "string",
"poeUsage": "string",
"poeUsed": 0,
"port": "string",
"portConnectorType": "string",
"portId": "string",
"portIdentifier": "string",
"portIdentifierFormatted": "string",
"portMac": "string",
"portSpeed": "string",
"portSpeedCapacity": "string",
"portSpeedConfig": "string",
"rx": "string",
"signalIn": 0,
"signalOut": 0,
"spanningTreeStatus": "string",
"stack": true,
"status": "string",
"switchMac": "string",
"switchModel": "string",
"switchName": "string",
"switchPortProfileName": "string",
"switchPortProfileType": "string",
"switchSerial": "string",
"switchUnitId": "string",
"syncedSwitchConfig": true,
"tags": "string",
"tenantId": "string",
"tx": "string",
"unTaggedVlan": "string",
"unitState": "string",
"unitStatus": "string",
"usedInFormingStack": true,
"venueId": "string",
"vlanIds": "string",
"vsixEgressAclName": "string",
"vsixIngressAclName": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

View Venue

View venue information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Get Venues

Return a list of venue records.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"addressLine": "string",
"city": "string",
"country": "string",
"countryCode": "string",
"crtTime": "string",
"currentApFirmwares": [{"apModel": "string",
"firmware": "string"
}
],
"description": "string",
"dhcp": {"enabled": true,
"mode": "string"
},
"dpGroupId": "string",
"id": "string",
"isApFirmwareUpToDate": true,
"isTemplate": true,
"lastApFirmwareUpdate": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"mesh": {"enabled": true
},
"name": "string",
"nextApFirmwareSchedules": [{"startDateTime": "string",
"versionInfo": {"category": "string",
"type": "string",
"version": "string"
}
}
],
"notes": "string",
"rogueDetection": {"enabled": true,
"policyId": "string",
"policyName": "string"
},
"switchProfileId": "string",
"switchProfileName": "string",
"syslogServer": {"enabled": true,
"policyId": "string",
"policyName": "string"
},
"tenantId": "string",
"timeZone": "string",
"type": "string",
"wifiFirmwareVersion": "string"
}

Get Venue AP Models Deprecated

This API is deprecated. Please use the latest API. The deprecated API is used to retrieve the AP models deployed in this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

200

Content type

application/json

{"models": ["string"
]
}

Get Venue AP Models

Get the AP models deployed in this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

200

Content type

application/json

{"models": ["string"
]
}

Get Venue Rogue APs

Get the list of rogue APs located in this venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"band": "string",
"category": "string",
"channel": 0,
"classificationPolicyName": "string",
"classificationRuleName": "string",
"closestAp": {"apMac": "string",
"apName": "string",
"apSerialNumber": "string",
"lastUpdTime": "string",
"snr": 0
},
"detectingAps": [{"apMac": "string",
"apName": "string",
"apSerialNumber": "string",
"lastUpdTime": "string",
"snr": 0
}
],
"lastDetectingAp": {"apMac": "string",
"apName": "string",
"apSerialNumber": "string",
"lastUpdTime": "string",
"snr": 0
},
"lastUpdTime": "string",
"locatable": true,
"numberOfDetectingAps": 0,
"rogueApMac": "string",
"rogueMac": "string",
"ssid": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

View Wi-Fi Profile

View Wi-Fi Service & Policy information

Get Access Control Profiles

Get data for a list of access control profiles.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"applicationPolicyId": "string",
"applicationPolicyName": "string",
"clientRateDownLinkLimit": 0,
"clientRateUpLinkLimit": 0,
"devicePolicyId": "string",
"devicePolicyName": "string",
"id": "string",
"l2AclPolicyId": "string",
"l2AclPolicyName": "string",
"l3AclPolicyId": "string",
"l3AclPolicyName": "string",
"name": "string",
"wifiNetworkIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Application Policies

Get data for a list of application policies.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"description": "string",
"id": "string",
"name": "string",
"rules": 0,
"wifiNetworkIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Device Policies

Get data for a list of device policies.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"description": "string",
"id": "string",
"name": "string",
"rules": 0,
"wifiNetworkIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get DHCP Configuration Service Profiles

Query DHCP configuration service profiles for the list.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"dhcpPools": [{"endAddress": "string",
"name": "string",
"networkAddress": "string",
"startAddress": "string"
}
],
"id": "string",
"name": "string",
"venueIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Access Control Profiles Deprecated

Get data for a list of access control profiles.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"applicationPolicyId": "string",
"applicationPolicyName": "string",
"clientRateDownLinkLimit": 0,
"clientRateUpLinkLimit": 0,
"devicePolicyId": "string",
"devicePolicyName": "string",
"id": "string",
"l2AclPolicyId": "string",
"l2AclPolicyName": "string",
"l3AclPolicyId": "string",
"l3AclPolicyName": "string",
"name": "string",
"networkCount": 0,
"networkIds": ["string"
],
"tenantId": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Application Policies Deprecated

Get data for a list of application policies.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"description": "string",
"id": "string",
"macAddressCount": 0,
"name": "string",
"networkCount": 0,
"networkIds": ["string"
],
"rules": 0,
"tenantId": "string",
"type": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Device Policies Deprecated

Get data for a list of device policies.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"description": "string",
"id": "string",
"macAddressCount": 0,
"name": "string",
"networkCount": 0,
"networkIds": ["string"
],
"rules": 0,
"tenantId": "string",
"type": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get DHCP Configuration Service Profiles Deprecated

Get data for a list of DHCP configuration service profiles.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"dhcpPools": [{"endAddress": "string",
"name": "string",
"networkAddress": "string",
"startAddress": "string"
}
],
"id": "string",
"name": "string",
"technology": "string",
"tenantId": "string",
"venueCount": 0,
"venueIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Client Isolation Allowlists Deprecated

Get data for a list of client isolation allowlists.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"clientEntries": ["string"
],
"description": "string",
"id": "string",
"name": "string",
"tenantId": "string",
"venueCount": 0,
"venueIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Layer Two Policies Deprecated

Get data for a list of layer 2 policies.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"description": "string",
"id": "string",
"macAddressCount": 0,
"name": "string",
"networkCount": 0,
"networkIds": ["string"
],
"rules": 0,
"tenantId": "string",
"type": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Layer Three Policies Deprecated

Get data for a list of layer 3 policies.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"description": "string",
"id": "string",
"macAddressCount": 0,
"name": "string",
"networkCount": 0,
"networkIds": ["string"
],
"rules": 0,
"tenantId": "string",
"type": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Multicast DNS Proxy Profiles Deprecated

Get data for a list of multicast DNS proxy service profiles.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"id": "string",
"name": "string",
"rules": [{"enabled": true,
"fromVlan": 0,
"mdnsName": "string",
"mdnsProtocol": "string",
"ruleIndex": 0,
"service": "string",
"toVlan": 0
}
],
"tenantId": "string",
"venueIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get RADIUS Server Profiles Deprecated

Get data for a list of RADIUS server profiles.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"hotspot20IdentityProviderIds": ["string"
],
"id": "string",
"name": "string",
"networkCount": 0,
"networkIds": ["string"
],
"primary": "string",
"secondary": "string",
"tenantId": "string",
"type": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Rogue AP Policy Profiles Deprecated

Get data for a list of rogue AP policies.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"description": "string",
"id": "string",
"name": "string",
"numOfRules": 0,
"tenantId": "string",
"venueCount": 0,
"venueIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Syslog Server Profiles Deprecated

Get data for a list of syslog server profiles.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"facility": "string",
"flowLevel": "string",
"id": "string",
"name": "string",
"primaryServer": "string",
"secondaryServer": "string",
"tenantId": "string",
"venueIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get VLAN Pool Profiles Deprecated

Get data for a list of VLAN pool policy profiles.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"id": "string",
"name": "string",
"tenantId": "string",
"venueApGroups": [{"apGroups": [{"allApGroups": true,
"default": true,
"id": "string"
}
],
"id": "string"
}
],
"venueIds": ["string"
],
"vlanMembers": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Wifi Calling Profiles Deprecated

Get data for a list of wifi calling service profiles.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"epdgs": [{"domain": "string",
"ip": "string"
}
],
"id": "string",
"name": "string",
"networkIds": ["string"
],
"qosPriority": "string",
"tenantId": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Hotspot 2.0 Identity Providers

Get data for a list of Hotspot 2.0 identity providers.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"accountingRadiusId": "string",
"authRadiusId": "string",
"id": "string",
"naiRealms": [{"eaps": [{"method": "string"
}
],
"name": "string"
}
],
"name": "string",
"plmns": [{"mcc": "string",
"mnc": "string"
}
],
"roamConsortiumOIs": [{"name": "string",
"organizationId": "string"
}
],
"wifiNetworkIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Hotspot 2.0 Operators

Get data for a list of Hotspot 2.0 operators.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"domainNames": ["string"
],
"friendlyNames": [{"language": "string",
"name": "string"
}
],
"id": "string",
"name": "string",
"wifiNetworkIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Layer Two Policies

Get data for a list of layer 2 policies.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"description": "string",
"id": "string",
"macAddressCount": 0,
"name": "string",
"wifiNetworkIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Layer Three Policies

Get data for a list of layer 3 policies.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"description": "string",
"id": "string",
"name": "string",
"rules": 0,
"wifiNetworkIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Location Based Service Server Profiles

Get data for a list of location based service server profiles.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"id": "string",
"lbsServerVenueName": "string",
"name": "string",
"server": "string",
"serverConnected": true,
"venueIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Multicast DNS Proxy Profiles

Get data for a list of multicast DNS proxy service profiles.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"activations": [{"venueId": "string",
"wifiNetworkIds": ["string"
]
}
],
"id": "string",
"name": "string",
"rules": [{"enabled": true,
"fromVlan": 0,
"mdnsName": "string",
"mdnsProtocol": "string",
"ruleIndex": 0,
"service": "string",
"toVlan": 0
}
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get RADIUS Server Profiles

Get data for a list of RADIUS server profiles.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"id": "string",
"name": "string",
"primary": "string",
"secondary": "string",
"type": "string",
"wifiNetworkIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Rogue Policies

Get the list of rogue policies in this tenant.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"description": "string",
"id": "string",
"name": "string",
"numOfRules": 0,
"venueIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Syslog Server Profiles

Get data for a list of syslog server profiles.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"facility": "string",
"flowLevel": "string",
"id": "string",
"name": "string",
"primaryServer": "string",
"secondaryServer": "string",
"venueIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Tunnel Profiles

Get data for a list of tunnel profiles. This is only permitted for users with feature flag edge role.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"ageTimeMinutes": 0,
"ageTimeUnit": "string",
"forceFragmentation": true,
"id": "string",
"keepAliveInterval": 0,
"keepAliveRetry": 0,
"mtuRequestRetry": 0,
"mtuRequestTimeout": 0,
"mtuSize": 0,
"mtuType": "string",
"name": "string",
"natTraversalEnabled": true,
"networkIds": ["string"
],
"personalIdentityNetworkIds": ["string"
],
"sdLanIds": ["string"
],
"tags": ["string"
],
"type": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Wifi Calling Profiles

Get data for a list of wifi calling service profiles.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"epdgs": [{"domain": "string",
"ip": "string"
}
],
"id": "string",
"name": "string",
"qosPriority": "string",
"wifiNetworkIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

View Portal Service Profiles

Manage Portal Service Profile.

Query Portal Service Profiles

Query portal service profile for the list.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"displayLangCode": "string",
"id": "string",
"name": "string",
"wifiNetworkIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

View Client Isolation Profiles

Manage Client Isolation Profile.

Query Client Isolation Profiles

Query client isolation profile for the list.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"activations": [{"venueId": "string",
"wifiNetworkIds": ["string"
]
}
],
"clientEntries": ["string"
],
"description": "string",
"id": "string",
"name": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

View Venue Topology

View Venue Topology information.

Get Mesh Topology

Get venue's mesh topology data.

path Parameters

venueId

required

string

Responses

Response samples

200
501

Content type

application/json

{"data": [{"edges": [{"band": "string",
"channel": 0,
"connectedPort": "string",
"connectedPortTaggedVlan": "string",
"connectedPortUntaggedVlan": "string",
"connectionStatus": "Good",
"connectionType": "Wired",
"correspondingPort": "string",
"correspondingPortTaggedVlan": "string",
"correspondingPortUntaggedVlan": "string",
"extraEdges": [{"connectedPort": "string",
"connectedPortTaggedVlan": "string",
"connectedPortUntaggedVlan": "string",
"connectionStatus": "Good",
"connectionType": "Wired",
"correspondingPort": "string",
"correspondingPortTaggedVlan": "string",
"correspondingPortUntaggedVlan": "string",
"linkSpeed": "string",
"poeEnabled": true,
"poeTotal": 0,
"poeUsed": 0
}
],
"from": "string",
"fromMac": "string",
"fromName": "string",
"fromRole": "string",
"fromSNR": 0,
"fromSerial": "string",
"linkSpeed": "string",
"poeEnabled": true,
"poeTotal": 0,
"poeUsed": 0,
"to": "string",
"toMac": "string",
"toName": "string",
"toRole": "string",
"toSNR": 0,
"toSerial": "string"
}
],
"nodes": [{"childCount": 0,
"cloudPort": "string",
"downlink": [{"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [{"Rssi": null,
"actualTxPower": null,
"band": null,
"calibrationTxPower": null,
"channel": null,
"operativeChannelBandwidth": null,
"radioId": null,
"txPower": null
}
],
"APSystem": {"gateway": "string",
"ipType": "string",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string",
"uptime": 0
},
"afcInfo": {"afcStatus": "string",
"availableChannel": 0,
"availableChannels": [null
],
"geoLocation": {"height": null,
"lateralUncertainty": null,
"latitude": null,
"longitude": null,
"source": null,
"verticalUncertainty": null
},
"maxPowerDbm": 0,
"minPowerDbm": 0,
"powerMode": "string"
},
"cellularInfo": {"cellular3G4GChannel": 0,
"cellularActiveSim": "string",
"cellularBand": "string",
"cellularCardRemovalCountSIM0": "string",
"cellularCardRemovalCountSIM1": "string",
"cellularConnectionStatus": "string",
"cellularCountry": "string",
"cellularDHCPTimeoutCountSIM0": "string",
"cellularDHCPTimeoutCountSIM1": "string",
"cellularDefaultGateway": "string",
"cellularDownlinkBandwidth": "string",
"cellularECIO": 0,
"cellularICCIDSIM0": "string",
"cellularICCIDSIM1": "string",
"cellularIMEI": "string",
"cellularIMSISIM0": "string",
"cellularIMSISIM1": "string",
"cellularIPaddress": "string",
"cellularIsSIM0Present": "string",
"cellularIsSIM1Present": "string",
"cellularLTEFirmware": "string",
"cellularNWLostCountSIM0": "string",
"cellularNWLostCountSIM1": "string",
"cellularOperator": "string",
"cellularRSCP": 0,
"cellularRSRP": 0,
"cellularRSRQ": 0,
"cellularRadioUptime": 0,
"cellularRoamingStatus": "string",
"cellularRxBytesSIM0": "string",
"cellularRxBytesSIM1": "string",
"cellularSINR": 0,
"cellularSignalStrength": "string",
"cellularSubnetMask": "string",
"cellularSwitchCountSIM0": "string",
"cellularSwitchCountSIM1": "string",
"cellularTxBytesSIM0": "string",
"cellularTxBytesSIM1": "string",
"cellularUplinkBandwidth": "string",
"cellularWanInterface": "string"
},
"lanPortStatus": [{"phyLink": null,
"port": null
}
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceDto": {"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [null
],
"APSystem": {"gateway": null,
"ipType": null,
"netmask": null,
"primaryDnsServer": null,
"secondaryDnsServer": null,
"uptime": null
},
"afcInfo": {"afcStatus": null,
"availableChannel": null,
"availableChannels": [ ],
"geoLocation": null,
"maxPowerDbm": null,
"minPowerDbm": null,
"powerMode": null
},
"cellularInfo": {"cellular3G4GChannel": null,
"cellularActiveSim": null,
"cellularBand": null,
"cellularCardRemovalCountSIM0": null,
"cellularCardRemovalCountSIM1": null,
"cellularConnectionStatus": null,
"cellularCountry": null,
"cellularDHCPTimeoutCountSIM0": null,
"cellularDHCPTimeoutCountSIM1": null,
"cellularDefaultGateway": null,
"cellularDownlinkBandwidth": null,
"cellularECIO": null,
"cellularICCIDSIM0": null,
"cellularICCIDSIM1": null,
"cellularIMEI": null,
"cellularIMSISIM0": null,
"cellularIMSISIM1": null,
"cellularIPaddress": null,
"cellularIsSIM0Present": null,
"cellularIsSIM1Present": null,
"cellularLTEFirmware": null,
"cellularNWLostCountSIM0": null,
"cellularNWLostCountSIM1": null,
"cellularOperator": null,
"cellularRSCP": null,
"cellularRSRP": null,
"cellularRSRQ": null,
"cellularRadioUptime": null,
"cellularRoamingStatus": null,
"cellularRxBytesSIM0": null,
"cellularRxBytesSIM1": null,
"cellularSINR": null,
"cellularSignalStrength": null,
"cellularSubnetMask": null,
"cellularSwitchCountSIM0": null,
"cellularSwitchCountSIM1": null,
"cellularTxBytesSIM0": null,
"cellularTxBytesSIM1": null,
"cellularUplinkBandwidth": null,
"cellularWanInterface": null
},
"lanPortStatus": [null
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": null,
"mac": null,
"rssi": null
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"uplink": [{"IP": null,
"apGroupId": null,
"apGroupName": null,
"apMac": null,
"apNeighborMacs": [ ],
"apNeighborRssis": [ ],
"apRadioDeploy": null,
"apStatusData": null,
"clients": null,
"configStatus": null,
"connectionStatus": null,
"crtTime": null,
"description": null,
"deviceDto": null,
"deviceGroupId": null,
"deviceGroupName": null,
"deviceModelType": null,
"deviceSessionCacheWeight": null,
"deviceStatus": null,
"deviceStatusSeverity": null,
"downLinkCount": null,
"downlink.downMac": [ ],
"downlink.rssi": [ ],
"downlink.type": [ ],
"downlinkChannel": null,
"downlinkCount": null,
"extIp": null,
"externalPort": null,
"floorplanId": null,
"fwVersion": null,
"geolocationSource": null,
"healthStatus": null,
"hops": null,
"isMeshEnable": null,
"lastSeenTime": null,
"lastUpdTime": null,
"latitude": null,
"longitude": null,
"meshRole": null,
"model": null,
"name": null,
"neighbors": [ ],
"poePort": null,
"reboot": null,
"rogueCategory": { },
"rssi": null,
"rxBytes": null,
"rxFrames": null,
"serialNumber": null,
"switchId": null,
"switchName": null,
"switchPort": null,
"switchSerialNumber": null,
"tags": null,
"tenantId": null,
"txBytes": null,
"txFrames": null,
"type": null,
"upMac": null,
"uplink.rssi": null,
"uplink.type": [ ],
"uplink.upMac": null,
"uplinkChannel": null,
"venueId": null,
"venueName": null,
"wlanGroup24GId": null,
"wlanGroup5GId": null,
"wlanGroups": [ ],
"xPercent": null,
"yPercent": null
}
],
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": null,
"wlanGroupId": null,
"wlanGroupName": null
}
],
"xPercent": 0.1,
"yPercent": 0.1
},
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downMac": "string",
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": "string",
"mac": "string",
"rssi": 0
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"rssi": 0,
"rxBytes": "string",
"rxFrames": "string",
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"txBytes": "string",
"txFrames": "string",
"type": 0,
"uplink": [{"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": [null
],
"apNeighborRssis": [null
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [ ],
"APSystem": null,
"afcInfo": null,
"cellularInfo": null,
"lanPortStatus": [ ]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceDto": {"IP": null,
"apGroupId": null,
"apGroupName": null,
"apMac": null,
"apNeighborMacs": [ ],
"apNeighborRssis": [ ],
"apRadioDeploy": null,
"apStatusData": null,
"clients": null,
"configStatus": null,
"connectionStatus": null,
"crtTime": null,
"description": null,
"deviceGroupId": null,
"deviceGroupName": null,
"deviceModelType": null,
"deviceSessionCacheWeight": null,
"deviceStatus": null,
"deviceStatusSeverity": null,
"downLinkCount": null,
"downlink.downMac": [ ],
"downlink.rssi": [ ],
"downlink.type": [ ],
"downlinkChannel": null,
"downlinkCount": null,
"extIp": null,
"externalPort": null,
"floorplanId": null,
"fwVersion": null,
"geolocationSource": null,
"healthStatus": null,
"hops": null,
"isMeshEnable": null,
"lastSeenTime": null,
"lastUpdTime": null,
"latitude": null,
"longitude": null,
"meshRole": null,
"model": null,
"name": null,
"neighbors": [ ],
"poePort": null,
"reboot": null,
"rogueCategory": { },
"serialNumber": null,
"switchId": null,
"switchName": null,
"switchPort": null,
"switchSerialNumber": null,
"tags": null,
"tenantId": null,
"uplink": [ ],
"uplink.rssi": null,
"uplink.type": [ ],
"uplink.upMac": null,
"uplinkChannel": null,
"venueId": null,
"venueName": null,
"wlanGroup24GId": null,
"wlanGroup5GId": null,
"wlanGroups": [ ],
"xPercent": null,
"yPercent": null
},
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": [null
],
"downlink.rssi": [null
],
"downlink.type": [null
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [null
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": null,
"property2": null
},
"rssi": 0,
"rxBytes": "string",
"rxFrames": "string",
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"txBytes": "string",
"txFrames": "string",
"type": 0,
"upMac": "string",
"uplink.rssi": 0,
"uplink.type": [null
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [null
],
"xPercent": 0.1,
"yPercent": 0.1
}
],
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": 0,
"wlanGroupId": "string",
"wlanGroupName": "string"
}
],
"xPercent": 0.1,
"yPercent": 0.1
}
],
"downlinkChannel": "string",
"downlinkType": [0
],
"id": "string",
"ipAddress": "string",
"isConnectedCloud": true,
"isMeshEnable": true,
"mac": "string",
"meshRole": "string",
"name": "string",
"parentId": "string",
"parentMac": "string",
"serial": "string",
"status": "Operational",
"taggedVlan": "string",
"type": "Switch",
"untaggedVlan": "string",
"uplink": [{"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [{"Rssi": null,
"actualTxPower": null,
"band": null,
"calibrationTxPower": null,
"channel": null,
"operativeChannelBandwidth": null,
"radioId": null,
"txPower": null
}
],
"APSystem": {"gateway": "string",
"ipType": "string",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string",
"uptime": 0
},
"afcInfo": {"afcStatus": "string",
"availableChannel": 0,
"availableChannels": [null
],
"geoLocation": {"height": null,
"lateralUncertainty": null,
"latitude": null,
"longitude": null,
"source": null,
"verticalUncertainty": null
},
"maxPowerDbm": 0,
"minPowerDbm": 0,
"powerMode": "string"
},
"cellularInfo": {"cellular3G4GChannel": 0,
"cellularActiveSim": "string",
"cellularBand": "string",
"cellularCardRemovalCountSIM0": "string",
"cellularCardRemovalCountSIM1": "string",
"cellularConnectionStatus": "string",
"cellularCountry": "string",
"cellularDHCPTimeoutCountSIM0": "string",
"cellularDHCPTimeoutCountSIM1": "string",
"cellularDefaultGateway": "string",
"cellularDownlinkBandwidth": "string",
"cellularECIO": 0,
"cellularICCIDSIM0": "string",
"cellularICCIDSIM1": "string",
"cellularIMEI": "string",
"cellularIMSISIM0": "string",
"cellularIMSISIM1": "string",
"cellularIPaddress": "string",
"cellularIsSIM0Present": "string",
"cellularIsSIM1Present": "string",
"cellularLTEFirmware": "string",
"cellularNWLostCountSIM0": "string",
"cellularNWLostCountSIM1": "string",
"cellularOperator": "string",
"cellularRSCP": 0,
"cellularRSRP": 0,
"cellularRSRQ": 0,
"cellularRadioUptime": 0,
"cellularRoamingStatus": "string",
"cellularRxBytesSIM0": "string",
"cellularRxBytesSIM1": "string",
"cellularSINR": 0,
"cellularSignalStrength": "string",
"cellularSubnetMask": "string",
"cellularSwitchCountSIM0": "string",
"cellularSwitchCountSIM1": "string",
"cellularTxBytesSIM0": "string",
"cellularTxBytesSIM1": "string",
"cellularUplinkBandwidth": "string",
"cellularWanInterface": "string"
},
"lanPortStatus": [{"phyLink": null,
"port": null
}
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceDto": {"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [null
],
"APSystem": {"gateway": null,
"ipType": null,
"netmask": null,
"primaryDnsServer": null,
"secondaryDnsServer": null,
"uptime": null
},
"afcInfo": {"afcStatus": null,
"availableChannel": null,
"availableChannels": [ ],
"geoLocation": null,
"maxPowerDbm": null,
"minPowerDbm": null,
"powerMode": null
},
"cellularInfo": {"cellular3G4GChannel": null,
"cellularActiveSim": null,
"cellularBand": null,
"cellularCardRemovalCountSIM0": null,
"cellularCardRemovalCountSIM1": null,
"cellularConnectionStatus": null,
"cellularCountry": null,
"cellularDHCPTimeoutCountSIM0": null,
"cellularDHCPTimeoutCountSIM1": null,
"cellularDefaultGateway": null,
"cellularDownlinkBandwidth": null,
"cellularECIO": null,
"cellularICCIDSIM0": null,
"cellularICCIDSIM1": null,
"cellularIMEI": null,
"cellularIMSISIM0": null,
"cellularIMSISIM1": null,
"cellularIPaddress": null,
"cellularIsSIM0Present": null,
"cellularIsSIM1Present": null,
"cellularLTEFirmware": null,
"cellularNWLostCountSIM0": null,
"cellularNWLostCountSIM1": null,
"cellularOperator": null,
"cellularRSCP": null,
"cellularRSRP": null,
"cellularRSRQ": null,
"cellularRadioUptime": null,
"cellularRoamingStatus": null,
"cellularRxBytesSIM0": null,
"cellularRxBytesSIM1": null,
"cellularSINR": null,
"cellularSignalStrength": null,
"cellularSubnetMask": null,
"cellularSwitchCountSIM0": null,
"cellularSwitchCountSIM1": null,
"cellularTxBytesSIM0": null,
"cellularTxBytesSIM1": null,
"cellularUplinkBandwidth": null,
"cellularWanInterface": null
},
"lanPortStatus": [null
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": null,
"mac": null,
"rssi": null
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"uplink": [{ }
],
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": null,
"wlanGroupId": null,
"wlanGroupName": null
}
],
"xPercent": 0.1,
"yPercent": 0.1
},
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": "string",
"mac": "string",
"rssi": 0
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"rssi": 0,
"rxBytes": "string",
"rxFrames": "string",
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"txBytes": "string",
"txFrames": "string",
"type": 0,
"upMac": "string",
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": 0,
"wlanGroupId": "string",
"wlanGroupName": "string"
}
],
"xPercent": 0.1,
"yPercent": 0.1
}
],
"uplinkChannel": "string",
"uplinkType": [0
]
}
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Topology

Get venue's topology data.

path Parameters

venueId

required

string

query Parameters

meshOnly

required

boolean

Get mesh topology

Responses

Response samples

200
501

Content type

application/json

{"data": [{"edges": [{"band": "string",
"channel": 0,
"connectedPort": "string",
"connectedPortTaggedVlan": "string",
"connectedPortUntaggedVlan": "string",
"connectionStatus": "Good",
"connectionType": "Wired",
"correspondingPort": "string",
"correspondingPortTaggedVlan": "string",
"correspondingPortUntaggedVlan": "string",
"extraEdges": [{"connectedPort": "string",
"connectedPortTaggedVlan": "string",
"connectedPortUntaggedVlan": "string",
"connectionStatus": "Good",
"connectionType": "Wired",
"correspondingPort": "string",
"correspondingPortTaggedVlan": "string",
"correspondingPortUntaggedVlan": "string",
"linkSpeed": "string",
"poeEnabled": true,
"poeTotal": 0,
"poeUsed": 0
}
],
"from": "string",
"fromMac": "string",
"fromName": "string",
"fromRole": "string",
"fromSNR": 0,
"fromSerial": "string",
"linkSpeed": "string",
"poeEnabled": true,
"poeTotal": 0,
"poeUsed": 0,
"to": "string",
"toMac": "string",
"toName": "string",
"toRole": "string",
"toSNR": 0,
"toSerial": "string"
}
],
"nodes": [{"childCount": 0,
"cloudPort": "string",
"downlink": [{"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [{"Rssi": null,
"actualTxPower": null,
"band": null,
"calibrationTxPower": null,
"channel": null,
"operativeChannelBandwidth": null,
"radioId": null,
"txPower": null
}
],
"APSystem": {"gateway": "string",
"ipType": "string",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string",
"uptime": 0
},
"afcInfo": {"afcStatus": "string",
"availableChannel": 0,
"availableChannels": [null
],
"geoLocation": {"height": null,
"lateralUncertainty": null,
"latitude": null,
"longitude": null,
"source": null,
"verticalUncertainty": null
},
"maxPowerDbm": 0,
"minPowerDbm": 0,
"powerMode": "string"
},
"cellularInfo": {"cellular3G4GChannel": 0,
"cellularActiveSim": "string",
"cellularBand": "string",
"cellularCardRemovalCountSIM0": "string",
"cellularCardRemovalCountSIM1": "string",
"cellularConnectionStatus": "string",
"cellularCountry": "string",
"cellularDHCPTimeoutCountSIM0": "string",
"cellularDHCPTimeoutCountSIM1": "string",
"cellularDefaultGateway": "string",
"cellularDownlinkBandwidth": "string",
"cellularECIO": 0,
"cellularICCIDSIM0": "string",
"cellularICCIDSIM1": "string",
"cellularIMEI": "string",
"cellularIMSISIM0": "string",
"cellularIMSISIM1": "string",
"cellularIPaddress": "string",
"cellularIsSIM0Present": "string",
"cellularIsSIM1Present": "string",
"cellularLTEFirmware": "string",
"cellularNWLostCountSIM0": "string",
"cellularNWLostCountSIM1": "string",
"cellularOperator": "string",
"cellularRSCP": 0,
"cellularRSRP": 0,
"cellularRSRQ": 0,
"cellularRadioUptime": 0,
"cellularRoamingStatus": "string",
"cellularRxBytesSIM0": "string",
"cellularRxBytesSIM1": "string",
"cellularSINR": 0,
"cellularSignalStrength": "string",
"cellularSubnetMask": "string",
"cellularSwitchCountSIM0": "string",
"cellularSwitchCountSIM1": "string",
"cellularTxBytesSIM0": "string",
"cellularTxBytesSIM1": "string",
"cellularUplinkBandwidth": "string",
"cellularWanInterface": "string"
},
"lanPortStatus": [{"phyLink": null,
"port": null
}
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceDto": {"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [null
],
"APSystem": {"gateway": null,
"ipType": null,
"netmask": null,
"primaryDnsServer": null,
"secondaryDnsServer": null,
"uptime": null
},
"afcInfo": {"afcStatus": null,
"availableChannel": null,
"availableChannels": [ ],
"geoLocation": null,
"maxPowerDbm": null,
"minPowerDbm": null,
"powerMode": null
},
"cellularInfo": {"cellular3G4GChannel": null,
"cellularActiveSim": null,
"cellularBand": null,
"cellularCardRemovalCountSIM0": null,
"cellularCardRemovalCountSIM1": null,
"cellularConnectionStatus": null,
"cellularCountry": null,
"cellularDHCPTimeoutCountSIM0": null,
"cellularDHCPTimeoutCountSIM1": null,
"cellularDefaultGateway": null,
"cellularDownlinkBandwidth": null,
"cellularECIO": null,
"cellularICCIDSIM0": null,
"cellularICCIDSIM1": null,
"cellularIMEI": null,
"cellularIMSISIM0": null,
"cellularIMSISIM1": null,
"cellularIPaddress": null,
"cellularIsSIM0Present": null,
"cellularIsSIM1Present": null,
"cellularLTEFirmware": null,
"cellularNWLostCountSIM0": null,
"cellularNWLostCountSIM1": null,
"cellularOperator": null,
"cellularRSCP": null,
"cellularRSRP": null,
"cellularRSRQ": null,
"cellularRadioUptime": null,
"cellularRoamingStatus": null,
"cellularRxBytesSIM0": null,
"cellularRxBytesSIM1": null,
"cellularSINR": null,
"cellularSignalStrength": null,
"cellularSubnetMask": null,
"cellularSwitchCountSIM0": null,
"cellularSwitchCountSIM1": null,
"cellularTxBytesSIM0": null,
"cellularTxBytesSIM1": null,
"cellularUplinkBandwidth": null,
"cellularWanInterface": null
},
"lanPortStatus": [null
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": null,
"mac": null,
"rssi": null
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"uplink": [{"IP": null,
"apGroupId": null,
"apGroupName": null,
"apMac": null,
"apNeighborMacs": [ ],
"apNeighborRssis": [ ],
"apRadioDeploy": null,
"apStatusData": null,
"clients": null,
"configStatus": null,
"connectionStatus": null,
"crtTime": null,
"description": null,
"deviceDto": null,
"deviceGroupId": null,
"deviceGroupName": null,
"deviceModelType": null,
"deviceSessionCacheWeight": null,
"deviceStatus": null,
"deviceStatusSeverity": null,
"downLinkCount": null,
"downlink.downMac": [ ],
"downlink.rssi": [ ],
"downlink.type": [ ],
"downlinkChannel": null,
"downlinkCount": null,
"extIp": null,
"externalPort": null,
"floorplanId": null,
"fwVersion": null,
"geolocationSource": null,
"healthStatus": null,
"hops": null,
"isMeshEnable": null,
"lastSeenTime": null,
"lastUpdTime": null,
"latitude": null,
"longitude": null,
"meshRole": null,
"model": null,
"name": null,
"neighbors": [ ],
"poePort": null,
"reboot": null,
"rogueCategory": { },
"rssi": null,
"rxBytes": null,
"rxFrames": null,
"serialNumber": null,
"switchId": null,
"switchName": null,
"switchPort": null,
"switchSerialNumber": null,
"tags": null,
"tenantId": null,
"txBytes": null,
"txFrames": null,
"type": null,
"upMac": null,
"uplink.rssi": null,
"uplink.type": [ ],
"uplink.upMac": null,
"uplinkChannel": null,
"venueId": null,
"venueName": null,
"wlanGroup24GId": null,
"wlanGroup5GId": null,
"wlanGroups": [ ],
"xPercent": null,
"yPercent": null
}
],
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": null,
"wlanGroupId": null,
"wlanGroupName": null
}
],
"xPercent": 0.1,
"yPercent": 0.1
},
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downMac": "string",
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": "string",
"mac": "string",
"rssi": 0
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"rssi": 0,
"rxBytes": "string",
"rxFrames": "string",
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"txBytes": "string",
"txFrames": "string",
"type": 0,
"uplink": [{"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": [null
],
"apNeighborRssis": [null
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [ ],
"APSystem": null,
"afcInfo": null,
"cellularInfo": null,
"lanPortStatus": [ ]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceDto": {"IP": null,
"apGroupId": null,
"apGroupName": null,
"apMac": null,
"apNeighborMacs": [ ],
"apNeighborRssis": [ ],
"apRadioDeploy": null,
"apStatusData": null,
"clients": null,
"configStatus": null,
"connectionStatus": null,
"crtTime": null,
"description": null,
"deviceGroupId": null,
"deviceGroupName": null,
"deviceModelType": null,
"deviceSessionCacheWeight": null,
"deviceStatus": null,
"deviceStatusSeverity": null,
"downLinkCount": null,
"downlink.downMac": [ ],
"downlink.rssi": [ ],
"downlink.type": [ ],
"downlinkChannel": null,
"downlinkCount": null,
"extIp": null,
"externalPort": null,
"floorplanId": null,
"fwVersion": null,
"geolocationSource": null,
"healthStatus": null,
"hops": null,
"isMeshEnable": null,
"lastSeenTime": null,
"lastUpdTime": null,
"latitude": null,
"longitude": null,
"meshRole": null,
"model": null,
"name": null,
"neighbors": [ ],
"poePort": null,
"reboot": null,
"rogueCategory": { },
"serialNumber": null,
"switchId": null,
"switchName": null,
"switchPort": null,
"switchSerialNumber": null,
"tags": null,
"tenantId": null,
"uplink": [ ],
"uplink.rssi": null,
"uplink.type": [ ],
"uplink.upMac": null,
"uplinkChannel": null,
"venueId": null,
"venueName": null,
"wlanGroup24GId": null,
"wlanGroup5GId": null,
"wlanGroups": [ ],
"xPercent": null,
"yPercent": null
},
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": [null
],
"downlink.rssi": [null
],
"downlink.type": [null
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [null
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": null,
"property2": null
},
"rssi": 0,
"rxBytes": "string",
"rxFrames": "string",
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"txBytes": "string",
"txFrames": "string",
"type": 0,
"upMac": "string",
"uplink.rssi": 0,
"uplink.type": [null
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [null
],
"xPercent": 0.1,
"yPercent": 0.1
}
],
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": 0,
"wlanGroupId": "string",
"wlanGroupName": "string"
}
],
"xPercent": 0.1,
"yPercent": 0.1
}
],
"downlinkChannel": "string",
"downlinkType": [0
],
"id": "string",
"ipAddress": "string",
"isConnectedCloud": true,
"isMeshEnable": true,
"mac": "string",
"meshRole": "string",
"name": "string",
"parentId": "string",
"parentMac": "string",
"serial": "string",
"status": "Operational",
"taggedVlan": "string",
"type": "Switch",
"untaggedVlan": "string",
"uplink": [{"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [{"Rssi": null,
"actualTxPower": null,
"band": null,
"calibrationTxPower": null,
"channel": null,
"operativeChannelBandwidth": null,
"radioId": null,
"txPower": null
}
],
"APSystem": {"gateway": "string",
"ipType": "string",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string",
"uptime": 0
},
"afcInfo": {"afcStatus": "string",
"availableChannel": 0,
"availableChannels": [null
],
"geoLocation": {"height": null,
"lateralUncertainty": null,
"latitude": null,
"longitude": null,
"source": null,
"verticalUncertainty": null
},
"maxPowerDbm": 0,
"minPowerDbm": 0,
"powerMode": "string"
},
"cellularInfo": {"cellular3G4GChannel": 0,
"cellularActiveSim": "string",
"cellularBand": "string",
"cellularCardRemovalCountSIM0": "string",
"cellularCardRemovalCountSIM1": "string",
"cellularConnectionStatus": "string",
"cellularCountry": "string",
"cellularDHCPTimeoutCountSIM0": "string",
"cellularDHCPTimeoutCountSIM1": "string",
"cellularDefaultGateway": "string",
"cellularDownlinkBandwidth": "string",
"cellularECIO": 0,
"cellularICCIDSIM0": "string",
"cellularICCIDSIM1": "string",
"cellularIMEI": "string",
"cellularIMSISIM0": "string",
"cellularIMSISIM1": "string",
"cellularIPaddress": "string",
"cellularIsSIM0Present": "string",
"cellularIsSIM1Present": "string",
"cellularLTEFirmware": "string",
"cellularNWLostCountSIM0": "string",
"cellularNWLostCountSIM1": "string",
"cellularOperator": "string",
"cellularRSCP": 0,
"cellularRSRP": 0,
"cellularRSRQ": 0,
"cellularRadioUptime": 0,
"cellularRoamingStatus": "string",
"cellularRxBytesSIM0": "string",
"cellularRxBytesSIM1": "string",
"cellularSINR": 0,
"cellularSignalStrength": "string",
"cellularSubnetMask": "string",
"cellularSwitchCountSIM0": "string",
"cellularSwitchCountSIM1": "string",
"cellularTxBytesSIM0": "string",
"cellularTxBytesSIM1": "string",
"cellularUplinkBandwidth": "string",
"cellularWanInterface": "string"
},
"lanPortStatus": [{"phyLink": null,
"port": null
}
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceDto": {"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [null
],
"APSystem": {"gateway": null,
"ipType": null,
"netmask": null,
"primaryDnsServer": null,
"secondaryDnsServer": null,
"uptime": null
},
"afcInfo": {"afcStatus": null,
"availableChannel": null,
"availableChannels": [ ],
"geoLocation": null,
"maxPowerDbm": null,
"minPowerDbm": null,
"powerMode": null
},
"cellularInfo": {"cellular3G4GChannel": null,
"cellularActiveSim": null,
"cellularBand": null,
"cellularCardRemovalCountSIM0": null,
"cellularCardRemovalCountSIM1": null,
"cellularConnectionStatus": null,
"cellularCountry": null,
"cellularDHCPTimeoutCountSIM0": null,
"cellularDHCPTimeoutCountSIM1": null,
"cellularDefaultGateway": null,
"cellularDownlinkBandwidth": null,
"cellularECIO": null,
"cellularICCIDSIM0": null,
"cellularICCIDSIM1": null,
"cellularIMEI": null,
"cellularIMSISIM0": null,
"cellularIMSISIM1": null,
"cellularIPaddress": null,
"cellularIsSIM0Present": null,
"cellularIsSIM1Present": null,
"cellularLTEFirmware": null,
"cellularNWLostCountSIM0": null,
"cellularNWLostCountSIM1": null,
"cellularOperator": null,
"cellularRSCP": null,
"cellularRSRP": null,
"cellularRSRQ": null,
"cellularRadioUptime": null,
"cellularRoamingStatus": null,
"cellularRxBytesSIM0": null,
"cellularRxBytesSIM1": null,
"cellularSINR": null,
"cellularSignalStrength": null,
"cellularSubnetMask": null,
"cellularSwitchCountSIM0": null,
"cellularSwitchCountSIM1": null,
"cellularTxBytesSIM0": null,
"cellularTxBytesSIM1": null,
"cellularUplinkBandwidth": null,
"cellularWanInterface": null
},
"lanPortStatus": [null
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": null,
"mac": null,
"rssi": null
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"uplink": [{ }
],
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": null,
"wlanGroupId": null,
"wlanGroupName": null
}
],
"xPercent": 0.1,
"yPercent": 0.1
},
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": "string",
"mac": "string",
"rssi": 0
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"rssi": 0,
"rxBytes": "string",
"rxFrames": "string",
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"txBytes": "string",
"txFrames": "string",
"type": 0,
"upMac": "string",
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": 0,
"wlanGroupId": "string",
"wlanGroupName": "string"
}
],
"xPercent": 0.1,
"yPercent": 0.1
}
],
"uplinkChannel": "string",
"uplinkType": [0
]
}
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Quality of Service

View the information of Quality of Service

Get the Statistics of Quality of Service

Retrieve the list of quality of service statistics.

Request Body schema:
application/json
required

Array

field	string
value	string

Responses

Request samples

Payload

Content type

application/json

[[{"field": "string",
"value": "string"
}
]
]

Response samples

200

Content type

application/json

{"data": [{"billingStartEpoch": 0,
"downloadBytes": 0,
"downloadPackets": 0,
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"personalIdentityNetworkId": "577ecf22-d053-4984-94fc-74f14b229019",
"uploadBytes": 0,
"uploadPackets": 0,
"vni": 0
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Edge SD-LAN Status

Edge SD-LAN Status API

Get RUCKUS Edge SD-LANs

Get SD-LAN list of RUCKUS Edge.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"corePortMac": "string",
"edgeAlarmSummary": {"edgeId": "string",
"severitySummary": {"property1": 0,
"property2": 0
},
"totalCount": 0
},
"edgeClusterId": "string",
"edgeClusterName": "string",
"edgeClusterTunnelInfo": [{"activeApCount": 0,
"allocatedApCount": 0,
"serialNumber": "string"
}
],
"edgeId": "string",
"edgeName": "string",
"guestEdgeClusterId": "string",
"guestEdgeClusterName": "string",
"guestEdgeClusterTunnelInfo": [{"activeNodeCount": 0,
"allocatedNodeCount": 0,
"serialNumber": "string"
}
],
"guestEdgeId": "string",
"guestEdgeName": "string",
"guestNetworkIds": ["string"
],
"guestNetworkInfos": [{"networkId": "string",
"networkName": "string"
}
],
"guestTunnelProfileId": "string",
"guestTunnelProfileName": "string",
"guestVlanNum": 0,
"guestVlans": ["string"
],
"guestVxlanTunnelNum": 0,
"id": "string",
"isGuestTunnelEnabled": true,
"name": "string",
"networkIds": ["string"
],
"networkInfos": [{"networkId": "string",
"networkName": "string"
}
],
"serviceVersion": "string",
"tenantId": "string",
"timestamp": 0,
"tunnelProfileId": "string",
"tunnelProfileName": "string",
"tunneledGuestWlans": [{"networkId": "string",
"networkName": "string",
"venueId": "string",
"venueName": "string",
"wlanId": "string"
}
],
"tunneledWlans": [{"networkId": "string",
"networkName": "string",
"venueId": "string",
"venueName": "string",
"wlanId": "string"
}
],
"venueId": "string",
"venueName": "string",
"vlanNum": 0,
"vlans": ["string"
],
"vxlanTunnelNum": 0
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

View Platform

View platform information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Get Venues

Return a list of venue records.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"addressLine": "string",
"city": "string",
"country": "string",
"countryCode": "string",
"crtTime": "string",
"currentApFirmwares": [{"apModel": "string",
"firmware": "string"
}
],
"description": "string",
"dhcp": {"enabled": true,
"mode": "string"
},
"dpGroupId": "string",
"id": "string",
"isApFirmwareUpToDate": true,
"isTemplate": true,
"lastApFirmwareUpdate": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"mesh": {"enabled": true
},
"name": "string",
"nextApFirmwareSchedules": [{"startDateTime": "string",
"versionInfo": {"category": "string",
"type": "string",
"version": "string"
}
}
],
"notes": "string",
"rogueDetection": {"enabled": true,
"policyId": "string",
"policyName": "string"
},
"switchProfileId": "string",
"switchProfileName": "string",
"syslogServer": {"enabled": true,
"policyId": "string",
"policyName": "string"
},
"tenantId": "string",
"timeZone": "string",
"type": "string",
"wifiFirmwareVersion": "string"
}

Get Venue AP Models Deprecated

This API is deprecated. Please use the latest API. The deprecated API is used to retrieve the AP models deployed in this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

200

Content type

application/json

{"models": ["string"
]
}

Get Venue AP Models

Get the AP models deployed in this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

200

Content type

application/json

{"models": ["string"
]
}

Get Venue Rogue APs

Get the list of rogue APs located in this venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"band": "string",
"category": "string",
"channel": 0,
"classificationPolicyName": "string",
"classificationRuleName": "string",
"closestAp": {"apMac": "string",
"apName": "string",
"apSerialNumber": "string",
"lastUpdTime": "string",
"snr": 0
},
"detectingAps": [{"apMac": "string",
"apName": "string",
"apSerialNumber": "string",
"lastUpdTime": "string",
"snr": 0
}
],
"lastDetectingAp": {"apMac": "string",
"apName": "string",
"apSerialNumber": "string",
"lastUpdTime": "string",
"snr": 0
},
"lastUpdTime": "string",
"locatable": true,
"numberOfDetectingAps": 0,
"rogueApMac": "string",
"rogueMac": "string",
"ssid": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

View SNMP Agent Profiles

Manage SNMP Agent Profile.

Query SNMP Agent Profiles

Query SNMP agent profile for the list.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"apNames": ["string"
],
"apSerialNumbers": ["string"
],
"communityNames": ["string"
],
"id": "string",
"name": "string",
"tags": "string",
"userNames": ["string"
],
"venueIds": ["string"
],
"venueNames": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

View SoftGRE Profile

SoftGRE Profile API

Query SoftGRE Profiles

Query SoftGRE profiles.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"activations": [{"venueId": "string",
"wifiNetworkIds": ["string"
]
}
],
"description": "string",
"disassociateClientEnabled": true,
"id": "string",
"keepAliveInterval": 0,
"keepAliveRetryTimes": 0,
"mtuSize": 0,
"mtuType": "AUTO",
"name": "string",
"primaryGatewayAddress": "string",
"secondaryGatewayAddress": "string",
"tenantId": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

View Wi-Fi

View Wi-Fi information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Get APs Aggregation Details Deprecated

Get parameters and operational data for a list of APs with aggregation details.

Request Body schema: application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"aps": [{"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [{"Rssi": 0,
"actualTxPower": 0,
"band": "string",
"calibrationTxPower": 0,
"channel": 0,
"operativeChannelBandwidth": "string",
"radioId": 0,
"txPower": "string"
}
],
"APSystem": {"gateway": "string",
"ipType": "string",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string",
"uptime": 0
},
"afcInfo": {"afcStatus": "string",
"availableChannel": 0,
"availableChannels": [0
],
"geoLocation": {"height": 0.1,
"lateralUncertainty": 0.1,
"latitude": 0.1,
"longitude": 0.1,
"source": "string",
"verticalUncertainty": 0.1
},
"maxPowerDbm": 0,
"minPowerDbm": 0,
"powerMode": "string"
},
"cellularInfo": {"cellular3G4GChannel": 0,
"cellularActiveSim": "string",
"cellularBand": "string",
"cellularCardRemovalCountSIM0": "string",
"cellularCardRemovalCountSIM1": "string",
"cellularConnectionStatus": "string",
"cellularCountry": "string",
"cellularDHCPTimeoutCountSIM0": "string",
"cellularDHCPTimeoutCountSIM1": "string",
"cellularDefaultGateway": "string",
"cellularDownlinkBandwidth": "string",
"cellularECIO": 0,
"cellularICCIDSIM0": "string",
"cellularICCIDSIM1": "string",
"cellularIMEI": "string",
"cellularIMSISIM0": "string",
"cellularIMSISIM1": "string",
"cellularIPaddress": "string",
"cellularIsSIM0Present": "string",
"cellularIsSIM1Present": "string",
"cellularLTEFirmware": "string",
"cellularNWLostCountSIM0": "string",
"cellularNWLostCountSIM1": "string",
"cellularOperator": "string",
"cellularRSCP": 0,
"cellularRSRP": 0,
"cellularRSRQ": 0,
"cellularRadioUptime": 0,
"cellularRoamingStatus": "string",
"cellularRxBytesSIM0": "string",
"cellularRxBytesSIM1": "string",
"cellularSINR": 0,
"cellularSignalStrength": "string",
"cellularSubnetMask": "string",
"cellularSwitchCountSIM0": "string",
"cellularSwitchCountSIM1": "string",
"cellularTxBytesSIM0": "string",
"cellularTxBytesSIM1": "string",
"cellularUplinkBandwidth": "string",
"cellularWanInterface": "string"
},
"lanPortStatus": [{"phyLink": "string",
"port": "string"
}
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": "string",
"mac": "string",
"rssi": 0
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"uplink": [{"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [{"Rssi": null,
"actualTxPower": null,
"band": null,
"calibrationTxPower": null,
"channel": null,
"operativeChannelBandwidth": null,
"radioId": null,
"txPower": null
}
],
"APSystem": {"gateway": "string",
"ipType": "string",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string",
"uptime": 0
},
"afcInfo": {"afcStatus": "string",
"availableChannel": 0,
"availableChannels": [null
],
"geoLocation": {"height": null,
"lateralUncertainty": null,
"latitude": null,
"longitude": null,
"source": null,
"verticalUncertainty": null
},
"maxPowerDbm": 0,
"minPowerDbm": 0,
"powerMode": "string"
},
"cellularInfo": {"cellular3G4GChannel": 0,
"cellularActiveSim": "string",
"cellularBand": "string",
"cellularCardRemovalCountSIM0": "string",
"cellularCardRemovalCountSIM1": "string",
"cellularConnectionStatus": "string",
"cellularCountry": "string",
"cellularDHCPTimeoutCountSIM0": "string",
"cellularDHCPTimeoutCountSIM1": "string",
"cellularDefaultGateway": "string",
"cellularDownlinkBandwidth": "string",
"cellularECIO": 0,
"cellularICCIDSIM0": "string",
"cellularICCIDSIM1": "string",
"cellularIMEI": "string",
"cellularIMSISIM0": "string",
"cellularIMSISIM1": "string",
"cellularIPaddress": "string",
"cellularIsSIM0Present": "string",
"cellularIsSIM1Present": "string",
"cellularLTEFirmware": "string",
"cellularNWLostCountSIM0": "string",
"cellularNWLostCountSIM1": "string",
"cellularOperator": "string",
"cellularRSCP": 0,
"cellularRSRP": 0,
"cellularRSRQ": 0,
"cellularRadioUptime": 0,
"cellularRoamingStatus": "string",
"cellularRxBytesSIM0": "string",
"cellularRxBytesSIM1": "string",
"cellularSINR": 0,
"cellularSignalStrength": "string",
"cellularSubnetMask": "string",
"cellularSwitchCountSIM0": "string",
"cellularSwitchCountSIM1": "string",
"cellularTxBytesSIM0": "string",
"cellularTxBytesSIM1": "string",
"cellularUplinkBandwidth": "string",
"cellularWanInterface": "string"
},
"lanPortStatus": [{"phyLink": null,
"port": null
}
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceDto": { },
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": "string",
"mac": "string",
"rssi": 0
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"rssi": 0,
"rxBytes": "string",
"rxFrames": "string",
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"txBytes": "string",
"txFrames": "string",
"type": 0,
"upMac": "string",
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": 0,
"wlanGroupId": "string",
"wlanGroupName": "string"
}
],
"xPercent": 0.1,
"yPercent": 0.1
}
],
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": 0,
"wlanGroupId": "string",
"wlanGroupName": "string"
}
],
"xPercent": 0.1,
"yPercent": 0.1
}
],
"clients": 0,
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceStatus": "string",
"groupedField": "string",
"groupedValue": "string",
"incidents": 0,
"members": 0,
"model": "string",
"networks": {"count": 0,
"ids": ["string"
],
"names": ["string"
]
},
"venueId": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get APs Deprecated

Get parameters and operational data for a list of APs or mesh APs.

query Parameters

mesh	boolean Default: false Get mesh aps

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [{"Rssi": 0,
"actualTxPower": 0,
"band": "string",
"calibrationTxPower": 0,
"channel": 0,
"operativeChannelBandwidth": "string",
"radioId": 0,
"txPower": "string"
}
],
"APSystem": {"gateway": "string",
"ipType": "string",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string",
"uptime": 0
},
"afcInfo": {"afcStatus": "string",
"availableChannel": 0,
"availableChannels": [0
],
"geoLocation": {"height": 0.1,
"lateralUncertainty": 0.1,
"latitude": 0.1,
"longitude": 0.1,
"source": "string",
"verticalUncertainty": 0.1
},
"maxPowerDbm": 0,
"minPowerDbm": 0,
"powerMode": "string"
},
"cellularInfo": {"cellular3G4GChannel": 0,
"cellularActiveSim": "string",
"cellularBand": "string",
"cellularCardRemovalCountSIM0": "string",
"cellularCardRemovalCountSIM1": "string",
"cellularConnectionStatus": "string",
"cellularCountry": "string",
"cellularDHCPTimeoutCountSIM0": "string",
"cellularDHCPTimeoutCountSIM1": "string",
"cellularDefaultGateway": "string",
"cellularDownlinkBandwidth": "string",
"cellularECIO": 0,
"cellularICCIDSIM0": "string",
"cellularICCIDSIM1": "string",
"cellularIMEI": "string",
"cellularIMSISIM0": "string",
"cellularIMSISIM1": "string",
"cellularIPaddress": "string",
"cellularIsSIM0Present": "string",
"cellularIsSIM1Present": "string",
"cellularLTEFirmware": "string",
"cellularNWLostCountSIM0": "string",
"cellularNWLostCountSIM1": "string",
"cellularOperator": "string",
"cellularRSCP": 0,
"cellularRSRP": 0,
"cellularRSRQ": 0,
"cellularRadioUptime": 0,
"cellularRoamingStatus": "string",
"cellularRxBytesSIM0": "string",
"cellularRxBytesSIM1": "string",
"cellularSINR": 0,
"cellularSignalStrength": "string",
"cellularSubnetMask": "string",
"cellularSwitchCountSIM0": "string",
"cellularSwitchCountSIM1": "string",
"cellularTxBytesSIM0": "string",
"cellularTxBytesSIM1": "string",
"cellularUplinkBandwidth": "string",
"cellularWanInterface": "string"
},
"lanPortStatus": [{"phyLink": "string",
"port": "string"
}
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": "string",
"mac": "string",
"rssi": 0
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"uplink": [{"IP": "string",
"apGroupId": "string",
"apGroupName": "string",
"apMac": "string",
"apNeighborMacs": ["string"
],
"apNeighborRssis": [0
],
"apRadioDeploy": "string",
"apStatusData": {"APRadio": [{"Rssi": 0,
"actualTxPower": 0,
"band": "string",
"calibrationTxPower": 0,
"channel": 0,
"operativeChannelBandwidth": "string",
"radioId": 0,
"txPower": "string"
}
],
"APSystem": {"gateway": "string",
"ipType": "string",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string",
"uptime": 0
},
"afcInfo": {"afcStatus": "string",
"availableChannel": 0,
"availableChannels": [0
],
"geoLocation": {"height": 0.1,
"lateralUncertainty": 0.1,
"latitude": 0.1,
"longitude": 0.1,
"source": "string",
"verticalUncertainty": 0.1
},
"maxPowerDbm": 0,
"minPowerDbm": 0,
"powerMode": "string"
},
"cellularInfo": {"cellular3G4GChannel": 0,
"cellularActiveSim": "string",
"cellularBand": "string",
"cellularCardRemovalCountSIM0": "string",
"cellularCardRemovalCountSIM1": "string",
"cellularConnectionStatus": "string",
"cellularCountry": "string",
"cellularDHCPTimeoutCountSIM0": "string",
"cellularDHCPTimeoutCountSIM1": "string",
"cellularDefaultGateway": "string",
"cellularDownlinkBandwidth": "string",
"cellularECIO": 0,
"cellularICCIDSIM0": "string",
"cellularICCIDSIM1": "string",
"cellularIMEI": "string",
"cellularIMSISIM0": "string",
"cellularIMSISIM1": "string",
"cellularIPaddress": "string",
"cellularIsSIM0Present": "string",
"cellularIsSIM1Present": "string",
"cellularLTEFirmware": "string",
"cellularNWLostCountSIM0": "string",
"cellularNWLostCountSIM1": "string",
"cellularOperator": "string",
"cellularRSCP": 0,
"cellularRSRP": 0,
"cellularRSRQ": 0,
"cellularRadioUptime": 0,
"cellularRoamingStatus": "string",
"cellularRxBytesSIM0": "string",
"cellularRxBytesSIM1": "string",
"cellularSINR": 0,
"cellularSignalStrength": "string",
"cellularSubnetMask": "string",
"cellularSwitchCountSIM0": "string",
"cellularSwitchCountSIM1": "string",
"cellularTxBytesSIM0": "string",
"cellularTxBytesSIM1": "string",
"cellularUplinkBandwidth": "string",
"cellularWanInterface": "string"
},
"lanPortStatus": [{"phyLink": "string",
"port": "string"
}
]
},
"clients": 0,
"configStatus": "string",
"connectionStatus": "string",
"crtTime": "string",
"description": "string",
"deviceDto": { },
"deviceGroupId": "string",
"deviceGroupName": "string",
"deviceModelType": "string",
"deviceSessionCacheWeight": 0,
"deviceStatus": "string",
"deviceStatusSeverity": "string",
"downLinkCount": 0,
"downlink.downMac": ["string"
],
"downlink.rssi": [0
],
"downlink.type": [0
],
"downlinkChannel": "string",
"downlinkCount": 0,
"extIp": "string",
"externalPort": "string",
"floorplanId": "string",
"fwVersion": "string",
"geolocationSource": "string",
"healthStatus": "string",
"hops": 0,
"isMeshEnable": true,
"lastSeenTime": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"meshRole": "string",
"model": "string",
"name": "string",
"neighbors": [{"apName": "string",
"mac": "string",
"rssi": 0
}
],
"poePort": "string",
"reboot": true,
"rogueCategory": {"property1": 0,
"property2": 0
},
"rssi": 0,
"rxBytes": "string",
"rxFrames": "string",
"serialNumber": "string",
"switchId": "string",
"switchName": "string",
"switchPort": "string",
"switchSerialNumber": "string",
"tags": "string",
"tenantId": "string",
"txBytes": "string",
"txFrames": "string",
"type": 0,
"upMac": "string",
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": 0,
"wlanGroupId": "string",
"wlanGroupName": "string"
}
],
"xPercent": 0.1,
"yPercent": 0.1
}
],
"uplink.rssi": 0,
"uplink.type": [0
],
"uplink.upMac": "string",
"uplinkChannel": "string",
"venueId": "string",
"venueName": "string",
"wlanGroup24GId": "string",
"wlanGroup5GId": "string",
"wlanGroups": [{"radioId": 0,
"wlanGroupId": "string",
"wlanGroupName": "string"
}
],
"xPercent": 0.1,
"yPercent": 0.1
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Export AP Inventory Deprecated

Export the list of APs belong to the tenant.

Request Body schema: application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{ }

Get AP Clients Deprecated

Get client (i.e., end-user devices) parameters and operational data.

query Parameters

apSerialNumber	string
page	integer <int32>
size	integer <int32>

Responses

Response samples

200

Content type

application/json

[{"apMac": "string",
"apName": "string",
"apSerialNumber": "string",
"band": "string",
"bssid": "string",
"connectedSince": "string",
"healthCheckStatus": "string",
"hostname": "string",
"ip": "string",
"mac": "string",
"networkId": "string",
"noiseFloor_dBm": 0,
"osType": "string",
"radioChannel": 0,
"receiveSignalStrength_dBm": 0,
"rxBytes": 0,
"rxPackets": 0,
"snr_dB": 0,
"ssid": "string",
"switchMac": "string",
"switchName": "string",
"switchSerialNumber": "string",
"txBytes": 0,
"txDropDataPacket": 0,
"txPackets": 0,
"username": "string",
"venueId": "string",
"venueName": "string",
"vlan": 0,
"vni": 0
}
]

Get Client by MAC Deprecated

Get extended set of parameters and operational data for the client having this MAC address.

path Parameters

mac

required

string

Responses

Response samples

200

Content type

application/json

{"apMac": "string",
"apName": "string",
"apSerialNumber": "string",
"band": "string",
"bssid": "string",
"connectedSince": "string",
"healthCheckStatus": "string",
"hostname": "string",
"ip": "string",
"mac": "string",
"networkId": "string",
"noiseFloor_dBm": 0,
"osType": "string",
"radioChannel": 0,
"receiveSignalStrength_dBm": 0,
"rxBytes": 0,
"rxPackets": 0,
"snr_dB": 0,
"ssid": "string",
"switchMac": "string",
"switchName": "string",
"switchSerialNumber": "string",
"txBytes": 0,
"txDropDataPacket": 0,
"txPackets": 0,
"username": "string",
"venueId": "string",
"venueName": "string",
"vlan": 0,
"vni": 0
}

Get Cloudpath Servers Deprecated

Get a list of Cloudpath server information.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"acctServer": "string",
"authServer": "string",
"crtTime": "string",
"deployedInVenueId": "string",
"deploymentType": "string",
"floorplanId": "string",
"getxPercent": 0.1,
"getyPercent": 0.1,
"id": "string",
"lastUpdTime": "string",
"name": "string",
"networksCount": 0,
"sharedSecret": "string",
"venuesCount": 0
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get Guests

Get guests.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"clients": [{"apMac": "string",
"apName": "string",
"band": "string",
"bssid": "string",
"clientMac": "string",
"connectSince": "string",
"healthCheckStatus": "string",
"hostname": "string",
"ipAddress": "string",
"networkId": "string",
"noiseFloor_dBm": 0,
"osType": "string",
"radioChannel": 0,
"receiveSignalStrength_dBm": 0,
"rxBytes": 0,
"rxPackets": 0,
"serialNumber": "string",
"snr_dB": 0,
"ssid": "string",
"switchMac": "string",
"switchName": "string",
"switchSerialNumber": "string",
"txBytes": 0,
"txDropDataPacket": 0,
"txPackets": 0,
"username": "string",
"venueId": "string",
"venueName": "string",
"vlan": 0,
"vni": 0
}
],
"creationDate": "string",
"devicesMac": ["string"
],
"emailAddress": "string",
"expiryDate": "string",
"guestStatus": "string",
"guestType": "string",
"id": "string",
"maxNumberOfClients": 0,
"mobilePhoneNumber": "string",
"name": "string",
"networkId": "string",
"notes": "string",
"passDurationHours": 0,
"socialLogin": true,
"ssid": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Export Guest CSV Deprecated

Export guest to CSV.

Request Body schema:
application/json
required

dateFormat	string
guestIds	Array of strings unique
timezone	string

Responses

Request samples

Payload

Content type

application/json

{"dateFormat": "string",
"guestIds": ["string"
],
"timezone": "string"
}

Query AP Groups

Query AP groups information.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"apSerialNumbers": ["string"
],
"clientCount": 0,
"description": "string",
"id": "string",
"isDefault": true,
"name": "string",
"venueId": "string",
"wifiNetworkIds": ["string"
]
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Get APs

Get parameters and operational data for a list of APs or mesh APs.

query Parameters

mesh	boolean Default: false Get mesh aps

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

Example

ViewModel_Service_API_&_Model_Documentation_QueryResponseApQueryData

{"data": [{"afcStatus": {"afcState": "string",
"availableChannels": [0
],
"geoLocationSource": "string",
"hasGeoLocation": true,
"maxPower": 0,
"powerState": "string"
},
"apGroupId": "string",
"cellularStatus": {"activeSim": "string",
"connectionChannel": 0,
"connectionStatus": "string",
"country": "string",
"downlinkBandwidth": "string",
"ecio": 0,
"gateway": "string",
"imei": "string",
"ipAddress": "string",
"lteFirmware": "string",
"netmask": "string",
"operator": "string",
"primarySimStatus": {"cardRemovalCount": 0,
"dhcpTimeoutCount": 0,
"iccid": "string",
"imsi": "string",
"networkLostCount": 0,
"rxBytes": 0,
"switchCount": 0,
"txBytes": 0
},
"radioUptime": 0,
"rfBand": "string",
"roamingStatus": "string",
"rscp": 0,
"rsrp": 0,
"rsrq": 0,
"secondarySimStatus": {"cardRemovalCount": 0,
"dhcpTimeoutCount": 0,
"iccid": "string",
"imsi": "string",
"networkLostCount": 0,
"rxBytes": 0,
"switchCount": 0,
"txBytes": 0
},
"signalStrength": "string",
"sinr": 0,
"uplinkBandwidth": "string",
"wanInterface": "string"
},
"clientCount": 0,
"firmwareVersion": "string",
"floorPosition": {"floorplanId": "string",
"xPercent": 0.1,
"yPercent": 0.1
},
"healthStatus": "UNKNOWN",
"lanPortStatuses": [{"id": "string",
"physicalLink": "string"
}
],
"lastSeenTime": "2019-08-24T14:15:22Z",
"lastUpdatedTime": "2019-08-24T14:15:22Z",
"lbsStatus": {"managementConnected": true,
"serverConnected": true
},
"macAddress": "string",
"meshEnabled": true,
"meshRole": "string",
"meshStatus": {"downlinks": [{"macAddress": "string",
"rssi": 0
}
],
"hopCount": 0,
"neighbors": [{"macAddress": "string",
"rssi": 0
}
],
"radios": [{"band": "string",
"channel": 0
}
],
"uplinks": [{"macAddress": "string",
"rssi": 0
}
]
},
"model": "string",
"name": "string",
"networkStatus": {"externalIpAddress": "string",
"gateway": "string",
"ipAddress": "string",
"ipAddressType": "string",
"managementTrafficVlan": 0,
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string"
},
"radioStatuses": [{"channel": 0,
"type": "string"
}
],
"serialNumber": "string",
"status": "string",
"statusSeverity": "string",
"supportSecureBoot": true,
"switchSerialNumber": "string",
"tags": ["string"
],
"uptime": 0,
"venueId": "string"
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

View Ethernet Port Profile Template

Ethernet Port Profile Template API

Get Ethernet Port Profile Templates

Get data for a list of ethernet port profile templates.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"accountingRadiusId": "string",
"apActivations": [{"apSerialNumber": "string",
"portId": 0,
"venueId": "string"
}
],
"apSerialNumbers": ["string"
],
"authRadiusId": "string",
"authType": "string",
"id": "string",
"isDefault": true,
"name": "string",
"type": "string",
"untagId": 0,
"venueActivations": [{"apModel": "string",
"portId": 0,
"venueId": "string"
}
],
"venueIds": ["string"
],
"vlanMembers": "string",
"vni": 0
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Client API

Query AP Clients

Query AP clients.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"data": [{"apInformation": {"bssid": "string",
"macAddress": "string",
"name": "string",
"serialNumber": "string"
},
"authenticationStatus": 0,
"band": "string",
"connectedTime": "2019-08-24T14:15:22Z",
"cpeMacAddress": "string",
"deviceType": "string",
"hostname": "string",
"ipAddress": "string",
"lastUpdatedTime": "2019-08-24T14:15:22Z",
"macAddress": "string",
"mldMacAddress": "string",
"modelName": "string",
"networkInformation": {"authenticationMethod": "string",
"encryptionMethod": "string",
"id": "string",
"ssid": "string",
"type": "string",
"vlan": 0,
"vni": 0
},
"osType": "string",
"radioStatus": {"channel": 0,
"type": "string"
},
"signalStatus": {"health": "string",
"healthDescription": "string",
"noiseFloor": 0,
"rssi": 0,
"snr": 0
},
"trafficStatus": {"framesDropped": 0,
"packetsFromClient": 0,
"packetsToClient": 0,
"totalTraffic": 0,
"trafficFromClient": 0,
"trafficToClient": 0
},
"username": "string",
"venueInformation": {"id": "string",
"name": "string"
},
"wifiCallingEnabled": true,
"wifiCallingStatus": {"carrierName": "string",
"qosPriority": "string",
"totalTraffic": 0,
"trafficFromClient": 0,
"trafficToClient": 0
}
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

View Ethernet Port Profile

Ethernet Port Profile API

Get Ethernet Port Profiles

Get data for a list of ethernet port profiles.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"accountingRadiusId": "string",
"apActivations": [{"apSerialNumber": "string",
"portId": 0,
"venueId": "string"
}
],
"apSerialNumbers": ["string"
],
"authRadiusId": "string",
"authType": "string",
"id": "string",
"isDefault": true,
"name": "string",
"type": "string",
"untagId": 0,
"venueActivations": [{"apModel": "string",
"portId": 0,
"venueId": "string"
}
],
"venueIds": ["string"
],
"vlanMembers": "string",
"vni": 0
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

Network

Network API

Get Wi-Fi Networks Data

Get Wi-Fi network information.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"ancillarySsid": "string",
"apCount": 0,
"captiveType": "string",
"clientCount": 0,
"crtTime": "string",
"defaultGuestCountry": "string",
"description": "string",
"dsaeOnboardNetwork": {"description": "string",
"id": "string",
"name": "string",
"nwSubType": "string",
"securityProtocol": "string",
"vlan": 0,
"vlanPool": {"name": "string",
"vlanMembers": ["string"
]
}
},
"enableDhcp": true,
"id": "string",
"isEnforced": true,
"isManagedByTemplate": true,
"isOweMaster": true,
"lastUpdTime": "string",
"name": "string",
"nwSubType": "string",
"nwType": "string",
"owePairNetworkId": "string",
"securityProtocol": "string",
"ssid": "string",
"tunnelWlanEnable": true,
"venueApGroups": [{"apGroupIds": ["string"
],
"isAllApGroups": true,
"venueId": "string"
}
],
"vlan": 0
}

network

Get Wi-Fi Networks Data

Get Wi-Fi network information.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"ancillarySsid": "string",
"apCount": 0,
"captiveType": "string",
"clientCount": 0,
"crtTime": "string",
"defaultGuestCountry": "string",
"description": "string",
"dsaeOnboardNetwork": {"description": "string",
"id": "string",
"name": "string",
"nwSubType": "string",
"securityProtocol": "string",
"vlan": 0,
"vlanPool": {"name": "string",
"vlanMembers": ["string"
]
}
},
"enableDhcp": true,
"id": "string",
"isEnforced": true,
"isManagedByTemplate": true,
"isOweMaster": true,
"lastUpdTime": "string",
"name": "string",
"nwSubType": "string",
"nwType": "string",
"owePairNetworkId": "string",
"securityProtocol": "string",
"ssid": "string",
"tunnelWlanEnable": true,
"venueApGroups": [{"apGroupIds": ["string"
],
"isAllApGroups": true,
"venueId": "string"
}
],
"vlan": 0
}

venue

Get Venues

Return a list of venue records.

Request Body schema:
application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200
501

Content type

application/json

{"addressLine": "string",
"city": "string",
"country": "string",
"countryCode": "string",
"crtTime": "string",
"currentApFirmwares": [{"apModel": "string",
"firmware": "string"
}
],
"description": "string",
"dhcp": {"enabled": true,
"mode": "string"
},
"dpGroupId": "string",
"id": "string",
"isApFirmwareUpToDate": true,
"isTemplate": true,
"lastApFirmwareUpdate": "string",
"lastUpdTime": "string",
"latitude": "string",
"longitude": "string",
"mesh": {"enabled": true
},
"name": "string",
"nextApFirmwareSchedules": [{"startDateTime": "string",
"versionInfo": {"category": "string",
"type": "string",
"version": "string"
}
}
],
"notes": "string",
"rogueDetection": {"enabled": true,
"policyId": "string",
"policyName": "string"
},
"switchProfileId": "string",
"switchProfileName": "string",
"syslogServer": {"enabled": true,
"policyId": "string",
"policyName": "string"
},
"tenantId": "string",
"timeZone": "string",
"type": "string",
"wifiFirmwareVersion": "string"
}

AP SNMP Agents

Get AP SNMP Agents Deprecated

Get data for a list of AP SNMP agents.

Request Body schema: application/json
required

exists	string
fields	Array of strings unique
	object
groupBy	string
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields	Array of strings
mustHaveFields	Array of strings
mustNotHaveFields	Array of strings
	Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page	integer <int32>
	object
pageSize	integer <int32>
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
	object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string
	object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
	object

Responses

Request samples

Payload

Content type

application/json

{"exists": "string",
"fields": ["string"
],
"filters": {"property1": ["string"
],
"property2": ["string"
]
},
"groupBy": "string",
"matchFields": [{"field": "string",
"value": "string"
}
],
"multiSortFields": ["string"
],
"mustHaveFields": ["string"
],
"mustNotHaveFields": ["string"
],
"mustNotMatchField": [{"field": "string",
"value": "string"
}
],
"page": 0,
"pageByDate": {"key": "string",
"value": "string"
},
"pageSize": 0,
"rangeDateFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"rangeFilter": {"field": "string",
"gte": 0,
"lt": 0,
"lte": 0
},
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "string",
"termField": {"field": "string",
"value": "string"
},
"terms": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": [{"aps": {"count": 0,
"ids": ["string"
],
"names": ["string"
]
},
"id": "string",
"name": "string",
"tags": "string",
"v2Agents": {"count": 0,
"ids": ["string"
],
"names": ["string"
]
},
"v3Agents": {"count": 0,
"ids": ["string"
],
"names": ["string"
]
},
"venues": {"count": 0,
"ids": ["string"
],
"names": ["string"
]
}
}
],
"errorMessage": "string",
"fields": ["string"
],
"objectId": "string",
"page": 0,
"subsequentQueries": [{"fields": ["string"
],
"httpMethod": "GET",
"payload": { },
"url": "http://example.com"
}
],
"totalCount": 0
}

VLAN Pool Profile

Manage VLAN pool profiles.

Deactivate VLAN Pool Profile On AP Group

Use this API command to deactivate a VLAN pool profile on an AP group.

path Parameters

venueId required	string Venue ID
wifiNetworkId required	string Wi-Fi Network ID
apGroupId required	string AP Group ID
vlanPoolProfileId required	string VLAN Pool Profile ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}/vlanPoolProfiles/{vlanPoolProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}/vlanPoolProfiles/{vlanPoolProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}/vlanPoolProfiles/{vlanPoolProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate VLAN Pool Profile On AP Group

Use this API command to activate a VLAN pool profile on an AP group.

path Parameters

venueId required	string Venue ID
wifiNetworkId required	string Wi-Fi Network ID
apGroupId required	string AP Group ID
vlanPoolProfileId required	string VLAN Pool Profile ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}/vlanPoolProfiles/{vlanPoolProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}/vlanPoolProfiles/{vlanPoolProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}/vlanPoolProfiles/{vlanPoolProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

Add VLAN Pool Profile

Use this API command to create a new VLAN pool profile.

Request Body schema:
application/json
required

description	string [ 0 .. 64 ] characters
name required	string [ 1 .. 32 ] characters
vlanMembers required	Array of strings [ 0 .. 16 ] items [ items [ 0 .. 16 ] characters ]

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"vlanMembers": ["string"
]
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"id": "string"
}
}

Delete VLAN Pool Profile

Use this API command to delete a VLAN pool profile.

path Parameters

vlanPoolProfileId

required

string

VLAN Pool Profile ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get VLAN Pool

Use this API command to get the VLAN pool profile details.

path Parameters

vlanPoolProfileId

required

string

VLAN Pool Profile ID

Responses

Response samples

Content type

application/json

{"description": "string",
"id": "string",
"name": "string",
"vlanMembers": ["string"
]
}

Update VLAN Pool Profile

Use this API command to update a VLAN pool profile.

path Parameters

vlanPoolProfileId

required

string

VLAN Pool Profile ID

Request Body schema:
application/json
required

description	string [ 0 .. 64 ] characters
name required	string [ 1 .. 32 ] characters
vlanMembers required	Array of strings [ 0 .. 16 ] items [ items [ 0 .. 16 ] characters ]

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"vlanMembers": ["string"
]
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate VLAN Pool Profile On Wi-Fi Network

Use this API command to deactivate a VLAN pool profile on a Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
vlanPoolProfileId required	string VLAN Pool Profile ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/wifiNetworks/{wifiNetworkId}/vlanPoolProfiles/{vlanPoolProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/wifiNetworks/{wifiNetworkId}/vlanPoolProfiles/{vlanPoolProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/wifiNetworks/{wifiNetworkId}/vlanPoolProfiles/{vlanPoolProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate VLAN Pool Profile On Wi-Fi Network

Use this API command to activate a VLAN pool profile on a Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
vlanPoolProfileId required	string VLAN Pool Profile ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/wifiNetworks/{wifiNetworkId}/vlanPoolProfiles/{vlanPoolProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/wifiNetworks/{wifiNetworkId}/vlanPoolProfiles/{vlanPoolProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/wifiNetworks/{wifiNetworkId}/vlanPoolProfiles/{vlanPoolProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

LBS Server Profile

Manage location based service server profiles.

Create Location Based Service Server Profile

Create a new location based service server profile.

Request Body schema:
application/json
required

lbsServerVenueName required	string [ 2 .. 16 ] characters ^[a-zA-Z0-9-](?:[a-zA-Z0-9- ]*[a-zA-Z0-9-])?$...
name required	string [ 2 .. 32 ] characters
password required	string [ 8 .. 64 ] characters
serverAddress required	string^[0-9A-Za-z]{1,63}(\.[0-9A-Za-z]{1,63})+$
serverPort required	integer <int32> [ 1 .. 65535 ]

Responses

Request samples

Payload

Content type

application/json

{"lbsServerVenueName": "string",
"name": "string",
"password": "stringst",
"serverAddress": "string",
"serverPort": 1
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"id": "string"
}
}

Delete Location Based Service Server Profile

Delete a location based service server profile.

path Parameters

lbsServerProfileId

required

string

Location based service server profile ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Location Based Service Server Profile

Get the location based service server profile details.

path Parameters

lbsServerProfileId

required

string

Location based service server profile ID

Responses

Response samples

Content type

application/json

{"id": "string",
"lbsServerVenueName": "string",
"name": "string",
"password": "stringst",
"serverAddress": "string",
"serverPort": 1
}

Update Location Based Service Server Profile

Update a location based service server profile.

path Parameters

lbsServerProfileId

required

string

Location based service server profile ID

Request Body schema:
application/json
required

lbsServerVenueName required	string [ 2 .. 16 ] characters ^[a-zA-Z0-9-](?:[a-zA-Z0-9- ]*[a-zA-Z0-9-])?$...
name required	string [ 2 .. 32 ] characters
password required	string [ 8 .. 64 ] characters
serverAddress required	string^[0-9A-Za-z]{1,63}(\.[0-9A-Za-z]{1,63})+$
serverPort required	integer <int32> [ 1 .. 65535 ]

Responses

Request samples

Payload

Content type

application/json

{"lbsServerVenueName": "string",
"name": "string",
"password": "stringst",
"serverAddress": "string",
"serverPort": 1
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate Location Based Service Server Profile On Venue

Deactivate location based service server profile on venue.

path Parameters

venueId required	string Venue ID
lbsServerProfileId required	string Location based service server profile ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Location Based Service Server Profile On Venue

Activate location based service server profile on venue.

path Parameters

venueId required	string Venue ID
lbsServerProfileId required	string Location based service server profile ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Application Library

Manage the current tenant's application library settings.

Get Application Library Categories

path Parameters

applicationLibraryId

required

string

The ID (version) of the application library.

Responses

Response samples

Content type

application/json

{"categories": [{"id": 0,
"name": "string"
}
]
}

Get Application Library Applications

path Parameters

applicationLibraryId required	string The ID (version) of the application library.
categoryId required	integer <int32> The ID of the application category.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/applicationLibraries/{applicationLibraryId}/categories/{categoryId}/applications

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/applicationLibraries/{applicationLibraryId}/categories/{categoryId}/applications

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/applicationLibraries/{applicationLibraryId}/categories/{categoryId}/applications

Response samples

Content type

application/json

{"applications": [{"id": 0,
"name": "string"
}
]
}

Get Application Library Settings

Use this API to get the current application library settings.

query Parameters

type	string Specify which type of changed application would be included in the response
changesIncluded	boolean Default: false Include changed application information in response

Responses

Response samples

Content type

application/json

{"changedApplications": [{"applicationId": 0,
"applicationName": "string",
"categoryId": 0,
"categoryName": "string",
"impactedItems": [{"applicationPolicyId": "string",
"applicationPolicyName": "string",
"applicationPolicyRuleId": "string",
"applicationPolicyRuleName": "string"
}
],
"toApplicationId": 0,
"toApplicationName": "string",
"toCategoryId": 0,
"toCategoryName": "string",
"type": "APPLICATION_ADDED"
}
],
"latestReleasedDate": "2019-08-24T14:15:22Z",
"latestVersion": "string",
"releasedDate": "2019-08-24T14:15:22Z",
"updatedDate": "2019-08-24T14:15:22Z",
"version": "string"
}

Patch Application Library Settings

Patch application library settings.

Request Body schema:
application/json
required

	Array of objects (Wi-Fi_API_and_Model_Documentation_ChangedApplication)
latestReleasedDate	string <date-time>
latestVersion	string
releasedDate	string <date-time>
updatedDate	string <date-time>
version	string

Responses

Request samples

Payload

Content type

application/json

{"changedApplications": [{"applicationId": 0,
"applicationName": "string",
"categoryId": 0,
"categoryName": "string",
"impactedItems": [{"applicationPolicyId": "string",
"applicationPolicyName": "string",
"applicationPolicyRuleId": "string",
"applicationPolicyRuleName": "string"
}
],
"toApplicationId": 0,
"toApplicationName": "string",
"toCategoryId": 0,
"toCategoryName": "string",
"type": "APPLICATION_ADDED"
}
],
"latestReleasedDate": "2019-08-24T14:15:22Z",
"latestVersion": "string",
"releasedDate": "2019-08-24T14:15:22Z",
"updatedDate": "2019-08-24T14:15:22Z",
"version": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Wi-Fi Calling Service Profile

Manage Wi-Fi calling service profiles.

Delete Wi-Fi Calling Service Profiles Deprecated

Delete a list of Wi-Fi calling service profiles. Use DELETE /wifiCallingServiceProfiles/{wifiCallingServiceProfileId} instead.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Wi-Fi Calling Service Profiles Deprecated

Get the Wi-Fi calling service profiles.

Responses

Response samples

Content type

application/json

[{"description": "string",
"epdgs": [{"domain": "string",
"ip": "string"
}
],
"id": "string",
"networkIds": ["string"
],
"qosPriority": "WIFICALLING_PRI_VOICE",
"serviceName": "string"
}
]

Create Wi-Fi Calling Service Profile

Create a new Wi-Fi calling service profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Request Body schema:
application/json
required

description	string [ 2 .. 180 ] characters
required	Array of objects (Wi-Fi_API_and_Model_Documentation_Epdg) [ 1 .. 5 ] items
networkIds	Array of strings Deprecated
qosPriority	string Default: "QosPriorityEnum.WIFICALLING_PRI_VOICE" Enum: "WIFICALLING_PRI_VOICE" "WIFICALLING_PRI_VIDEO" "WIFICALLING_PRI_BE" "WIFICALLING_PRI_BG"
serviceName required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"epdgs": [{"domain": "string",
"ip": "string"
}
],
"networkIds": ["string"
],
"qosPriority": "WIFICALLING_PRI_VOICE",
"serviceName": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Delete Wi-Fi Calling Service Profile

Delete a Wi-Fi calling service profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

wifiCallingServiceProfileId

required

string

Wi-Fi Calling Service Profile ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Wi-Fi Calling Service Profile

Get the Wi-Fi calling service profile details. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

wifiCallingServiceProfileId

required

string

Wi-Fi calling profile ID

Responses

Response samples

Content type

application/json

{"description": "string",
"epdgs": [{"domain": "string",
"ip": "string"
}
],
"id": "string",
"networkIds": ["string"
],
"qosPriority": "WIFICALLING_PRI_VOICE",
"serviceName": "string"
}

Update Wi-Fi Calling Service Profile

Update a Wi-Fi calling service profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

wifiCallingServiceProfileId

required

string

Wi-Fi Calling Service Profile ID

Request Body schema:
application/json
required

description	string [ 2 .. 180 ] characters
required	Array of objects (Wi-Fi_API_and_Model_Documentation_Epdg) [ 1 .. 5 ] items
networkIds	Array of strings Deprecated
qosPriority	string Default: "QosPriorityEnum.WIFICALLING_PRI_VOICE" Enum: "WIFICALLING_PRI_VOICE" "WIFICALLING_PRI_VIDEO" "WIFICALLING_PRI_BE" "WIFICALLING_PRI_BG"
serviceName required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"epdgs": [{"domain": "string",
"ip": "string"
}
],
"networkIds": ["string"
],
"qosPriority": "WIFICALLING_PRI_VOICE",
"serviceName": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate Wi-Fi Calling Service Profile On Wi-Fi Network

Deactivate a Wi-Fi calling service profile on a Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
wifiCallingServiceProfileId required	string Wi-Fi Calling Service Profile ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/wifiNetworks/{wifiNetworkId}/wifiCallingServiceProfiles/{wifiCallingServiceProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/wifiNetworks/{wifiNetworkId}/wifiCallingServiceProfiles/{wifiCallingServiceProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/wifiNetworks/{wifiNetworkId}/wifiCallingServiceProfiles/{wifiCallingServiceProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Wi-Fi Calling Service Profile On Wi-Fi Network

Activate a Wi-Fi calling service profile on a Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
wifiCallingServiceProfileId required	string Wi-Fi Calling Service Profile ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/wifiNetworks/{wifiNetworkId}/wifiCallingServiceProfiles/{wifiCallingServiceProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/wifiNetworks/{wifiNetworkId}/wifiCallingServiceProfiles/{wifiCallingServiceProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/wifiNetworks/{wifiNetworkId}/wifiCallingServiceProfiles/{wifiCallingServiceProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

Wi-Fi Network Activation

Manage Wi-Fi network-venue activation relationships.

Delete Network Activation Deprecated

Delete a list of network-venue activation.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Create Network Activation Deprecated

Create a new network-venue activation.

Request Body schema: application/json
required

allApGroupsRadio	string Deprecated Default: "RadioEnum.Both" Enum: "Both" "2.4-GHz" "5-GHz"
allApGroupsRadioTypes	Array of strings Items Enum: "2.4-GHz" "5-GHz" "6-GHz"
allApGroupsVlanId	integer <int32> [ 1 .. 4094 ]
	Array of objects (Wi-Fi_API_and_Model_Documentation_NetworkApGroup)
clientIsolationAllowlistId	string
isAllApGroups	boolean Default: true
networkId	string
	object (Wi-Fi_API_and_Model_Documentation_NetworkVenueScheduler) Network-Venue scheduler
venueId	string
vlanPoolId	string

Responses

Request samples

Payload

Content type

application/json

{"allApGroupsRadio": "Both",
"allApGroupsRadioTypes": ["2.4-GHz"
],
"allApGroupsVlanId": 1,
"apGroups": [{"apGroupId": "string",
"apGroupName": "string",
"isDefault": false,
"radio": "Both",
"radioTypes": ["2.4-GHz"
],
"validationError": false,
"validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
"validationErrorSsidAlreadyActivated": false,
"vlanId": 1,
"vlanPoolId": "string",
"vlanPoolName": "string"
}
],
"clientIsolationAllowlistId": "string",
"isAllApGroups": true,
"networkId": "string",
"scheduler": {"fri": "string",
"mon": "string",
"sat": "string",
"sun": "string",
"thu": "string",
"tue": "string",
"type": "ALWAYS_ON",
"wed": "string"
},
"venueId": "string",
"vlanPoolId": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"allApGroupsRadio": "Both",
"allApGroupsRadioTypes": ["2.4-GHz"
],
"allApGroupsVlanId": 1,
"apGroups": [{"apGroupId": "string",
"apGroupName": "string",
"id": "string",
"isDefault": false,
"radio": "Both",
"radioTypes": ["2.4-GHz"
],
"validationError": false,
"validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
"validationErrorReachedMaxConnectedNetworksLimit": false,
"validationErrorSsidAlreadyActivated": false,
"vlanId": 1,
"vlanPoolId": "string",
"vlanPoolName": "string"
}
],
"clientIsolationAllowlistId": "string",
"dual5gEnabled": false,
"id": "string",
"isAllApGroups": true,
"networkId": "string",
"scheduler": {"fri": "string",
"mon": "string",
"sat": "string",
"sun": "string",
"thu": "string",
"tue": "string",
"type": "ALWAYS_ON",
"wed": "string"
},
"tripleBandEnabled": false,
"venueId": "string",
"vlanPoolId": "string"
}
}

Create Network Activation Mappings Deprecated

Create multiple network-venue activations.

Request Body schema: application/json
required

Array

allApGroupsRadioTypes	Array of strings Items Enum: "2.4-GHz" "5-GHz" "6-GHz"
allApGroupsVlanId	integer <int32> [ 1 .. 4094 ]
	Array of objects (Wi-Fi_API_and_Model_Documentation_NetworkApGroup)
clientIsolationAllowlistId	string
isAllApGroups	boolean Default: true
networkId	string
	object (Wi-Fi_API_and_Model_Documentation_NetworkVenueScheduler) Network-Venue scheduler
venueId	string
vlanPoolId	string

Responses

Request samples

Payload

Content type

application/json

[{"allApGroupsRadioTypes": ["2.4-GHz"
],
"allApGroupsVlanId": 1,
"apGroups": [{"apGroupId": "string",
"apGroupName": "string",
"isDefault": false,
"radio": "Both",
"radioTypes": ["2.4-GHz"
],
"validationError": false,
"validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
"validationErrorSsidAlreadyActivated": false,
"vlanId": 1,
"vlanPoolId": "string",
"vlanPoolName": "string"
}
],
"clientIsolationAllowlistId": "string",
"isAllApGroups": true,
"networkId": "string",
"scheduler": {"fri": "string",
"mon": "string",
"sat": "string",
"sun": "string",
"thu": "string",
"tue": "string",
"type": "ALWAYS_ON",
"wed": "string"
},
"venueId": "string",
"vlanPoolId": "string"
}
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Network Activations by Query Filter Deprecated

Get network-venue activation list.

Request Body schema:
application/json
required

networkId	string
page	integer <int32> Default: 1
pageSize	integer <int32> Default: 25
venueId	string

Responses

Request samples

Payload

Content type

application/json

{"networkId": "string",
"page": 1,
"pageSize": 25,
"venueId": "string"
}

Response samples

Content type

application/json

{"data": [{"allApGroupsRadio": "Both",
"allApGroupsRadioTypes": ["2.4-GHz"
],
"allApGroupsVlanId": 1,
"apGroups": [{"apGroupId": "string",
"apGroupName": "string",
"id": "string",
"isDefault": false,
"radio": "Both",
"radioTypes": ["2.4-GHz"
],
"validationError": false,
"validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
"validationErrorReachedMaxConnectedNetworksLimit": false,
"validationErrorSsidAlreadyActivated": false,
"vlanId": 1,
"vlanPoolId": "string",
"vlanPoolName": "string"
}
],
"clientIsolationAllowlistId": "string",
"dual5gEnabled": false,
"id": "string",
"isAllApGroups": true,
"networkId": "string",
"scheduler": {"fri": "string",
"mon": "string",
"sat": "string",
"sun": "string",
"thu": "string",
"tue": "string",
"type": "ALWAYS_ON",
"wed": "string"
},
"tripleBandEnabled": false,
"venueId": "string",
"vlanPoolId": "string"
}
],
"fields": ["string"
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Delete Network Activation Deprecated

Delete a network-venue activation.

path Parameters

networkVenueId

required

string

Network-venue activation ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Network Activation Deprecated

Get the network-venue activation details.

path Parameters

networkVenueId

required

string

Network-venue activation ID

Responses

Response samples

Content type

application/json

{"allApGroupsRadio": "Both",
"allApGroupsRadioTypes": ["2.4-GHz"
],
"allApGroupsVlanId": 1,
"apGroups": [{"apGroupId": "string",
"apGroupName": "string",
"id": "string",
"isDefault": false,
"radio": "Both",
"radioTypes": ["2.4-GHz"
],
"validationError": false,
"validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
"validationErrorReachedMaxConnectedNetworksLimit": false,
"validationErrorSsidAlreadyActivated": false,
"vlanId": 1,
"vlanPoolId": "string",
"vlanPoolName": "string"
}
],
"clientIsolationAllowlistId": "string",
"dual5gEnabled": false,
"id": "string",
"isAllApGroups": true,
"networkId": "string",
"scheduler": {"fri": "string",
"mon": "string",
"sat": "string",
"sun": "string",
"thu": "string",
"tue": "string",
"type": "ALWAYS_ON",
"wed": "string"
},
"tripleBandEnabled": false,
"venueId": "string",
"vlanPoolId": "string"
}

Update Network Activation Deprecated

Update this network-venue activation.

path Parameters

networkVenueId

required

string

Network-venue activation ID

Request Body schema: application/json
required

allApGroupsRadio	string Deprecated Default: "RadioEnum.Both" Enum: "Both" "2.4-GHz" "5-GHz"
allApGroupsRadioTypes	Array of strings Items Enum: "2.4-GHz" "5-GHz" "6-GHz"
allApGroupsVlanId	integer <int32> [ 1 .. 4094 ]
	Array of objects (Wi-Fi_API_and_Model_Documentation_NetworkApGroup)
clientIsolationAllowlistId	string
isAllApGroups	boolean Default: true
networkId	string
	object (Wi-Fi_API_and_Model_Documentation_NetworkVenueScheduler) Network-Venue scheduler
venueId	string
vlanPoolId	string

Responses

Request samples

Payload

Content type

application/json

{"allApGroupsRadio": "Both",
"allApGroupsRadioTypes": ["2.4-GHz"
],
"allApGroupsVlanId": 1,
"apGroups": [{"apGroupId": "string",
"apGroupName": "string",
"isDefault": false,
"radio": "Both",
"radioTypes": ["2.4-GHz"
],
"validationError": false,
"validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
"validationErrorSsidAlreadyActivated": false,
"vlanId": 1,
"vlanPoolId": "string",
"vlanPoolName": "string"
}
],
"clientIsolationAllowlistId": "string",
"isAllApGroups": true,
"networkId": "string",
"scheduler": {"fri": "string",
"mon": "string",
"sat": "string",
"sun": "string",
"thu": "string",
"tue": "string",
"type": "ALWAYS_ON",
"wed": "string"
},
"venueId": "string",
"vlanPoolId": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Wifi Portal Service Profile

Portal service profile.

Activate Portal Service Profile On Wi-Fi Network

Activate a portal service profile on a Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
portalServiceProfileId required	string Portal Service Profile ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/wifiNetworks/{wifiNetworkId}/portalServiceProfiles/{portalServiceProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/wifiNetworks/{wifiNetworkId}/portalServiceProfiles/{portalServiceProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/wifiNetworks/{wifiNetworkId}/portalServiceProfiles/{portalServiceProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

AP

Manage APs including pinging, trace-routing, resetting, rebooting, floor-plan positioning and LAN-Ports settings.

Get APs by AP-Group Deprecated

Get the APs in the AP-group.

path Parameters

apGroupId

required

string

AP-group ID

Responses

Response samples

Content type

application/json

[{"apGroupId": "string",
"bssColoring": {"bssColoringEnabled": false,
"useVenueSettings": true
},
"clientAdmissionControl": {"enable24G": false,
"enable50G": false,
"maxRadioLoad24G": 75,
"maxRadioLoad50G": 75,
"minClientCount24G": 10,
"minClientCount50G": 20,
"minClientThroughput24G": 0,
"minClientThroughput50G": 0,
"useVenueSettings": true
},
"clientCount": 0,
"description": "string",
"deviceGps": {"latitude": "string",
"longitude": "string"
},
"externalIp": "null",
"firmware": "null",
"indoorModel": false,
"ip": "null",
"lastContacted": "null",
"lastUpdated": "null",
"mac": "null",
"meshRole": "null",
"model": "null",
"name": "string",
"networkSettings": {"gateway": "string",
"ip": "string",
"ipType": "DYNAMIC",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string"
},
"poePortStatus": "null",
"position": {"floorplanId": "string",
"xPercent": 0,
"yPercent": 0
},
"radio": {"apRadioParams24G": {"allowedChannels": ["1"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams50G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams6G": {"allowedChannels": ["1"
],
"bssMinRate6G": "HE_MCS_0",
"changeInterval": 33,
"channelBandwidth": "AUTO",
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastUplinkRateLimiting": false,
"manualChannel": 0,
"method": "MANUAL",
"mgmtTxRate6G": "6",
"multicastDownlinkRateLimiting": 1,
"multicastUplinkRateLimiting": 1,
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "MAX",
"useVenueSettings": false
},
"apRadioParamsDual5G": {"enabled": true,
"lower5gEnabled": false,
"radioParamsLower5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"radioParamsUpper5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"upper5gEnabled": false,
"useVenueEnabled": false
},
"enable24G": false,
"enable50G": false,
"enable6G": false,
"useVenueSettings": true
},
"serialNumber": "string",
"state": "InSetupPhase",
"subState": "NeverContactedCloud",
"tags": ["string"
],
"uptime_seconds": 0,
"venueId": "string"
}
]

Delete APs Deprecated

Delete a list of APs.

query Parameters

resetFirmware

boolean

Default: false

Reset AP firmware to Standalone image.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get APs Deprecated

Get the AP list.

query Parameters

operational

boolean

Default: false

Include operational data in response

Responses

Response samples

Content type

application/json

[{"apGroupId": "string",
"bssColoring": {"bssColoringEnabled": false,
"useVenueSettings": true
},
"clientAdmissionControl": {"enable24G": false,
"enable50G": false,
"maxRadioLoad24G": 75,
"maxRadioLoad50G": 75,
"minClientCount24G": 10,
"minClientCount50G": 20,
"minClientThroughput24G": 0,
"minClientThroughput50G": 0,
"useVenueSettings": true
},
"clientCount": 0,
"description": "string",
"deviceGps": {"latitude": "string",
"longitude": "string"
},
"externalIp": "null",
"firmware": "null",
"indoorModel": false,
"ip": "null",
"lastContacted": "null",
"lastUpdated": "null",
"mac": "null",
"meshRole": "null",
"model": "null",
"name": "string",
"networkSettings": {"gateway": "string",
"ip": "string",
"ipType": "DYNAMIC",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string"
},
"poePortStatus": "null",
"position": {"floorplanId": "string",
"xPercent": 0,
"yPercent": 0
},
"radio": {"apRadioParams24G": {"allowedChannels": ["1"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams50G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams6G": {"allowedChannels": ["1"
],
"bssMinRate6G": "HE_MCS_0",
"changeInterval": 33,
"channelBandwidth": "AUTO",
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastUplinkRateLimiting": false,
"manualChannel": 0,
"method": "MANUAL",
"mgmtTxRate6G": "6",
"multicastDownlinkRateLimiting": 1,
"multicastUplinkRateLimiting": 1,
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "MAX",
"useVenueSettings": false
},
"apRadioParamsDual5G": {"enabled": true,
"lower5gEnabled": false,
"radioParamsLower5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"radioParamsUpper5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"upper5gEnabled": false,
"useVenueEnabled": false
},
"enable24G": false,
"enable50G": false,
"enable6G": false,
"useVenueSettings": true
},
"serialNumber": "string",
"state": "InSetupPhase",
"subState": "NeverContactedCloud",
"tags": ["string"
],
"uptime_seconds": 0,
"venueId": "string"
}
]

Add APs Deprecated

Add a list of new APs.

Request Body schema:
application/json
required

Array

apGroupId	string
description	string [ 0 .. 180 ] characters
	object (Wi-Fi_API_and_Model_Documentation_DeviceGps) Ap or Venue latitude and longitude
model	string [ 0 .. 64 ] characters Default: "null"
name required	string(?=^((?!`\|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$
	object (Wi-Fi_API_and_Model_Documentation_ApPosition) AP position object
serialNumber required	string^[1-9][0-9]{11}$
tags	Array of strings [ 0 .. 24 ] items [ items [ 0 .. 24 ] characters ]
venueId required	string

Responses

Request samples

Payload

Content type

application/json

[{"apGroupId": "string",
"description": "string",
"deviceGps": {"latitude": "string",
"longitude": "string"
},
"model": "null",
"name": "string",
"position": {"floorplanId": "string",
"xPercent": 0,
"yPercent": 0
},
"serialNumber": "string",
"tags": ["string"
],
"venueId": "string"
}
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Result for Import APs from CSV File Deprecated

Get result for import APs from CSV file.

query Parameters

requestId

required

string

The request-id of import aps request for querying the result.

Responses

Response samples

Content type

application/json

{"downloadUrl": "string",
"errors": [{"code": 0,
"description": "string"
}
],
"fileErrorsCount": 0,
"txId": "string"
}

Delete AP Deprecated

Delete an AP.

path Parameters

serialNumber

required

string

The serial number of the AP.

query Parameters

resetFirmware

boolean

Default: false

Reset AP firmware to Standalone image.

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Deprecated

Get the AP operational and configuration data.

path Parameters

serialNumber

required

string

The serial number of the AP.

query Parameters

operational

boolean

Default: false

Include operational data in response

Responses

Response samples

Content type

application/json

{"apGroupId": "string",
"bonjourGateway": {"rules": [{"enabled": false,
"fromVlan": 1,
"mdnsName": "string",
"mdnsProtocol": "TCP",
"service": "AIRDISK",
"toVlan": 1
}
]
},
"bssColoring": {"bssColoringEnabled": false,
"useVenueSettings": true
},
"clientAdmissionControl": {"enable24G": false,
"enable50G": false,
"maxRadioLoad24G": 75,
"maxRadioLoad50G": 75,
"minClientCount24G": 10,
"minClientCount50G": 20,
"minClientThroughput24G": 0,
"minClientThroughput50G": 0,
"useVenueSettings": true
},
"clientCount": 0,
"description": "string",
"deviceGps": {"latitude": "string",
"longitude": "string"
},
"externalIp": "null",
"firmware": "null",
"indoorModel": false,
"ip": "null",
"lanPorts": {"lanPorts": [{"enabled": true,
"portId": "string",
"type": "ACCESS",
"untagId": 1,
"vlanMembers": "string"
}
],
"poeOut": false,
"useVenueSettings": false
},
"lastContacted": "null",
"lastUpdated": "null",
"mac": "null",
"meshRole": "null",
"model": "null",
"name": "string",
"poePortStatus": "null",
"position": {"floorplanId": "string",
"xPercent": 0,
"yPercent": 0
},
"radio": {"apRadioParams24G": {"allowedChannels": ["1"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams50G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams6G": {"allowedChannels": ["1"
],
"bssMinRate6G": "HE_MCS_0",
"changeInterval": 33,
"channelBandwidth": "AUTO",
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastUplinkRateLimiting": false,
"manualChannel": 0,
"method": "MANUAL",
"mgmtTxRate6G": "6",
"multicastDownlinkRateLimiting": 1,
"multicastUplinkRateLimiting": 1,
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "MAX",
"useVenueSettings": false
},
"apRadioParamsDual5G": {"enabled": true,
"lower5gEnabled": false,
"radioParamsLower5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"radioParamsUpper5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"upper5gEnabled": false,
"useVenueEnabled": false
},
"enable24G": false,
"enable50G": false,
"enable6G": false,
"useVenueSettings": true
},
"serialNumber": "string",
"softDeleted": false,
"softDeletedDate": "2019-08-24T14:15:22Z",
"state": "InSetupPhase",
"subState": "NeverContactedCloud",
"tags": ["string"
],
"uptime_seconds": 0,
"venueId": "string"
}

Trigger AP Action Deprecated

Trigger AP action.

path Parameters

serialNumber

required

string

The serial number of the AP.

Request Body schema: application/json
required

action required	string Enum: "ping" "traceRoute" "reboot" "factoryReset" "blinkLed"
targetHost	string(^((22[0-3]\|2[0-1][0-9]\|1[0-9][0-9]\|[1-9][0-9...

Responses

Request samples

Payload

Content type

application/json

{"action": "ping",
"targetHost": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"response": "string"
}
}

Update AP Deprecated

Update an AP.

path Parameters

serialNumber

required

string

The serial number of the AP.

Request Body schema: application/json
required

apGroupId	string
description	string [ 0 .. 180 ] characters
	object (Wi-Fi_API_and_Model_Documentation_DeviceGps) Ap or Venue latitude and longitude
model	string [ 0 .. 64 ] characters Default: "null"
name required	string(?=^((?!`\|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$
	object (Wi-Fi_API_and_Model_Documentation_ApPosition) AP position object
serialNumber required	string^[1-9][0-9]{11}$
tags	Array of strings [ 0 .. 24 ] items [ items [ 0 .. 24 ] characters ]
venueId required	string

Responses

Request samples

Payload

Content type

application/json

{"apGroupId": "string",
"description": "string",
"deviceGps": {"latitude": "string",
"longitude": "string"
},
"model": "null",
"name": "string",
"position": {"floorplanId": "string",
"xPercent": 0,
"yPercent": 0
},
"serialNumber": "string",
"tags": ["string"
],
"venueId": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Basic Service Set Coloring Settings Deprecated

Get basic service set coloring settings of this AP.

path Parameters

serialNumber

required

string

The serial number of the AP

Responses

Response samples

Content type

application/json

{"bssColoringEnabled": false,
"useVenueSettings": true
}

Update AP Basic Service Set Coloring Settings Deprecated

Update basic service set coloring settings of this AP.

path Parameters

serialNumber

required

string

The serial number of the AP

Request Body schema: application/json
required

bssColoringEnabled	boolean Default: false
useVenueSettings	boolean Default: true

Responses

Request samples

Payload

Content type

application/json

{"bssColoringEnabled": false,
"useVenueSettings": true
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Capabilities Deprecated

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"apModels": [{"allowCbandCountry": ["string"
],
"allowDfsCountry": ["string"
],
"bandCombinationCapabilities": ["DUAL"
],
"canSupportCellular": false,
"canSupportLacp": false,
"canSupportPoeMode": false,
"canSupportPoeOut": false,
"capabilityScore": 0,
"defaultBandCombination": "DUAL",
"externalAntenna": {"coupled": false,
"enable24G": false,
"enable50G": false,
"gain24G": 60,
"gain50G": 60,
"supportDisable": false
},
"has160MHzChannelBandwidth": false,
"isOutdoor": false,
"lanPortPictureDownloadUrl": "string",
"lanPorts": [{"defaultType": "string",
"displayLabel": "string",
"id": "string",
"isPoeOutPort": false,
"isPoePort": false,
"supportDisable": false,
"trunkPortOnly": false,
"untagId": 0,
"vlanMembers": "string"
}
],
"ledOn": false,
"lldpAdInterval": 0,
"lldpEnable": false,
"lldpHoldTime": 0,
"lldpMgmtEnable": false,
"maxChannelization24G": 0,
"maxChannelization5G": 0,
"maxChannelization6G": 0,
"model": "string",
"pictureDownloadUrl": "string",
"poeModeCapabilities": ["string"
],
"primaryWanRecoveryTimer": 0,
"requireOneEnabledTrunkPort": false,
"simCardPrimaryApn": "string",
"simCardPrimaryCellularNetworkSelection": "string",
"simCardPrimaryEnabled": true,
"simCardPrimaryRoaming": true,
"simCardSecondaryApn": "string",
"simCardSecondaryCellularNetworkSelection": "string",
"simCardSecondaryEnabled": true,
"simCardSecondaryRoaming": true,
"support11AX": false,
"supportBandCombination": false,
"supportChannel144": false,
"supportDual5gMode": false,
"supportMesh": true,
"supportTriRadio": false,
"version": "string",
"wanConnection": "string"
}
]
}

Get AP Default Regulatory-Channels Deprecated

Get AP default regulatory channels.

path Parameters

serialNumber

required

string

AP serialNumber

Responses

Response samples

Content type

application/json

{"2.4GChannels": {"20MHz": ["1"
],
"40MHz": ["1"
],
"auto": ["1"
]
},
"5GChannels": {"dfs": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoorForOutdoorAp": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"outdoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
}
},
"5GLowerChannels": {"dfs": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoorForOutdoorAp": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"outdoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
}
},
"5GUpperChannels": {"dfs": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoorForOutdoorAp": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"outdoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
}
},
"6GChannels": {"160MHz": ["1"
],
"20MHz": ["1"
],
"40MHz": ["1"
],
"80MHz": ["1"
],
"auto": ["1"
]
}
}

Reset AP Client Admission Control Settings Deprecated

Reset the client admission control settings of this AP to the default values.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Client Admission Control Settings Deprecated

Get the client admission control settings of this AP.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"enable24G": false,
"enable50G": false,
"maxRadioLoad24G": 75,
"maxRadioLoad50G": 75,
"minClientCount24G": 10,
"minClientCount50G": 20,
"minClientThroughput24G": 0,
"minClientThroughput50G": 0,
"useVenueSettings": true
}

Update AP Client Admission Control Settings Deprecated

Update the client admission control settings of this AP.

path Parameters

serialNumber

required

string

The serial number of the AP

Request Body schema:
application/json
required

enable24G	boolean Default: false
enable50G	boolean Default: false
maxRadioLoad24G	integer <int32> [ 50 .. 100 ] Default: 75
maxRadioLoad50G	integer <int32> [ 50 .. 100 ] Default: 75
minClientCount24G	integer <int32> [ 0 .. 100 ] Default: 10
minClientCount50G	integer <int32> [ 0 .. 100 ] Default: 20
minClientThroughput24G	integer <int32> [ 0 .. 100 ] Default: 0
minClientThroughput50G	integer <int32> [ 0 .. 100 ] Default: 0
useVenueSettings	boolean Default: true

Responses

Request samples

Payload

Content type

application/json

{"enable24G": false,
"enable50G": false,
"maxRadioLoad24G": 75,
"maxRadioLoad50G": 75,
"minClientCount24G": 10,
"minClientCount50G": 20,
"minClientThroughput24G": 0,
"minClientThroughput50G": 0,
"useVenueSettings": true
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get DHCP Lease Times Deprecated

Get DHCP lease time collections.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

[{"dhcpProfileId": "string",
"dhcpProfileName": "string",
"hostname": "string",
"ipAddress": "string",
"leaseExpiration": "string",
"macAddress": "string",
"status": "string"
}
]

Get DHCP Pool Usages Deprecated

Get DHCP pool usage.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

[{"endIpAddress": "string",
"id": "string",
"leaseTimeHours": 24,
"leaseTimeMinutes": 59,
"name": "string",
"primaryDnsIp": "string",
"secondaryDnsIp": "string",
"startIpAddress": "string",
"subnetAddress": "string",
"subnetMask": "string",
"totalIpCount": 0,
"usedIpCount": 0,
"venues": [{"id": "string",
"name": "string"
}
],
"vlanId": 1
}
]

Reset AP Directed Multicast Settings Deprecated

Reset AP directed multicast to default settings.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Directed Multicast Settings Deprecated

Get directed multicast settings for this AP.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"networkEnabled": false,
"useVenueSettings": true,
"wiredEnabled": false,
"wirelessEnabled": false
}

Update AP Directed Multicast Settings Deprecated

Update directed multicast settings of this AP.

path Parameters

serialNumber

required

string

The serial number of the AP.

Request Body schema: application/json
required

networkEnabled	boolean Default: false
useVenueSettings	boolean Default: true
wiredEnabled	boolean Default: false
wirelessEnabled	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"networkEnabled": false,
"useVenueSettings": true,
"wiredEnabled": false,
"wirelessEnabled": false
}

Response samples

Content type

application/json

{"requestId": "string"
}

Update AP Position Deprecated

Update an AP floor-plan position.

path Parameters

serialNumber

required

string

The serial number of the AP.

Request Body schema: application/json
required

floorplanId	string
xPercent	number <float> [ 0 .. 100 ] Default: 0
yPercent	number <float> [ 0 .. 100 ] Default: 0

Responses

Request samples

Payload

Content type

application/json

{"floorplanId": "string",
"xPercent": 0,
"yPercent": 0
}

Response samples

Content type

application/json

{"requestId": "string"
}

Reset AP LAN-Ports Deprecated

Reset the LAN-ports of an AP to the default values.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP LAN-Ports Deprecated

Get AP LAN-ports details.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"lanPorts": [{"enabled": true,
"portId": "string",
"type": "ACCESS",
"untagId": 1,
"vlanMembers": "string"
}
],
"poeOut": false,
"useVenueSettings": false
}

Update AP LAN-Ports Deprecated

Update LAN-ports of an AP.

path Parameters

serialNumber

required

string

The serial number of the AP.

Request Body schema: application/json
required

	Array of objects (Wi-Fi_API_and_Model_Documentation_ApLanPort)
poeOut	boolean Default: false
useVenueSettings	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"lanPorts": [{"enabled": true,
"portId": "string",
"type": "ACCESS",
"untagId": 1,
"vlanMembers": "string"
}
],
"poeOut": false,
"useVenueSettings": false
}

Response samples

Content type

application/json

{"requestId": "string"
}

Reset AP LED Deprecated

Reset the LED of an AP to the default values.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP LED Deprecated

Get AP LED settings.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"ledEnabled": false,
"useVenueSettings": false
}

Update AP LED Deprecated

Update LED of an AP.

path Parameters

serialNumber

required

string

The serial number of the AP.

Request Body schema: application/json
required

ledEnabled	boolean Default: false
useVenueSettings	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"ledEnabled": false,
"useVenueSettings": false
}

Response samples

Content type

application/json

{"requestId": "string"
}

Download AP Log Deprecated

Download the AP log file.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"fileURL": "string"
}

Get AP Mesh Settings Deprecated

Get mesh settings for this AP.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"meshMode": "AUTO",
"uplinkMacAddresses": ["string"
],
"uplinkMode": "SMART",
"venueMeshEnabled": false
}

Update AP Mesh Settings Deprecated

Update mesh settings of this AP.

path Parameters

serialNumber

required

string

The serial number of the AP.

Request Body schema: application/json
required

meshMode	string Default: "MeshModeEnum.AUTO" Enum: "AUTO" "ROOT" "MESH" "DISABLED"
uplinkMacAddresses	Array of strings
uplinkMode	string Default: "MeshUplinkModeEnum.SMART" Enum: "SMART" "MANUAL"

Responses

Request samples

Payload

Content type

application/json

{"meshMode": "AUTO",
"uplinkMacAddresses": ["string"
],
"uplinkMode": "SMART"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Reset AP Network Settings Deprecated

Reset AP network settings.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Network Settings Deprecated

Get network settings for this AP.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"gateway": "string",
"ip": "string",
"ipType": "DYNAMIC",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string"
}

Update AP Network Settings Deprecated

Update network settings of this AP.

path Parameters

serialNumber

required

string

The serial number of the AP.

Request Body schema: application/json
required

gateway	string^(?:(?:25[0-5]\|2[0-4][0-9]\|1[0-9][0-9]\|[1-9][...
ip	string^(?:(?:25[0-5]\|2[0-4][0-9]\|1[0-9][0-9]\|[1-9][...
ipType required	string Enum: "DYNAMIC" "STATIC"
netmask	string^(?:(?:(?:255\.){3}(?:252\|248\|240\|224\|192\|128...
primaryDnsServer	string^(?:(?:25[0-5]\|2[0-4][0-9]\|1[0-9][0-9]\|[1-9][...
secondaryDnsServer	string^(?:(?:25[0-5]\|2[0-4][0-9]\|1[0-9][0-9]\|[1-9][...

Responses

Request samples

Payload

Content type

application/json

{"gateway": "string",
"ip": "string",
"ipType": "DYNAMIC",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Stop Packet Capture Deprecated

Stop packet capture.

path Parameters

serialNumber

required

string

Request Body schema: application/json
required

sessionId

string

Responses

Request samples

Payload

Content type

application/json

{"sessionId": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Packet Capture State Deprecated

Get packet capture state.

path Parameters

serialNumber

required

string

Responses

Response samples

Content type

application/json

{"errorMsg": "string",
"fileName": "string",
"fileUrl": "string",
"sessionId": "string",
"status": "IDLE"
}

Start Packet Capture Deprecated

Start packet capture.

path Parameters

serialNumber

required

string

Request Body schema: application/json
required

captureInterface required	string Enum: "RADIO24" "RADIO50" "RADIO50UPPER" "RADIO50LOWER" "RADIO60" "ETH0" "ETH1" "ETH2" "ETH3" "ETH4" "ETH5" "ETH6" "ETH7"
frameTypeFilter	Array of strings Items Enum: "MANAGEMENT" "CONTROL" "DATA"
macAddressFilter	string^$\|^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$\|...

Responses

Request samples

Payload

Content type

application/json

{"captureInterface": "RADIO24",
"frameTypeFilter": ["MANAGEMENT"
],
"macAddressFilter": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"sessionId": "string"
}
}

Delete AP Picture Deprecated

Delete AP picture.

path Parameters

serialNumber

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Picture Deprecated

Get AP picture.

path Parameters

serialNumber

required

string

Responses

Response samples

Content type

application/json

{"id": "string",
"imageId": "null",
"imageName": "null",
"imageUrl": "string"
}

Upload AP Picture Deprecated

Upload AP picture.

path Parameters

serialNumber

required

string

Request Body schema: multipart/form-data

file

required

string <binary>

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Reset AP Radio Customization Deprecated

Reset AP radio to default settings.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Radio Deprecated

Get AP radio details.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"apRadioParams24G": {"allowedChannels": ["1"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams50G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams6G": {"allowedChannels": ["1"
],
"bssMinRate6G": "HE_MCS_0",
"changeInterval": 33,
"channelBandwidth": "AUTO",
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastUplinkRateLimiting": false,
"manualChannel": 0,
"method": "MANUAL",
"mgmtTxRate6G": "6",
"multicastDownlinkRateLimiting": 1,
"multicastUplinkRateLimiting": 1,
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "MAX",
"useVenueSettings": false
},
"apRadioParamsDual5G": {"enabled": true,
"lower5gEnabled": false,
"radioParamsLower5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"radioParamsUpper5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"upper5gEnabled": false,
"useVenueEnabled": false
},
"enable24G": false,
"enable50G": false,
"enable6G": false,
"useVenueSettings": true
}

Update AP Radio Deprecated

Update an AP radio settings.

path Parameters

serialNumber

required

string

The serial number of the AP.

Request Body schema: application/json
required

	object (Wi-Fi_API_and_Model_Documentation_ApRadioParams24G) AP radio customization for 2.4GHz.
	object (Wi-Fi_API_and_Model_Documentation_ApRadioParams50G) AP radio customization for 5GHz.
	object (Wi-Fi_API_and_Model_Documentation_ApRadioParams6G) AP radio customization for 6GHz.
	object (Wi-Fi_API_and_Model_Documentation_ApRadioParamsDual5G) AP radio customization for dual 5GHz radios.
enable24G	boolean Default: false
enable50G	boolean Default: false
enable6G	boolean Default: false
useVenueSettings	boolean Default: true

Responses

Request samples

Payload

Content type

application/json

{"apRadioParams24G": {"allowedChannels": ["1"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams50G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams6G": {"allowedChannels": ["1"
],
"bssMinRate6G": "HE_MCS_0",
"changeInterval": 33,
"channelBandwidth": "AUTO",
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastUplinkRateLimiting": false,
"manualChannel": 0,
"mgmtTxRate6G": "6",
"multicastDownlinkRateLimiting": 1,
"multicastUplinkRateLimiting": 1,
"txPower": "MAX",
"useVenueSettings": false
},
"apRadioParamsDual5G": {"enabled": true,
"lower5gEnabled": false,
"radioParamsLower5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"radioParamsUpper5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"upper5gEnabled": false,
"useVenueEnabled": false
},
"enable24G": false,
"enable50G": false,
"enable6G": false,
"useVenueSettings": true
}

Response samples

Content type

application/json

{"requestId": "string"
}

Reset AP SNMP Agent Settings Deprecated

Reset AP SNMP agent to default settings.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP SNMP Agent Settings Deprecated

Get SNMP agent settings for this AP.

path Parameters

serialNumber

required

string

The serial number of the AP.

Responses

Response samples

Content type

application/json

{"apSnmpAgentProfileId": "string",
"enableApSnmp": false,
"useVenueSettings": true
}

Update AP SNMP Agent Settings Deprecated

Update SNMP agent settings of this AP.

path Parameters

serialNumber

required

string

The serial number of the AP.

Request Body schema: application/json
required

apSnmpAgentProfileId	string
enableApSnmp	boolean Default: false
useVenueSettings	boolean Default: true

Responses

Request samples

Payload

Content type

application/json

{"apSnmpAgentProfileId": "string",
"enableApSnmp": false,
"useVenueSettings": true
}

Response samples

Content type

application/json

{"requestId": "string"
}

Reset AP Customization Deprecated

Reset the customization of an AP to the default values.

path Parameters

serialNumber

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Customization Deprecated

GET AP customization details.

path Parameters

serialNumber

required

string

Responses

Response samples

Content type

application/json

{"bandMode": "DUAL",
"externalAntenna": {"coupled": false,
"enable24G": false,
"enable50G": false,
"gain24G": 60,
"gain50G": 60,
"supportDisable": false
},
"id": "string",
"lanPorts": [{"enabled": true,
"portId": "string",
"type": "ACCESS",
"untagId": 1,
"vlanMembers": "string"
}
],
"ledEnabled": false,
"poeOut": false,
"useVenueSettings": false
}

Update AP Customization Deprecated

Update the customization of an AP.

path Parameters

serialNumber

required

string

Request Body schema: application/json
required

bandMode	string Enum: "DUAL" "TRIPLE"
	object (Wi-Fi_API_and_Model_Documentation_ExternalAntenna) External antenna settings
	Array of objects (Wi-Fi_API_and_Model_Documentation_ApLanPort)
ledEnabled	boolean Default: false
poeOut	boolean Default: false
useVenueSettings	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"bandMode": "DUAL",
"externalAntenna": {"coupled": false,
"enable24G": false,
"enable50G": false,
"gain24G": 60,
"gain50G": 60,
"supportDisable": false
},
"lanPorts": [{"enabled": true,
"portId": "string",
"type": "ACCESS",
"untagId": 1,
"vlanMembers": "string"
}
],
"ledEnabled": false,
"poeOut": false,
"useVenueSettings": false
}

Response samples

Content type

application/json

{"requestId": "string"
}

Add AP with AP Group

Add a new AP with AP group.

path Parameters

venueId required	string Venue ID.
apGroupId required	string AP Group ID.

Request Body schema:
application/json
required

description	string [ 0 .. 180 ] characters
	object (Wi-Fi_API_and_Model_Documentation_DeviceGps) Ap or Venue latitude and longitude
model	string [ 0 .. 64 ] characters Default: "null"
name required	string(?=^((?!`\|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$
serialNumber required	string^[1-9][0-9]{11}$
tags	Array of strings [ 0 .. 24 ] items [ items [ 0 .. 24 ] characters ]

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"deviceGps": {"latitude": "string",
"longitude": "string"
},
"model": "null",
"name": "string",
"serialNumber": "string",
"tags": ["string"
]
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"id": "string"
}
}

Move AP Into AP Group

Use this API to move AP into the AP group.

path Parameters

venueId required	string Venue ID
apGroupId required	string AP Group ID.
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Add AP or Import APs

Add a new AP or import a bunch of APs by a CSV file.

path Parameters

venueId

required

string

Venue ID.

Request Body schema:
application/json
required

description	string [ 0 .. 180 ] characters
	object (Wi-Fi_API_and_Model_Documentation_DeviceGps) Ap or Venue latitude and longitude
model	string [ 0 .. 64 ] characters Default: "null"
name required	string(?=^((?!`\|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$
serialNumber required	string^[1-9][0-9]{11}$
tags	Array of strings [ 0 .. 24 ] items [ items [ 0 .. 24 ] characters ]

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"deviceGps": {"latitude": "string",
"longitude": "string"
},
"model": "null",
"name": "string",
"serialNumber": "string",
"tags": ["string"
]
}

Response samples

Content type

application/json

Example

Wi-Fi_API_and_Model_Documentation_OperationResponseRequestIdOnly

{"requestId": "string"
}

Get Import Venue APs Results

Get result for import venue APs from CSV file.

path Parameters

venueId

required

string

The ID of the venue.

query Parameters

operationRequestId

required

string

The request ID of the import venue APs operation.

Responses

Response samples

Content type

application/json

{"downloadUrl": "string",
"errors": [{"code": 0,
"description": "string"
}
],
"fileErrorCount": 0,
"operationRequestId": "string"
}

Delete AP

Delete an AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

query Parameters

resetFirmware

boolean

Default: false

Reset AP firmware to Standalone image.

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP

Get the AP general info.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"description": "string",
"deviceGps": {"latitude": "string",
"longitude": "string"
},
"loginPassword": "string",
"model": "null",
"name": "string",
"tags": ["string"
]
}

Update AP

Update an AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Request Body schema:
application/json
required

description	string [ 0 .. 180 ] characters
	object (Wi-Fi_API_and_Model_Documentation_DeviceGps) Ap or Venue latitude and longitude
model	string [ 0 .. 64 ] characters Default: "null"
name required	string(?=^((?!`\|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$
tags	Array of strings [ 0 .. 24 ] items [ items [ 0 .. 24 ] characters ]

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"deviceGps": {"latitude": "string",
"longitude": "string"
},
"model": "null",
"name": "string",
"tags": ["string"
]
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Band Mode

Get AP band mode settings.

path Parameters

venueId required	string Venue ID
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"bandMode": "DUAL",
"useVenueSettings": false
}

Update AP Band Mode

Update AP band mode settings.

path Parameters

venueId required	string Venue ID
serialNumber required	string The serial number of the AP.

Request Body schema:
application/json
required

bandMode	string Enum: "DUAL" "TRIPLE"
useVenueSettings	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"bandMode": "DUAL",
"useVenueSettings": false
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Basic Service Set Coloring Settings

Get basic service set coloring settings of this AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP

Responses

Response samples

Content type

application/json

{"bssColoringEnabled": false,
"useVenueSettings": false
}

Update AP Basic Service Set Coloring Settings

Update basic service set coloring settings of this AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP

Request Body schema:
application/json
required

bssColoringEnabled	boolean Default: false
useVenueSettings	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"bssColoringEnabled": false,
"useVenueSettings": false
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Capabilities

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"allowCbandCountry": ["string"
],
"allowDfsCountry": ["string"
],
"bandCombinationCapabilities": ["DUAL"
],
"canSupportCellular": false,
"canSupportLacp": false,
"canSupportPoeMode": false,
"canSupportPoeOut": false,
"capabilityScore": 0,
"defaultBandCombination": "DUAL",
"externalAntenna": {"coupled": false,
"enable24G": false,
"enable50G": false,
"gain24G": 60,
"gain50G": 60,
"supportDisable": false
},
"has160MHzChannelBandwidth": false,
"isOutdoor": false,
"lanPortPictureDownloadUrl": "string",
"lanPorts": [{"defaultType": "string",
"displayLabel": "string",
"id": "string",
"isPoeOutPort": false,
"isPoePort": false,
"supportDisable": false,
"trunkPortOnly": false,
"untagId": 0,
"vlanMembers": "string"
}
],
"ledOn": false,
"lldpAdInterval": 0,
"lldpEnable": false,
"lldpHoldTime": 0,
"lldpMgmtEnable": false,
"maxChannelization24G": 0,
"maxChannelization5G": 0,
"maxChannelization6G": 0,
"model": "string",
"pictureDownloadUrl": "string",
"poeModeCapabilities": ["string"
],
"primaryWanRecoveryTimer": 0,
"requireOneEnabledTrunkPort": false,
"simCardPrimaryApn": "string",
"simCardPrimaryCellularNetworkSelection": "string",
"simCardPrimaryEnabled": true,
"simCardPrimaryRoaming": true,
"simCardSecondaryApn": "string",
"simCardSecondaryCellularNetworkSelection": "string",
"simCardSecondaryEnabled": true,
"simCardSecondaryRoaming": true,
"support11AX": false,
"supportBandCombination": false,
"supportChannel144": false,
"supportDual5gMode": false,
"supportMesh": true,
"supportTriRadio": false,
"version": "string",
"wanConnection": "string"
}

Get AP Client Admission Control Settings

Get the client admission control settings of this AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/clientAdmissionControlSettings

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/clientAdmissionControlSettings

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/clientAdmissionControlSettings

Response samples

Content type

application/json

{"enable24G": false,
"enable50G": false,
"maxRadioLoad24G": 75,
"maxRadioLoad50G": 75,
"minClientCount24G": 10,
"minClientCount50G": 20,
"minClientThroughput24G": 0,
"minClientThroughput50G": 0,
"useVenueSettings": false
}

Update AP Client Admission Control Settings

Update the client admission control settings of this AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP

Request Body schema:
application/json
required

enable24G	boolean Default: false
enable50G	boolean Default: false
maxRadioLoad24G	integer <int32> [ 50 .. 100 ] Default: 75
maxRadioLoad50G	integer <int32> [ 50 .. 100 ] Default: 75
minClientCount24G	integer <int32> [ 0 .. 100 ] Default: 10
minClientCount50G	integer <int32> [ 0 .. 100 ] Default: 20
minClientThroughput24G	integer <int32> [ 0 .. 100 ] Default: 0
minClientThroughput50G	integer <int32> [ 0 .. 100 ] Default: 0
useVenueSettings	boolean Default: false

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/clientAdmissionControlSettings

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/clientAdmissionControlSettings

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/clientAdmissionControlSettings

Request samples

Payload

Content type

application/json

{"enable24G": false,
"enable50G": false,
"maxRadioLoad24G": 75,
"maxRadioLoad50G": 75,
"minClientCount24G": 10,
"minClientCount50G": 20,
"minClientThroughput24G": 0,
"minClientThroughput50G": 0,
"useVenueSettings": false
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP DHCP Settings

Get DHCP settings by AP serial number.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"dhcpApRole": "PrimaryServer",
"serialNumber": "stringstring"
}

Trigger AP Diagnosis Commands

Trigger diagnosis commands for the AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Request Body schema:
application/json
required

targetHost	string(^((22[0-3]\|2[0-1][0-9]\|1[0-9][0-9]\|[1-9][0-9...
type required	string Enum: "PING" "TRACE_ROUTE" "BLINK_LED"

Responses

Request samples

Payload

Content type

application/json

{"targetHost": "string",
"type": "PING"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"response": "string"
}
}

Get AP Directed Multicast Settings

Get directed multicast settings for this AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"networkEnabled": false,
"useVenueSettings": false,
"wiredEnabled": false,
"wirelessEnabled": false
}

Update AP Directed Multicast Settings

Update directed multicast settings of this AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Request Body schema:
application/json
required

networkEnabled	boolean Default: false
useVenueSettings	boolean Default: false
wiredEnabled	boolean Default: false
wirelessEnabled	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"networkEnabled": false,
"useVenueSettings": false,
"wiredEnabled": false,
"wirelessEnabled": false
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP External Antenna Settings

Get AP external antenna settings.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"externalAntenna": {"coupled": false,
"enable24G": false,
"enable50G": false,
"gain24G": 60,
"gain50G": 60,
"supportDisable": false
},
"useVenueSettings": false
}

Update AP External Antenna Settings

Update external antenna settings of an AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Request Body schema:
application/json
required

	object (Wi-Fi_API_and_Model_Documentation_ExternalAntenna) External antenna settings
useVenueSettings	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"externalAntenna": {"coupled": false,
"enable24G": false,
"enable50G": false,
"gain24G": 60,
"gain50G": 60,
"supportDisable": false
},
"useVenueSettings": false
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP LAN-Ports Deprecated

Get AP LAN-ports details.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

query Parameters

defaultOnly

boolean

Default: false

Only get the details of default LAN-port settings of the AP.

Responses

Response samples

Content type

application/json

{"lanPorts": [{"enabled": true,
"portId": "string",
"type": "ACCESS",
"untagId": 1,
"vlanMembers": "string"
}
],
"poeMode": "Auto",
"poeOut": false,
"useVenueSettings": false
}

Update AP LAN-Ports Deprecated

Update LAN-ports of an AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Request Body schema:
application/json
required

	Array of objects (Wi-Fi_API_and_Model_Documentation_ApLanPort)
poeMode	string Enum: "Auto" "802.3af" "802.3at" "802.3bt-Class_5" "802.3bt-Class_6" "802.3bt-Class_7" "802.3bt-Class_8"
poeOut	boolean Default: false
useVenueSettings	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"lanPorts": [{"enabled": true,
"portId": "string",
"type": "ACCESS",
"untagId": 1,
"vlanMembers": "string"
}
],
"poeMode": "Auto",
"poeOut": false,
"useVenueSettings": false
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP LED

Get AP LED settings.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"ledEnabled": false,
"useVenueSettings": false
}

Update AP LED

Update LED of an AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Request Body schema:
application/json
required

ledEnabled	boolean Default: false
useVenueSettings	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"ledEnabled": false,
"useVenueSettings": false
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get the AP Log Info

Get the AP log info.

path Parameters

venueId required	string The ID of the venue.
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"fileUrl": "string"
}

Get AP Management Traffic VLAN Settings

Get the AP management traffic VLAN settings of this AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/managementTrafficVlanSettings

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/managementTrafficVlanSettings

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/managementTrafficVlanSettings

Response samples

Content type

application/json

{"useVenueSettings": false,
"vlanId": 1
}

Update AP Management Traffic VLAN Settings

Update the AP management traffic VLAN settings of this AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP

Request Body schema:
application/json
required

useVenueSettings	boolean Default: false
vlanId	integer <int32> [ 1 .. 4094 ] Default: 1

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/managementTrafficVlanSettings

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/managementTrafficVlanSettings

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/managementTrafficVlanSettings

Request samples

Payload

Content type

application/json

{"useVenueSettings": false,
"vlanId": 1
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Mesh Settings

Get mesh settings for this AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"meshMode": "AUTO",
"uplinkMacAddresses": ["string"
],
"uplinkMode": "SMART"
}

Update AP Mesh Settings

Update mesh settings of this AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Request Body schema:
application/json
required

meshMode	string Default: "MeshModeEnum.AUTO" Enum: "AUTO" "ROOT" "MESH" "DISABLED"
uplinkMacAddresses	Array of strings
uplinkMode	string Default: "MeshUplinkModeEnum.SMART" Enum: "SMART" "MANUAL"

Responses

Request samples

Payload

Content type

application/json

{"meshMode": "AUTO",
"uplinkMacAddresses": ["string"
],
"uplinkMode": "SMART"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Patch AP Neighbors

Ask AP to collect neighbors.

path Parameters

venueId required	string The ID of the venue.
serialNumber required	string The serial number of the AP.

Request Body schema:
application/json
required

status required	string Value: "CURRENT"
type required	string Enum: "RF_NEIGHBOR" "LLDP_NEIGHBOR"

Responses

Request samples

Payload

Content type

application/json

{"status": "CURRENT",
"type": "RF_NEIGHBOR"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Query AP Neighbors

Query the AP's neighbors.

path Parameters

venueId required	string The ID of the venue.
serialNumber required	string The serial number of the AP.

Request Body schema:
application/json
required

	Array of objects (Wi-Fi_API_and_Model_Documentation_ApNeighborQueryFilter)
page	integer <int32> Default: 1
pageSize	integer <int32> Default: 25
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "RF_NEIGHBOR"
}
],
"page": 1,
"pageSize": 25,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

Content type

application/json

{"neighbors": [{"apMac": "string",
"channel24G": "string",
"channel5G": "string",
"channel6G": "string",
"detectedTime": "2019-08-24T14:15:22Z",
"deviceName": "string",
"ip": "string",
"model": "string",
"snr24G": "string",
"snr5G": "string",
"snr6G": "string",
"status": "string",
"venueName": "string"
}
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Get AP Network Settings

Get network settings for this AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"gateway": "string",
"ip": "string",
"ipType": "DYNAMIC",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string"
}

Update AP Network Settings

Update network settings of this AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Request Body schema:
application/json
required

gateway	string^(?:(?:25[0-5]\|2[0-4][0-9]\|1[0-9][0-9]\|[1-9][...
ip	string^(?:(?:25[0-5]\|2[0-4][0-9]\|1[0-9][0-9]\|[1-9][...
ipType required	string Enum: "DYNAMIC" "STATIC"
netmask	string^(?:(?:(?:255\.){3}(?:252\|248\|240\|224\|192\|128...
primaryDnsServer	string^(?:(?:25[0-5]\|2[0-4][0-9]\|1[0-9][0-9]\|[1-9][...
secondaryDnsServer	string^(?:(?:25[0-5]\|2[0-4][0-9]\|1[0-9][0-9]\|[1-9][...

Responses

Request samples

Payload

Content type

application/json

{"gateway": "string",
"ip": "string",
"ipType": "DYNAMIC",
"netmask": "string",
"primaryDnsServer": "string",
"secondaryDnsServer": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Packets

Get the AP packet capture result.

path Parameters

venueId required	string The ID of the venue.
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"errorMsg": "string",
"fileName": "string",
"fileUrl": "string",
"sessionId": "string",
"state": "IDLE"
}

Patch AP Packets

To start or stop the AP packet capture.

path Parameters

venueId required	string The ID of the venue.
serialNumber required	string The serial number of the AP.

Request Body schema: application/json
required

action	string Enum: "START" "STOP"
captureInterface	string Enum: "RADIO24" "RADIO50" "RADIO50UPPER" "RADIO50LOWER" "RADIO60" "ETH0" "ETH1" "ETH2" "ETH3" "ETH4" "ETH5" "ETH6" "ETH7"
frameTypeFilter	Array of strings Items Enum: "MANAGEMENT" "CONTROL" "DATA"
macAddressFilter	string^$\|^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$\|...
sessionId	string

Responses

Request samples

Payload

Content type

application/json

{"action": "START",
"captureInterface": "RADIO24",
"frameTypeFilter": ["MANAGEMENT"
],
"macAddressFilter": "string",
"sessionId": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"sessionId": "string"
}
}

Delete AP Pictures

Delete the AP's pictures.

path Parameters

venueId required	string The ID of the venue.
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Pictures

Get the AP's pictures.

path Parameters

venueId required	string The ID of the venue.
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"id": "null",
"name": "null",
"url": "string"
}

Update AP Pictures

Update the AP's pictures.

path Parameters

venueId required	string The ID of the venue.
serialNumber required	string The serial number of the AP.

Request Body schema: multipart/form-data

file

required

string <binary>

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Radio

Get AP radio details.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"apRadioParams24G": {"allowedChannels": ["1"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams50G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams6G": {"allowedChannels": ["1"
],
"bssMinRate6G": "HE_MCS_0",
"changeInterval": 33,
"channelBandwidth": "AUTO",
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastUplinkRateLimiting": false,
"manualChannel": 0,
"method": "MANUAL",
"mgmtTxRate6G": "6",
"multicastDownlinkRateLimiting": 1,
"multicastUplinkRateLimiting": 1,
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "MAX",
"useVenueSettings": false
},
"apRadioParamsDual5G": {"enabled": false,
"lower5gEnabled": false,
"radioParamsLower5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"radioParamsUpper5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"upper5gEnabled": false,
"useVenueEnabled": false
},
"enable24G": true,
"enable50G": true,
"enable6G": false
}

Update AP Radio

Update an AP radio settings.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Request Body schema:
application/json
required

	object (Wi-Fi_API_and_Model_Documentation_ApRadio24GHzSettings) AP radio customization for 2.4GHz.
	object (Wi-Fi_API_and_Model_Documentation_ApRadio5GHzSettings) AP radio customization for 5GHz.
	object (Wi-Fi_API_and_Model_Documentation_ApRadio6GHzSettings) AP radio customization for 6GHz.
	object (Wi-Fi_API_and_Model_Documentation_ApRadioDual5GHzSettings) AP radio customization for dual 5GHz radios.
enable24G	boolean Default: true
enable50G	boolean Default: true
enable6G	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"apRadioParams24G": {"allowedChannels": ["1"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams50G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams6G": {"allowedChannels": ["1"
],
"bssMinRate6G": "HE_MCS_0",
"changeInterval": 33,
"channelBandwidth": "AUTO",
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastUplinkRateLimiting": false,
"manualChannel": 0,
"mgmtTxRate6G": "6",
"multicastDownlinkRateLimiting": 1,
"multicastUplinkRateLimiting": 1,
"txPower": "MAX",
"useVenueSettings": false
},
"apRadioParamsDual5G": {"enabled": false,
"lower5gEnabled": false,
"radioParamsLower5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"radioParamsUpper5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"upper5gEnabled": false,
"useVenueEnabled": false
},
"enable24G": true,
"enable50G": true,
"enable6G": false
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Smart Monitor Settings

Get the smart monitor settings of this AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"enabled": false,
"interval": 10,
"threshold": 3,
"useVenueSettings": false
}

Update AP Smart Monitor Settings

Update the smart monitor settings of this AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP

Request Body schema:
application/json
required

enabled	boolean Default: false
interval	integer <int32> [ 5 .. 60 ] Default: 10 The interval how often smart monitor checks uplink status, measured by seconds.
threshold	integer <int32> [ 1 .. 10 ] Default: 3 The retry threshold for turning off the WLANs.
useVenueSettings	boolean Default: false True if using venue settings (overriding AP settings).

Responses

Request samples

Payload

Content type

application/json

{"enabled": false,
"interval": 10,
"threshold": 3,
"useVenueSettings": false
}

Response samples

Content type

application/json

{"requestId": "string"
}

Reset AP Sticky Client Steering Settings

Reset the sticky client steering settings of this AP to use the venue's settings.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/stickyClientSteeringSettings

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/stickyClientSteeringSettings

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/stickyClientSteeringSettings

Response samples

Content type

application/json

{"requestId": "string"
}

Update AP Sticky Client Steering Settings

Update the sticky client steering settings of this AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP

Request Body schema:
application/json
required

enabled	boolean Default: false True if sticky client steering is enabled.
neighborApPercentageThreshold	integer <int32> [ 10 .. 40 ] Default: 20
snrThreshold	integer <int32> [ 5 .. 30 ] Default: 15

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/stickyClientSteeringSettings

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/stickyClientSteeringSettings

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/stickyClientSteeringSettings

Request samples

Payload

Content type

application/json

{"enabled": false,
"neighborApPercentageThreshold": 20,
"snrThreshold": 15
}

Response samples

Content type

application/json

{"requestId": "string"
}

Trigger AP System Commands

Trigger system commands for the AP.

path Parameters

venueId required	string Venue ID.
serialNumber required	string The serial number of the AP.

Request Body schema:
application/json
required

type

required

string

Enum: "REBOOT" "FACTORY_RESET"

Responses

Request samples

Payload

Content type

application/json

{"type": "REBOOT"
}

Response samples

Content type

application/json

{ }

Get AP Available Channels

Get AP available channels.

path Parameters

venueId required	string Venue ID.
serialNumber required	string AP serialNumber

Responses

Response samples

Content type

application/json

{"2.4GChannels": {"20MHz": ["1"
],
"40MHz": ["1"
],
"auto": ["1"
]
},
"5GChannels": {"dfs": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoorForOutdoorAp": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"outdoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
}
},
"5GLowerChannels": {"dfs": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoorForOutdoorAp": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"outdoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
}
},
"5GUpperChannels": {"dfs": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoorForOutdoorAp": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"outdoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
}
},
"6GChannels": {"160MHz": ["1"
],
"20MHz": ["1"
],
"40MHz": ["1"
],
"80MHz": ["1"
],
"auto": ["1"
],
"indoor": {"160MHz": ["1"
],
"20MHz": ["1"
],
"40MHz": ["1"
],
"80MHz": ["1"
],
"auto": ["1"
]
},
"outdoor": {"160MHz": ["1"
],
"20MHz": ["1"
],
"40MHz": ["1"
],
"80MHz": ["1"
],
"auto": ["1"
]
}
}
}

Deactivate AP Floor Position

Deactivate the AP on a floor-plan and remove the position.

path Parameters

venueId required	string Venue ID.
floorplanId required	string Floor plan ID.
serialNumber required	string The serial number of the AP.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/floorplans/{floorplanId}/aps/{serialNumber}/floorPositions

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/floorplans/{floorplanId}/aps/{serialNumber}/floorPositions

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/floorplans/{floorplanId}/aps/{serialNumber}/floorPositions

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Floor Position

Get the position of the AP on a floor-plan.

path Parameters

venueId required	string Venue ID.
floorplanId required	string Floor plan ID.
serialNumber required	string The serial number of the AP.

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/floorplans/{floorplanId}/aps/{serialNumber}/floorPositions

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/floorplans/{floorplanId}/aps/{serialNumber}/floorPositions

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/floorplans/{floorplanId}/aps/{serialNumber}/floorPositions

Response samples

Content type

application/json

{"xPercent": 0,
"yPercent": 0
}

Activate AP Floor Position

Activate the AP on a floor-plan or update the position.

path Parameters

venueId required	string Venue ID.
floorplanId required	string Floor plan ID.
serialNumber required	string The serial number of the AP.

Request Body schema:
application/json
required

xPercent	number <float> [ 0 .. 100 ] Default: 0
yPercent	number <float> [ 0 .. 100 ] Default: 0

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/floorplans/{floorplanId}/aps/{serialNumber}/floorPositions

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/floorplans/{floorplanId}/aps/{serialNumber}/floorPositions

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/floorplans/{floorplanId}/aps/{serialNumber}/floorPositions

Request samples

Payload

Content type

application/json

{"xPercent": 0,
"yPercent": 0
}

Response samples

Content type

application/json

{"requestId": "string"
}

L3ACL Policy

Manage layer-3 ACL policy profiles.

Deactivate Layer-3 ACL Policy On Access Control Profile

Deactivate layer-3 ACL policy on access control profile.

path Parameters

accessControlProfileId required	string Access Control Profile ID
l3AclPolicyId required	string L3Acl Policy ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/l3AclPolicies/{l3AclPolicyId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/l3AclPolicies/{l3AclPolicyId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/l3AclPolicies/{l3AclPolicyId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Layer-3 ACL Policy On Access Control Profile

Activate layer-3 ACL policy on access control profile.

path Parameters

accessControlProfileId required	string Access Control Profile ID
l3AclPolicyId required	string L3Acl Policy ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/l3AclPolicies/{l3AclPolicyId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/l3AclPolicies/{l3AclPolicyId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/l3AclPolicies/{l3AclPolicyId}

Response samples

Content type

application/json

{"requestId": "string"
}

Delete Layer-3 ACL Policies. Deprecated

Delete layer-3 ACL policies.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Layer-3 ACL Policies. Deprecated

Get layer-3 ACL policy collection.

Responses

Response samples

Content type

application/json

[{"defaultAccess": "ALLOW",
"description": "string",
"id": "string",
"l3Rules": [{"access": "ALLOW",
"customProtocol": 1,
"description": "string",
"destination": {"enableIpSubnet": false,
"ip": "string",
"ipMask": "string",
"port": "string"
},
"id": "string",
"priority": 1,
"protocol": "L3ProtocolEnum_TCP",
"source": {"enableIpSubnet": false,
"ip": "string",
"ipMask": "string",
"port": "string"
}
}
],
"name": "string"
}
]

Add Layer-3 ACL

Add layer-3 ACL by policy. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Request Body schema:
application/json
required

defaultAccess	string Default: "AccessEnum.ALLOW" Enum: "ALLOW" "BLOCK"
description	string
	Array of objects (Wi-Fi_API_and_Model_Documentation_L3Rule) [ 1 .. 128 ] items
name required	string [ 2 .. 32 ] characters

Responses

Request samples

Payload

Content type

application/json

{"defaultAccess": "ALLOW",
"description": "string",
"l3Rules": [{"access": "ALLOW",
"customProtocol": 1,
"description": "string",
"destination": {"enableIpSubnet": false,
"ip": "string",
"ipMask": "string",
"port": "string"
},
"priority": 1,
"protocol": "L3ProtocolEnum_TCP",
"source": {"enableIpSubnet": false,
"ip": "string",
"ipMask": "string",
"port": "string"
}
}
],
"name": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"defaultAccess": "ALLOW",
"description": "string",
"id": "string",
"l3Rules": [{"access": "ALLOW",
"customProtocol": 1,
"description": "string",
"destination": {"enableIpSubnet": false,
"ip": "string",
"ipMask": "string",
"port": "string"
},
"id": "string",
"priority": 1,
"protocol": "L3ProtocolEnum_TCP",
"source": {"enableIpSubnet": false,
"ip": "string",
"ipMask": "string",
"port": "string"
}
}
],
"name": "string"
}
}

Delete Layer-3 ACL

Delete layer-3 ACL by policy id. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

l3AclPolicyId

required

string

L3Acl Policy ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Layer-3 ACL

Get layer-3 ACL by policy id.

path Parameters

l3AclPolicyId

required

string

L3Acl Policy ID

Responses

Response samples

Content type

application/json

{"defaultAccess": "ALLOW",
"description": "string",
"id": "string",
"l3Rules": [{"access": "ALLOW",
"customProtocol": 1,
"description": "string",
"destination": {"enableIpSubnet": false,
"ip": "string",
"ipMask": "string",
"port": "string"
},
"id": "string",
"priority": 1,
"protocol": "L3ProtocolEnum_TCP",
"source": {"enableIpSubnet": false,
"ip": "string",
"ipMask": "string",
"port": "string"
}
}
],
"name": "string"
}

Update Layer-3 ACL

Update layer-3 ACL by policy id. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

l3AclPolicyId

required

string

L3Acl Policy ID

Request Body schema:
application/json
required

defaultAccess	string Default: "AccessEnum.ALLOW" Enum: "ALLOW" "BLOCK"
description	string
	Array of objects (Wi-Fi_API_and_Model_Documentation_L3Rule) [ 1 .. 128 ] items
name required	string [ 2 .. 32 ] characters

Responses

Request samples

Payload

Content type

application/json

{"defaultAccess": "ALLOW",
"description": "string",
"l3Rules": [{"access": "ALLOW",
"customProtocol": 1,
"description": "string",
"destination": {"enableIpSubnet": false,
"ip": "string",
"ipMask": "string",
"port": "string"
},
"priority": 1,
"protocol": "L3ProtocolEnum_TCP",
"source": {"enableIpSubnet": false,
"ip": "string",
"ipMask": "string",
"port": "string"
}
}
],
"name": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate Layer-3 ACL Policy On Wi-Fi Network

Deactivate layer-3 ACL policy on Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
l3AclPolicyId required	string L3Acl Policy ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Layer-3 ACL Policy On Wi-Fi Network

Activate layer-3 ACL policy on Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
l3AclPolicyId required	string L3Acl Policy ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

RADIUS Profile

Manage RADIUS server profiles.

Deactivate RADIUS Server Profile On Hotspot 2.0 Identity Provider

Use this API command to delete a relationship between RADIUS server profile and Hotspot 2.0 identity provider.

path Parameters

hotspot20IdentityProviderId required	string Hotspot 2.0 identity provider ID
radiusId required	string RADIUS server profile identity

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/hotspot20IdentityProviders/{hotspot20IdentityProviderId}/radiusServerProfiles/{radiusId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/hotspot20IdentityProviders/{hotspot20IdentityProviderId}/radiusServerProfiles/{radiusId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/hotspot20IdentityProviders/{hotspot20IdentityProviderId}/radiusServerProfiles/{radiusId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate RADIUS Server Profile On Hotspot 2.0 Identity Provider

Use this API command to build a relationship between RADIUS server profile and Hotspot 2.0 identity provider.

path Parameters

hotspot20IdentityProviderId required	string Hotspot 2.0 identity provider ID
radiusId required	string RADIUS server profile identity

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/hotspot20IdentityProviders/{hotspot20IdentityProviderId}/radiusServerProfiles/{radiusId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/hotspot20IdentityProviders/{hotspot20IdentityProviderId}/radiusServerProfiles/{radiusId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/hotspot20IdentityProviders/{hotspot20IdentityProviderId}/radiusServerProfiles/{radiusId}

Response samples

Content type

application/json

{"requestId": "string"
}

Delete RADIUS Profiles Deprecated

Delete a list of RADIUS profiles.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

List RADIUS Profiles Deprecated

List RADIUS profiles.

Responses

Response samples

Content type

application/json

[{"id": "string",
"name": "string",
"primary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
},
"secondary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
},
"type": "AUTHENTICATION"
}
]

Add RADIUS Profile

Add a RADIUS profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Request Body schema:
application/json
required

name	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
required	object (Wi-Fi_API_and_Model_Documentation_RadiusServer) RADIUS server
	object (Wi-Fi_API_and_Model_Documentation_RadiusServer) RADIUS server
type	string Enum: "AUTHENTICATION" "ACCOUNTING"

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"primary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
},
"secondary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
},
"type": "AUTHENTICATION"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"id": "string",
"name": "string",
"primary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
},
"secondary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
},
"type": "AUTHENTICATION"
}
}

Delete RADIUS Profile

Delete a specific RADIUS profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

radiusId

required

string

RADIUS server profile ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get RADIUS Profile

Get a specific RADIUS profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

radiusId

required

string

RADIUS server profile ID

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"primary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
},
"secondary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
},
"type": "AUTHENTICATION"
}

Update RADIUS Profile

Update a specific RADIUS profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

radiusId

required

string

RADIUS server profile ID

Request Body schema:
application/json
required

name	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
required	object (Wi-Fi_API_and_Model_Documentation_RadiusServer) RADIUS server
	object (Wi-Fi_API_and_Model_Documentation_RadiusServer) RADIUS server
type	string Enum: "AUTHENTICATION" "ACCOUNTING"

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"primary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
},
"secondary": {"ip": "string",
"port": 1,
"sharedSecret": "string"
},
"type": "AUTHENTICATION"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get RADIUS Server Profile Settings On Wi-Fi Network

Get RADIUS server profile settings on Wi-Fi network.

path Parameters

wifiNetworkId

required

string

Wi-Fi Network ID

Responses

Response samples

Content type

application/json

{"enableAccountingProxy": false,
"enableAuthProxy": false,
"macAuthMacFormat": "Lower"
}

Update RADIUS Server Profile Settings On Wi-Fi Network

Update RADIUS server profile settings on Wi-Fi network.

path Parameters

wifiNetworkId

required

string

Wi-Fi Network ID

Request Body schema:
application/json
required

enableAccountingProxy	boolean Default: false
enableAuthProxy	boolean Default: false
macAuthMacFormat	string Enum: "Lower" "UpperDash" "UpperColon" "Upper" "LowerDash" "LowerColon"

Responses

Request samples

Payload

Content type

application/json

{"enableAccountingProxy": false,
"enableAuthProxy": false,
"macAuthMacFormat": "Lower"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate RADIUS Server Profile On Wi-Fi Network

Use this API command to delete a relationship between RADIUS server profile and Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
radiusId required	string RADIUS server profile identity

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Activate RADIUS Server Profile On Wi-Fi Network

Use this API command to build a relationship between RADIUS server profile and Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
radiusId required	string RADIUS server profile identity

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Syslog Server Profile

Manage Syslog server profiles.

Delete Syslog Server Profiles Deprecated

Delete a list of syslog server profiles.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Syslog Server Profiles Deprecated

Get the syslog server profiles.

Responses

Response samples

Content type

application/json

[{"facility": "KEEP_ORIGINAL",
"flowLevel": "GENERAL_LOGS",
"id": "string",
"name": "string",
"primary": {"port": 514,
"protocol": "TCP",
"server": "string"
},
"priority": "EMERGENCY",
"secondary": {"port": 514,
"protocol": "TCP",
"server": "string"
},
"venues": [{"id": "string",
"name": "string"
}
]
}
]

Create Syslog Server Profile

Create a new syslog server profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Request Body schema:
application/json
required

facility	string Default: "FacilityEnum.KEEP_ORIGINAL" Enum: "KEEP_ORIGINAL" "LOCAL0" "LOCAL1" "LOCAL2" "LOCAL3" "LOCAL4" "LOCAL5" "LOCAL6" "LOCAL7"
flowLevel	string Default: "FlowLevelEnum.CLIENT_FLOW" Enum: "GENERAL_LOGS" "CLIENT_FLOW" "ALL"
name required	string [ 2 .. 32 ] characters (?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
required	object (Wi-Fi_API_and_Model_Documentation_SyslogServer) Syslog server
priority	string Default: "PriorityEnum.INFO" Enum: "EMERGENCY" "ALERT" "CRITICAL" "ERROR" "WARNING" "NOTICE" "INFO" "ALL"
	object (Wi-Fi_API_and_Model_Documentation_SyslogServer) Syslog server
	Array of objects (Wi-Fi_API_and_Model_Documentation_IdAndName)

Responses

Request samples

Payload

Content type

application/json

{"facility": "KEEP_ORIGINAL",
"flowLevel": "GENERAL_LOGS",
"name": "string",
"primary": {"port": 514,
"protocol": "TCP",
"server": "string"
},
"priority": "EMERGENCY",
"secondary": {"port": 514,
"protocol": "TCP",
"server": "string"
},
"venues": [{"id": "string",
"name": "string"
}
]
}

Response samples

Content type

application/json

{"requestId": "string"
}

Delete Syslog Server Profile

Delete a syslog server profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

syslogServerProfileId

required

string

Syslog Server Profile ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Syslog Server Profile

Get syslog server profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

syslogServerProfileId

required

string

Syslog Server Profile ID

Responses

Response samples

Content type

application/json

{"facility": "KEEP_ORIGINAL",
"flowLevel": "GENERAL_LOGS",
"id": "string",
"name": "string",
"primary": {"port": 514,
"protocol": "TCP",
"server": "string"
},
"priority": "EMERGENCY",
"secondary": {"port": 514,
"protocol": "TCP",
"server": "string"
},
"venues": [{"id": "string",
"name": "string"
}
]
}

Update Syslog Server Profile

Update a syslog server profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

syslogServerProfileId

required

string

Syslog Server Profile ID

Request Body schema:
application/json
required

facility	string Default: "FacilityEnum.KEEP_ORIGINAL" Enum: "KEEP_ORIGINAL" "LOCAL0" "LOCAL1" "LOCAL2" "LOCAL3" "LOCAL4" "LOCAL5" "LOCAL6" "LOCAL7"
flowLevel	string Default: "FlowLevelEnum.CLIENT_FLOW" Enum: "GENERAL_LOGS" "CLIENT_FLOW" "ALL"
name required	string [ 2 .. 32 ] characters (?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
required	object (Wi-Fi_API_and_Model_Documentation_SyslogServer) Syslog server
priority	string Default: "PriorityEnum.INFO" Enum: "EMERGENCY" "ALERT" "CRITICAL" "ERROR" "WARNING" "NOTICE" "INFO" "ALL"
	object (Wi-Fi_API_and_Model_Documentation_SyslogServer) Syslog server
	Array of objects (Wi-Fi_API_and_Model_Documentation_IdAndName)

Responses

Request samples

Payload

Content type

application/json

{"facility": "KEEP_ORIGINAL",
"flowLevel": "GENERAL_LOGS",
"name": "string",
"primary": {"port": 514,
"protocol": "TCP",
"server": "string"
},
"priority": "EMERGENCY",
"secondary": {"port": 514,
"protocol": "TCP",
"server": "string"
},
"venues": [{"id": "string",
"name": "string"
}
]
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate Syslog Server Profile On Venue

Use this API command to delete a relationship between syslog server profile and venue.

path Parameters

venueId required	string Venue ID
syslogServerProfileId required	string Syslog server profile identity

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Syslog Server Profile On Venue

Use this API command to build a relationship between syslog server profile and venue.

path Parameters

venueId required	string Venue ID
syslogServerProfileId required	string Syslog server profile identity

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Wi-Fi Network

Manage Wi-Fi network profiles.

Delete Networks Deprecated

Delete a list of networks.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Networks Deprecated

Get the network list.

Responses

Response samples

Content type

application/json

[{"id": "string",
"name": "string",
"tenantId": "string",
"type": "string"
}
]

Create Network Deprecated

Create a new network.

Request Body schema: application/json
required

One of

name required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
type required	string
accountingRadiusId	string
authRadiusId	string
description	string [ 0 .. 255 ] characters
enableAccountingProxy	boolean Default: false
enableAuthProxy	boolean Default: false
required	object (Wi-Fi_API_and_Model_Documentation_AAAWlan) WLAN

Responses

Request samples

Payload

Content type

application/json

Example

Wi-Fi_API_and_Model_Documentation_AAANetwork

{"name": "string",
"type": "string",
"accountingRadiusId": "string",
"authRadiusId": "string",
"description": "string",
"enableAccountingProxy": false,
"enableAuthProxy": false,
"wlan": {"advancedCustomization": {"accessControlEnable": false,
"accessControlProfileId": "string",
"applicationPolicyEnable": false,
"applicationPolicyId": "string",
"applicationVisibilityEnabled": true,
"arpRequestRateLimit": 15,
"broadcastProbeResponseDelay": 15,
"clientInactivityTimeout": 120,
"clientIsolation": false,
"clientIsolationOptions": {"autoVrrp": false,
"packetsType": "UNICAST"
},
"clientLoadBalancingEnable": true,
"devicePolicyId": "string",
"dhcpRequestRateLimit": 15,
"directedThreshold": 5,
"dnsProxy": {"dnsProxyRules": [{"domainName": "string",
"ipList": ["string"
]
}
]
},
"dnsProxyEnabled": false,
"enableAaaVlanOverride": true,
"enableAdditionalRegulatoryDomains": true,
"enableAirtimeDecongestion": false,
"enableAntiSpoofing": false,
"enableApHostNameAdvertisement": false,
"enableArpRequestRateLimit": true,
"enableBandBalancing": true,
"enableDhcpRequestRateLimit": true,
"enableFastRoaming": false,
"enableGtkRekey": true,
"enableJoinRSSIThreshold": false,
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastDownlinkRateLimiting6G": false,
"enableMulticastUplinkRateLimiting": false,
"enableMulticastUplinkRateLimiting6G": false,
"enableNeighborReport": true,
"enableOptimizedConnectivityExperience": false,
"enableSyslog": false,
"enableTransientClientManagement": false,
"forceMobileDeviceDhcp": false,
"hideSsid": false,
"joinExpireTime": 300,
"joinRSSIThreshold": -85,
"joinWaitThreshold": 10,
"joinWaitTime": 30,
"l2AclEnable": false,
"l2AclPolicyId": "string",
"l3AclEnable": false,
"l3AclPolicyId": "string",
"maxClientsOnWlanPerRadio": 100,
"mobilityDomainId": 1,
"multicastDownlinkRateLimiting": 1,
"multicastFilterEnabled": false,
"multicastUplinkRateLimiting": 1,
"proxyARP": false,
"qosMapSetEnabled": false,
"qosMapSetOptions": {"rules": [{"dscpExceptionValues": [0
],
"dscpHigh": 0,
"dscpLow": 0,
"enabled": true,
"priority": 7
}
]
},
"radioCustomization": {"bssMinimumPhyRate": "1",
"managementFrameMinimumPhyRate": "1",
"phyTypeConstraint": "OFDM",
"rfBandUsage": "2.4GHZ"
},
"radiusOptions": {"calledStationIdType": "BSSID",
"nasIdDelimiter": "DASH",
"nasIdType": "USER",
"nasMaxRetry": 2,
"nasReconnectPrimaryMin": 5,
"nasRequestTimeoutSec": 3,
"singleSessionIdAccounting": false,
"userDefinedNasId": "string"
},
"respectiveAccessControl": true,
"rssiAssociationRejectionThreshold": -75,
"totalDownlinkRateLimiting": 0,
"totalUplinkRateLimiting": 0,
"userDownlinkRateLimiting": 0,
"userUplinkRateLimiting": 0,
"vlanPool": {"description": "string",
"name": "string",
"vlanMembers": ["string"
]
},
"wifiCallingEnabled": false,
"wifiCallingIds": ["strin"
]
},
"bypassCNA": false,
"bypassCPUsingMacAddressAuthentication": false,
"enabled": true,
"macAddressAuthenticationConfiguration": {"macAddressAuthentication": false,
"macAuthMacFormat": "Lower"
},
"managementFrameProtection": "Disabled",
"ssid": "string",
"vlanId": 1,
"wlanSecurity": "WPA2Enterprise"
}
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"id": "string",
"name": "string",
"tenantId": "string",
"type": "string"
}
}

Get Default Rules for QoS Map Set Deprecated

Get default rules for QoS map set.

Responses

Response samples

Content type

application/json

{"rules": [{"dscpExceptionValues": [0
],
"dscpHigh": 0,
"dscpLow": 0,
"enabled": true,
"priority": 7
}
]
}

Get External WISPr Providers Deprecated

Get the list of external WISPr providers for a captive portal network. Note: these providers have integrated their service with the RUCKUS cloud.

Responses

Response samples

Content type

application/json

{"providers": [{"customExternalProvider": false,
"name": "string",
"regions": [{"accountingRadius": {"primary": {"ip": "string",
"port": "string"
},
"secondary": {"ip": "string",
"port": "string"
}
},
"authRadius": {"primary": {"ip": "string",
"port": "string"
},
"secondary": {"ip": "string",
"port": "string"
}
},
"captivePortalUrl": "string",
"externalProviderUrl": "string",
"name": "string",
"redirectUrl": "string",
"showAnalyticsData": false
}
]
}
]
}

Delete Network Deprecated

Delete a network.

path Parameters

networkId

required

string

Network ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Network Deprecated

Get the network details.

path Parameters

networkId

required

string

Network ID

query Parameters

deep	boolean Default: false Get deep details of this network.

Responses

Response samples

Content type

application/json

Example

Wi-Fi_API_and_Model_Documentation_AAANetwork

{"id": "string",
"name": "string",
"tenantId": "string",
"type": "Wi-Fi_API_and_Model_Documentation_AAANetwork",
"accountingRadiusId": "string",
"authRadiusId": "string",
"description": "string",
"enableAccountingProxy": false,
"enableAuthProxy": false,
"venues": [{"allApGroupsRadio": "Both",
"allApGroupsRadioTypes": ["2.4-GHz"
],
"allApGroupsVlanId": 1,
"apGroups": [{"apGroupId": "string",
"apGroupName": "string",
"id": "string",
"isDefault": false,
"radio": "Both",
"radioTypes": ["2.4-GHz"
],
"validationError": false,
"validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
"validationErrorReachedMaxConnectedNetworksLimit": false,
"validationErrorSsidAlreadyActivated": false,
"vlanId": 1,
"vlanPoolId": "string",
"vlanPoolName": "string"
}
],
"clientIsolationAllowlistId": "string",
"dual5gEnabled": false,
"id": "string",
"isAllApGroups": true,
"networkId": "string",
"scheduler": {"fri": "string",
"mon": "string",
"sat": "string",
"sun": "string",
"thu": "string",
"tue": "string",
"type": "ALWAYS_ON",
"wed": "string"
},
"tripleBandEnabled": false,
"venueId": "string",
"vlanPoolId": "string"
}
],
"wlan": {"advancedCustomization": {"accessControlEnable": false,
"accessControlProfileId": "string",
"applicationPolicyEnable": false,
"applicationPolicyId": "string",
"applicationVisibilityEnabled": true,
"arpRequestRateLimit": 15,
"broadcastProbeResponseDelay": 15,
"clientInactivityTimeout": 120,
"clientIsolation": false,
"clientIsolationOptions": {"autoVrrp": false,
"packetsType": "UNICAST"
},
"clientLoadBalancingEnable": true,
"devicePolicyId": "string",
"dhcpRequestRateLimit": 15,
"directedThreshold": 5,
"dnsProxy": {"dnsProxyRules": [{"domainName": "string",
"ipList": ["string"
]
}
]
},
"dnsProxyEnabled": false,
"enableAaaVlanOverride": true,
"enableAdditionalRegulatoryDomains": true,
"enableAirtimeDecongestion": false,
"enableAntiSpoofing": false,
"enableApHostNameAdvertisement": false,
"enableArpRequestRateLimit": true,
"enableBandBalancing": true,
"enableDhcpRequestRateLimit": true,
"enableFastRoaming": false,
"enableGtkRekey": true,
"enableJoinRSSIThreshold": false,
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastDownlinkRateLimiting6G": false,
"enableMulticastUplinkRateLimiting": false,
"enableMulticastUplinkRateLimiting6G": false,
"enableNeighborReport": true,
"enableOptimizedConnectivityExperience": false,
"enableSyslog": false,
"enableTransientClientManagement": false,
"forceMobileDeviceDhcp": false,
"hideSsid": false,
"joinExpireTime": 300,
"joinRSSIThreshold": -85,
"joinWaitThreshold": 10,
"joinWaitTime": 30,
"l2AclEnable": false,
"l2AclPolicyId": "string",
"l3AclEnable": false,
"l3AclPolicyId": "string",
"maxClientsOnWlanPerRadio": 100,
"mobilityDomainId": 1,
"multicastDownlinkRateLimiting": 1,
"multicastFilterEnabled": false,
"multicastUplinkRateLimiting": 1,
"proxyARP": false,
"qosMapSetEnabled": false,
"qosMapSetOptions": {"rules": [{"dscpExceptionValues": [0
],
"dscpHigh": 0,
"dscpLow": 0,
"enabled": true,
"priority": 7
}
]
},
"radioCustomization": {"bssMinimumPhyRate": "1",
"managementFrameMinimumPhyRate": "1",
"phyTypeConstraint": "OFDM",
"rfBandUsage": "2.4GHZ"
},
"radiusOptions": {"calledStationIdType": "BSSID",
"nasIdDelimiter": "DASH",
"nasIdType": "USER",
"nasMaxRetry": 2,
"nasReconnectPrimaryMin": 5,
"nasRequestTimeoutSec": 3,
"singleSessionIdAccounting": false,
"userDefinedNasId": "string"
},
"respectiveAccessControl": true,
"rssiAssociationRejectionThreshold": -75,
"totalDownlinkRateLimiting": 0,
"totalUplinkRateLimiting": 0,
"userDownlinkRateLimiting": 0,
"userUplinkRateLimiting": 0,
"vlanPool": {"description": "string",
"id": "string",
"name": "string",
"tenantId": "string",
"vlanMembers": ["string"
]
},
"wifiCallingEnabled": false,
"wifiCallingIds": ["strin"
]
},
"bypassCNA": false,
"bypassCPUsingMacAddressAuthentication": false,
"enabled": true,
"macAddressAuthenticationConfiguration": {"macAddressAuthentication": false,
"macAuthMacFormat": "Lower"
},
"managementFrameProtection": "Disabled",
"ssid": "string",
"vlanId": 1,
"wlanSecurity": "WPA2Enterprise"
}
}

Update Network Deprecated

Update this network, including nested details.

path Parameters

networkId

required

string

Network ID

Request Body schema: application/json
required

One of

name required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
type required	string
accountingRadiusId	string
authRadiusId	string
description	string [ 0 .. 255 ] characters
enableAccountingProxy	boolean Default: false
enableAuthProxy	boolean Default: false
required	object (Wi-Fi_API_and_Model_Documentation_AAAWlan) WLAN

Responses

Request samples

Payload

Content type

application/json

Example

Wi-Fi_API_and_Model_Documentation_AAANetwork

{"name": "string",
"type": "string",
"accountingRadiusId": "string",
"authRadiusId": "string",
"description": "string",
"enableAccountingProxy": false,
"enableAuthProxy": false,
"wlan": {"advancedCustomization": {"accessControlEnable": false,
"accessControlProfileId": "string",
"applicationPolicyEnable": false,
"applicationPolicyId": "string",
"applicationVisibilityEnabled": true,
"arpRequestRateLimit": 15,
"broadcastProbeResponseDelay": 15,
"clientInactivityTimeout": 120,
"clientIsolation": false,
"clientIsolationOptions": {"autoVrrp": false,
"packetsType": "UNICAST"
},
"clientLoadBalancingEnable": true,
"devicePolicyId": "string",
"dhcpRequestRateLimit": 15,
"directedThreshold": 5,
"dnsProxy": {"dnsProxyRules": [{"domainName": "string",
"ipList": ["string"
]
}
]
},
"dnsProxyEnabled": false,
"enableAaaVlanOverride": true,
"enableAdditionalRegulatoryDomains": true,
"enableAirtimeDecongestion": false,
"enableAntiSpoofing": false,
"enableApHostNameAdvertisement": false,
"enableArpRequestRateLimit": true,
"enableBandBalancing": true,
"enableDhcpRequestRateLimit": true,
"enableFastRoaming": false,
"enableGtkRekey": true,
"enableJoinRSSIThreshold": false,
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastDownlinkRateLimiting6G": false,
"enableMulticastUplinkRateLimiting": false,
"enableMulticastUplinkRateLimiting6G": false,
"enableNeighborReport": true,
"enableOptimizedConnectivityExperience": false,
"enableSyslog": false,
"enableTransientClientManagement": false,
"forceMobileDeviceDhcp": false,
"hideSsid": false,
"joinExpireTime": 300,
"joinRSSIThreshold": -85,
"joinWaitThreshold": 10,
"joinWaitTime": 30,
"l2AclEnable": false,
"l2AclPolicyId": "string",
"l3AclEnable": false,
"l3AclPolicyId": "string",
"maxClientsOnWlanPerRadio": 100,
"mobilityDomainId": 1,
"multicastDownlinkRateLimiting": 1,
"multicastFilterEnabled": false,
"multicastUplinkRateLimiting": 1,
"proxyARP": false,
"qosMapSetEnabled": false,
"qosMapSetOptions": {"rules": [{"dscpExceptionValues": [0
],
"dscpHigh": 0,
"dscpLow": 0,
"enabled": true,
"priority": 7
}
]
},
"radioCustomization": {"bssMinimumPhyRate": "1",
"managementFrameMinimumPhyRate": "1",
"phyTypeConstraint": "OFDM",
"rfBandUsage": "2.4GHZ"
},
"radiusOptions": {"calledStationIdType": "BSSID",
"nasIdDelimiter": "DASH",
"nasIdType": "USER",
"nasMaxRetry": 2,
"nasReconnectPrimaryMin": 5,
"nasRequestTimeoutSec": 3,
"singleSessionIdAccounting": false,
"userDefinedNasId": "string"
},
"respectiveAccessControl": true,
"rssiAssociationRejectionThreshold": -75,
"totalDownlinkRateLimiting": 0,
"totalUplinkRateLimiting": 0,
"userDownlinkRateLimiting": 0,
"userUplinkRateLimiting": 0,
"vlanPool": {"description": "string",
"name": "string",
"vlanMembers": ["string"
]
},
"wifiCallingEnabled": false,
"wifiCallingIds": ["strin"
]
},
"bypassCNA": false,
"bypassCPUsingMacAddressAuthentication": false,
"enabled": true,
"macAddressAuthenticationConfiguration": {"macAddressAuthentication": false,
"macAuthMacFormat": "Lower"
},
"managementFrameProtection": "Disabled",
"ssid": "string",
"vlanId": 1,
"wlanSecurity": "WPA2Enterprise"
}
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate Wi-Fi Network On Venue

Use this API to delete a relationship between Wi-Fi network and venue.

path Parameters

venueId required	string Venue ID
wifiNetworkId required	string Wi-Fi Network ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Wi-Fi Network On Venue

Use this API to build a relationship between Wi-Fi network and venue.

path Parameters

venueId required	string Venue ID
wifiNetworkId required	string Wi-Fi Network ID

Request Body schema:
application/json

isAllApGroups

boolean

Default: true

Responses

Request samples

Payload

Content type

application/json

{"isAllApGroups": true
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Wi-Fi Network Settings

Get Wi-Fi network settings on this venue.

path Parameters

venueId required	string Venue ID
wifiNetworkId required	string Wi-Fi Network ID

Responses

Response samples

Content type

application/json

{"allApGroupsRadioTypes": ["2.4-GHz"
],
"allApGroupsVlanId": 1,
"isAllApGroups": true,
"scheduler": {"fri": "string",
"mon": "string",
"sat": "string",
"sun": "string",
"thu": "string",
"tue": "string",
"type": "ALWAYS_ON",
"wed": "string"
}
}

Update Venue Wi-Fi Network Settings

Update Wi-Fi network settings on this venue.

path Parameters

venueId required	string Venue ID
wifiNetworkId required	string Wi-Fi Network ID

Request Body schema:
application/json
required

allApGroupsRadioTypes	Array of strings Items Enum: "2.4-GHz" "5-GHz" "6-GHz"
allApGroupsVlanId	integer <int32> [ 1 .. 4094 ]
isAllApGroups	boolean Default: true
	object (Wi-Fi_API_and_Model_Documentation_NetworkVenueScheduler) Network-Venue scheduler

Responses

Request samples

Payload

Content type

application/json

{"allApGroupsRadioTypes": ["2.4-GHz"
],
"allApGroupsVlanId": 1,
"isAllApGroups": true,
"scheduler": {"fri": "string",
"mon": "string",
"sat": "string",
"sun": "string",
"thu": "string",
"tue": "string",
"type": "ALWAYS_ON",
"wed": "string"
}
}

Response samples

Content type

application/json

{"requestId": "string"
}

Create Wi-Fi Network

Create a new Wi-Fi network.

Request Body schema:
application/json
required

One of

name required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
type required	string
description	string [ 0 .. 255 ] characters
required	object (Wi-Fi_API_and_Model_Documentation_AAAWifiWlan) AAA Wi-Fi WLAN

Responses

Request samples

Payload

Content type

application/json

Example

Wi-Fi_API_and_Model_Documentation_AAAWifiNetwork

{"name": "string",
"type": "string",
"description": "string",
"wlan": {"advancedCustomization": {"applicationVisibilityEnabled": true,
"arpRequestRateLimit": 15,
"broadcastProbeResponseDelay": 15,
"clientInactivityTimeout": 120,
"clientIsolation": false,
"clientIsolationOptions": {"autoVrrp": false,
"packetsType": "UNICAST"
},
"clientLoadBalancingEnable": true,
"dhcpRequestRateLimit": 15,
"directedThreshold": 5,
"dnsProxy": {"dnsProxyRules": [{"domainName": "string",
"ipList": ["string"
]
}
]
},
"dnsProxyEnabled": false,
"enableAaaVlanOverride": true,
"enableAdditionalRegulatoryDomains": true,
"enableAirtimeDecongestion": false,
"enableAntiSpoofing": false,
"enableApHostNameAdvertisement": false,
"enableArpRequestRateLimit": true,
"enableBandBalancing": true,
"enableDhcpRequestRateLimit": true,
"enableFastRoaming": false,
"enableGtkRekey": true,
"enableJoinRSSIThreshold": false,
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastDownlinkRateLimiting6G": false,
"enableMulticastUplinkRateLimiting": false,
"enableMulticastUplinkRateLimiting6G": false,
"enableNeighborReport": true,
"enableOptimizedConnectivityExperience": false,
"enableSyslog": false,
"enableTransientClientManagement": false,
"forceMobileDeviceDhcp": false,
"hideSsid": false,
"joinExpireTime": 300,
"joinRSSIThreshold": -85,
"joinWaitThreshold": 10,
"joinWaitTime": 30,
"maxClientsOnWlanPerRadio": 100,
"mobilityDomainId": 1,
"multicastDownlinkRateLimiting": 1,
"multicastFilterEnabled": false,
"multicastUplinkRateLimiting": 1,
"proxyARP": false,
"qosMapSetEnabled": false,
"qosMapSetOptions": {"rules": [{"dscpExceptionValues": [0
],
"dscpHigh": 0,
"dscpLow": 0,
"enabled": true,
"priority": 7
}
]
},
"radioCustomization": {"bssMinimumPhyRate": "1",
"managementFrameMinimumPhyRate": "1",
"phyTypeConstraint": "OFDM",
"rfBandUsage": "2.4GHZ"
},
"radiusOptions": {"calledStationIdType": "BSSID",
"nasIdDelimiter": "DASH",
"nasIdType": "USER",
"nasMaxRetry": 2,
"nasReconnectPrimaryMin": 5,
"nasRequestTimeoutSec": 3,
"singleSessionIdAccounting": false,
"userDefinedNasId": "string"
},
"respectiveAccessControl": true,
"rssiAssociationRejectionThreshold": -75,
"totalDownlinkRateLimiting": 0,
"totalUplinkRateLimiting": 0,
"userDownlinkRateLimiting": 0,
"userUplinkRateLimiting": 0
},
"bypassCNA": false,
"bypassCPUsingMacAddressAuthentication": false,
"enabled": true,
"managementFrameProtection": "Disabled",
"ssid": "string",
"vlanId": 1,
"wlanSecurity": "WPA2Enterprise"
}
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"id": "string"
}
}

Get Predefined Hotspot 2.0 Identity Providers

Get predefined Hotspot 2.0 identity providers.

Responses

Response samples

Content type

application/json

[{"id": "string",
"name": "string"
}
]

Get Predefined Hotspot 2.0 Operators

Get predefined Hotspot 2.0 operators.

Responses

Response samples

Content type

application/json

[{"id": "string",
"name": "string"
}
]

Get Default Options for QoS Map Set

Get default options for QoS map set.

Responses

Response samples

Content type

application/json

{"rules": [{"dscpExceptionValues": [0
],
"dscpHigh": 0,
"dscpLow": 0,
"enabled": true,
"priority": 7
}
]
}

Get Wi-Fi Recovery Network Passphrase Settings

Get the passphrase settings for the Wi-Fi recovery network.

Responses

Response samples

Content type

application/json

{"passphrase": "string"
}

Update Wi-Fi Recovery Network Passphrase Settings

Update the passphrase settings for the Wi-Fi recovery network.

Request Body schema:
application/json
required

passphrase

string^([0-9]{4}){4}$

Responses

Request samples

Payload

Content type

application/json

{"passphrase": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get External WISPr Providers

Get the list of external WISPr providers for a captive portal network. Note: these providers have integrated their service with the RUCKUS cloud.

Responses

Response samples

Content type

application/json

{"wisprProviders": [{"customExternalProvider": false,
"name": "string",
"regions": [{"accountingRadius": {"primary": {"ip": "string",
"port": "string"
},
"secondary": {"ip": "string",
"port": "string"
}
},
"authRadius": {"primary": {"ip": "string",
"port": "string"
},
"secondary": {"ip": "string",
"port": "string"
}
},
"captivePortalUrl": "string",
"externalProviderUrl": "string",
"name": "string",
"redirectUrl": "string",
"showAnalyticsData": false
}
]
}
]
}

Delete Wi-Fi Network

Delete a Wi-Fi network.

path Parameters

wifiNetworkId

required

string

Wi-Fi Network ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Wi-Fi Network

Get the Wi-Fi network details.

path Parameters

wifiNetworkId

required

string

Wi-Fi Network ID

Responses

Response samples

Content type

application/json

Example

Wi-Fi_API_and_Model_Documentation_AAAWifiNetwork

{"id": "string",
"name": "string",
"type": "Wi-Fi_API_and_Model_Documentation_AAAWifiNetwork",
"description": "string",
"wlan": {"advancedCustomization": {"applicationVisibilityEnabled": true,
"arpRequestRateLimit": 15,
"broadcastProbeResponseDelay": 15,
"clientInactivityTimeout": 120,
"clientIsolation": false,
"clientIsolationOptions": {"autoVrrp": false,
"packetsType": "UNICAST"
},
"clientLoadBalancingEnable": true,
"dhcpRequestRateLimit": 15,
"directedThreshold": 5,
"dnsProxy": {"dnsProxyRules": [{"domainName": "string",
"ipList": ["string"
]
}
]
},
"dnsProxyEnabled": false,
"enableAaaVlanOverride": true,
"enableAdditionalRegulatoryDomains": true,
"enableAirtimeDecongestion": false,
"enableAntiSpoofing": false,
"enableApHostNameAdvertisement": false,
"enableArpRequestRateLimit": true,
"enableBandBalancing": true,
"enableDhcpRequestRateLimit": true,
"enableFastRoaming": false,
"enableGtkRekey": true,
"enableJoinRSSIThreshold": false,
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastDownlinkRateLimiting6G": false,
"enableMulticastUplinkRateLimiting": false,
"enableMulticastUplinkRateLimiting6G": false,
"enableNeighborReport": true,
"enableOptimizedConnectivityExperience": false,
"enableSyslog": false,
"enableTransientClientManagement": false,
"forceMobileDeviceDhcp": false,
"hideSsid": false,
"joinExpireTime": 300,
"joinRSSIThreshold": -85,
"joinWaitThreshold": 10,
"joinWaitTime": 30,
"maxClientsOnWlanPerRadio": 100,
"mobilityDomainId": 1,
"multicastDownlinkRateLimiting": 1,
"multicastFilterEnabled": false,
"multicastUplinkRateLimiting": 1,
"proxyARP": false,
"qosMapSetEnabled": false,
"qosMapSetOptions": {"rules": [{"dscpExceptionValues": [0
],
"dscpHigh": 0,
"dscpLow": 0,
"enabled": true,
"priority": 7
}
]
},
"radioCustomization": {"bssMinimumPhyRate": "1",
"managementFrameMinimumPhyRate": "1",
"phyTypeConstraint": "OFDM",
"rfBandUsage": "2.4GHZ"
},
"radiusOptions": {"calledStationIdType": "BSSID",
"nasIdDelimiter": "DASH",
"nasIdType": "USER",
"nasMaxRetry": 2,
"nasReconnectPrimaryMin": 5,
"nasRequestTimeoutSec": 3,
"singleSessionIdAccounting": false,
"userDefinedNasId": "string"
},
"respectiveAccessControl": true,
"rssiAssociationRejectionThreshold": -75,
"totalDownlinkRateLimiting": 0,
"totalUplinkRateLimiting": 0,
"userDownlinkRateLimiting": 0,
"userUplinkRateLimiting": 0
},
"bypassCNA": false,
"bypassCPUsingMacAddressAuthentication": false,
"enabled": true,
"managementFrameProtection": "Disabled",
"ssid": "string",
"vlanId": 1,
"wlanSecurity": "WPA2Enterprise"
}
}

Update Wi-Fi Network

Update this Wi-Fi network, including nested details.

path Parameters

wifiNetworkId

required

string

Wi-Fi Network ID

Request Body schema:
application/json
required

One of

name required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
type required	string
description	string [ 0 .. 255 ] characters
required	object (Wi-Fi_API_and_Model_Documentation_AAAWifiWlan) AAA Wi-Fi WLAN

Responses

Request samples

Payload

Content type

application/json

Example

Wi-Fi_API_and_Model_Documentation_AAAWifiNetwork

{"name": "string",
"type": "string",
"description": "string",
"wlan": {"advancedCustomization": {"applicationVisibilityEnabled": true,
"arpRequestRateLimit": 15,
"broadcastProbeResponseDelay": 15,
"clientInactivityTimeout": 120,
"clientIsolation": false,
"clientIsolationOptions": {"autoVrrp": false,
"packetsType": "UNICAST"
},
"clientLoadBalancingEnable": true,
"dhcpRequestRateLimit": 15,
"directedThreshold": 5,
"dnsProxy": {"dnsProxyRules": [{"domainName": "string",
"ipList": ["string"
]
}
]
},
"dnsProxyEnabled": false,
"enableAaaVlanOverride": true,
"enableAdditionalRegulatoryDomains": true,
"enableAirtimeDecongestion": false,
"enableAntiSpoofing": false,
"enableApHostNameAdvertisement": false,
"enableArpRequestRateLimit": true,
"enableBandBalancing": true,
"enableDhcpRequestRateLimit": true,
"enableFastRoaming": false,
"enableGtkRekey": true,
"enableJoinRSSIThreshold": false,
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastDownlinkRateLimiting6G": false,
"enableMulticastUplinkRateLimiting": false,
"enableMulticastUplinkRateLimiting6G": false,
"enableNeighborReport": true,
"enableOptimizedConnectivityExperience": false,
"enableSyslog": false,
"enableTransientClientManagement": false,
"forceMobileDeviceDhcp": false,
"hideSsid": false,
"joinExpireTime": 300,
"joinRSSIThreshold": -85,
"joinWaitThreshold": 10,
"joinWaitTime": 30,
"maxClientsOnWlanPerRadio": 100,
"mobilityDomainId": 1,
"multicastDownlinkRateLimiting": 1,
"multicastFilterEnabled": false,
"multicastUplinkRateLimiting": 1,
"proxyARP": false,
"qosMapSetEnabled": false,
"qosMapSetOptions": {"rules": [{"dscpExceptionValues": [0
],
"dscpHigh": 0,
"dscpLow": 0,
"enabled": true,
"priority": 7
}
]
},
"radioCustomization": {"bssMinimumPhyRate": "1",
"managementFrameMinimumPhyRate": "1",
"phyTypeConstraint": "OFDM",
"rfBandUsage": "2.4GHZ"
},
"radiusOptions": {"calledStationIdType": "BSSID",
"nasIdDelimiter": "DASH",
"nasIdType": "USER",
"nasMaxRetry": 2,
"nasReconnectPrimaryMin": 5,
"nasRequestTimeoutSec": 3,
"singleSessionIdAccounting": false,
"userDefinedNasId": "string"
},
"respectiveAccessControl": true,
"rssiAssociationRejectionThreshold": -75,
"totalDownlinkRateLimiting": 0,
"totalUplinkRateLimiting": 0,
"userDownlinkRateLimiting": 0,
"userUplinkRateLimiting": 0
},
"bypassCNA": false,
"bypassCPUsingMacAddressAuthentication": false,
"enabled": true,
"managementFrameProtection": "Disabled",
"ssid": "string",
"vlanId": 1,
"wlanSecurity": "WPA2Enterprise"
}
}

Response samples

Content type

application/json

{"requestId": "string"
}

Validate X509 Certificates Deprecated

Validate the x509 certificate chain issued by a trusted certificate authority.

Request Body schema: application/json
required

info	string
	Array of objects (Wi-Fi_API_and_Model_Documentation_X509Certificate)
required	object (Wi-Fi_API_and_Model_Documentation_X509Certificate) X509 certificate

Responses

Request samples

Payload

Content type

application/json

{"info": "string",
"interCerts": [{"certData": "string",
"fileName": "string",
"isRootCert": false
}
],
"rootCert": {"certData": "string",
"fileName": "string",
"isRootCert": false
}
}

Response samples

Content type

application/json

{"requestId": "string"
}

Application Policy

Manage application policy profiles.

Deactivate Application Policy On Access Control Profile

Use this API command to deactivate an application policy on an access control profile.

path Parameters

accessControlProfileId required	string
applicationPolicyId required	string

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/applicationPolicies/{applicationPolicyId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/applicationPolicies/{applicationPolicyId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/applicationPolicies/{applicationPolicyId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Application Policy On Access Control Profile

Use this API command to activate an application policy on an access control profile.

path Parameters

accessControlProfileId required	string
applicationPolicyId required	string

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/applicationPolicies/{applicationPolicyId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/applicationPolicies/{applicationPolicyId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/applicationPolicies/{applicationPolicyId}

Response samples

Content type

application/json

{"requestId": "string"
}

Delete Application Policies Deprecated

Use this API command to delete an application policy list.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Application Policies Deprecated

Use this API command to get the application policy list.

Responses

Response samples

Content type

application/json

[{"description": "string",
"id": "string",
"name": "string",
"rules": [{"accessControl": "DENY",
"applicationId": 0,
"applicationName": "string",
"category": "string",
"categoryId": 0,
"destinationIp": "string",
"destinationPort": 1,
"downLinkMarkingType": "VOICE",
"downlink": 250,
"id": "string",
"markingPriority": "IEEE802_1P",
"name": "string",
"netmask": "string",
"portMapping": "IP_WITH_PORT",
"priority": 0,
"protocol": "TCP",
"ruleType": "SIGNATURE",
"upLinkMarkingType": "VOICE",
"uplink": 250
}
],
"tenantId": "string"
}
]

Add Application Policy

Use this API command to create a new application policy. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Request Body schema:
application/json
required

description	string [ 0 .. 64 ] characters
name required	string [ 2 .. 32 ] characters
	Array of objects (Wi-Fi_API_and_Model_Documentation_ApplicationPolicyRule) [ 1 .. 128 ] items

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"rules": [{"accessControl": "DENY",
"applicationId": 0,
"applicationName": "string",
"category": "string",
"categoryId": 0,
"destinationIp": "string",
"destinationPort": 1,
"downLinkMarkingType": "VOICE",
"downlink": 250,
"markingPriority": "IEEE802_1P",
"name": "string",
"netmask": "string",
"portMapping": "IP_WITH_PORT",
"priority": 0,
"protocol": "TCP",
"ruleType": "SIGNATURE",
"upLinkMarkingType": "VOICE",
"uplink": 250
}
]
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"description": "string",
"id": "string",
"name": "string",
"rules": [{"accessControl": "DENY",
"applicationId": 0,
"applicationName": "string",
"category": "string",
"categoryId": 0,
"destinationIp": "string",
"destinationPort": 1,
"downLinkMarkingType": "VOICE",
"downlink": 250,
"id": "string",
"markingPriority": "IEEE802_1P",
"name": "string",
"netmask": "string",
"portMapping": "IP_WITH_PORT",
"priority": 0,
"protocol": "TCP",
"ruleType": "SIGNATURE",
"upLinkMarkingType": "VOICE",
"uplink": 250
}
],
"tenantId": "string"
}
}

Delete Application Policy

Use this API command to delete application policy.

path Parameters

applicationPolicyId

required

string

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Application Policy

Use this API command to get the application policy details. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

applicationPolicyId

required

string

Responses

Response samples

Content type

application/json

{"description": "string",
"id": "string",
"name": "string",
"rules": [{"accessControl": "DENY",
"applicationId": 0,
"applicationName": "string",
"category": "string",
"categoryId": 0,
"destinationIp": "string",
"destinationPort": 1,
"downLinkMarkingType": "VOICE",
"downlink": 250,
"id": "string",
"markingPriority": "IEEE802_1P",
"name": "string",
"netmask": "string",
"portMapping": "IP_WITH_PORT",
"priority": 0,
"protocol": "TCP",
"ruleType": "SIGNATURE",
"upLinkMarkingType": "VOICE",
"uplink": 250
}
],
"tenantId": "string"
}

Update Application Policy

Use this API command to update application policy. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

applicationPolicyId

required

string

Request Body schema:
application/json
required

description	string [ 0 .. 64 ] characters
name required	string [ 2 .. 32 ] characters
	Array of objects (Wi-Fi_API_and_Model_Documentation_ApplicationPolicyRule) [ 1 .. 128 ] items

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"rules": [{"accessControl": "DENY",
"applicationId": 0,
"applicationName": "string",
"category": "string",
"categoryId": 0,
"destinationIp": "string",
"destinationPort": 1,
"downLinkMarkingType": "VOICE",
"downlink": 250,
"markingPriority": "IEEE802_1P",
"name": "string",
"netmask": "string",
"portMapping": "IP_WITH_PORT",
"priority": 0,
"protocol": "TCP",
"ruleType": "SIGNATURE",
"upLinkMarkingType": "VOICE",
"uplink": 250
}
]
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate Application Policy On Wifi Network

Use this API command to deactivate an application policy on a Wi-Fi network.

path Parameters

wifiNetworkId required	string
applicationPolicyId required	string

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/wifiNetworks/{wifiNetworkId}/applicationPolicies/{applicationPolicyId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/wifiNetworks/{wifiNetworkId}/applicationPolicies/{applicationPolicyId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/wifiNetworks/{wifiNetworkId}/applicationPolicies/{applicationPolicyId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Application Policy On Wifi Network

Use this API command to activate an application policy on a Wi-Fi network.

path Parameters

wifiNetworkId required	string
applicationPolicyId required	string

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/wifiNetworks/{wifiNetworkId}/applicationPolicies/{applicationPolicyId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/wifiNetworks/{wifiNetworkId}/applicationPolicies/{applicationPolicyId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/wifiNetworks/{wifiNetworkId}/applicationPolicies/{applicationPolicyId}

Response samples

Content type

application/json

{"requestId": "string"
}

AP Group

Manage AP-Groups.

Delete AP-Groups Deprecated

Delete a list of AP-groups.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP-Groups Deprecated

Get the AP-group list.

Responses

Response samples

Content type

application/json

[{"aps": [{"apGroupId": "string",
"bonjourGateway": {"rules": [{"enabled": false,
"fromVlan": 1,
"mdnsName": "string",
"mdnsProtocol": "TCP",
"service": "AIRDISK",
"toVlan": 1
}
]
},
"bssColoring": {"bssColoringEnabled": false,
"useVenueSettings": true
},
"clientAdmissionControl": {"enable24G": false,
"enable50G": false,
"maxRadioLoad24G": 75,
"maxRadioLoad50G": 75,
"minClientCount24G": 10,
"minClientCount50G": 20,
"minClientThroughput24G": 0,
"minClientThroughput50G": 0,
"useVenueSettings": true
},
"clientCount": 0,
"description": "string",
"deviceGps": {"latitude": "string",
"longitude": "string"
},
"externalIp": "null",
"firmware": "null",
"indoorModel": false,
"ip": "null",
"lanPorts": {"lanPorts": [{"enabled": true,
"portId": "string",
"type": "ACCESS",
"untagId": 1,
"vlanMembers": "string"
}
],
"poeOut": false,
"useVenueSettings": false
},
"lastContacted": "null",
"lastUpdated": "null",
"mac": "null",
"meshRole": "null",
"model": "null",
"name": "string",
"poePortStatus": "null",
"position": {"floorplanId": "string",
"xPercent": 0,
"yPercent": 0
},
"radio": {"apRadioParams24G": {"allowedChannels": ["1"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams50G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams6G": {"allowedChannels": ["1"
],
"bssMinRate6G": "HE_MCS_0",
"changeInterval": 33,
"channelBandwidth": "AUTO",
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastUplinkRateLimiting": false,
"manualChannel": 0,
"method": "MANUAL",
"mgmtTxRate6G": "6",
"multicastDownlinkRateLimiting": 1,
"multicastUplinkRateLimiting": 1,
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "MAX",
"useVenueSettings": false
},
"apRadioParamsDual5G": {"enabled": true,
"lower5gEnabled": false,
"radioParamsLower5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"radioParamsUpper5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"upper5gEnabled": false,
"useVenueEnabled": false
},
"enable24G": false,
"enable50G": false,
"enable6G": false,
"useVenueSettings": true
},
"serialNumber": "string",
"softDeleted": false,
"softDeletedDate": "2019-08-24T14:15:22Z",
"state": "InSetupPhase",
"subState": "NeverContactedCloud",
"tags": ["string"
],
"uptime_seconds": 0,
"venueId": "string"
}
],
"description": "string",
"id": "string",
"isDefault": false,
"name": "string",
"venueId": "string"
}
]

Delete AP-Group Deprecated

Delete an AP-group.

path Parameters

apGroupId

required

string

AP-group ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP-Group Deprecated

Get the AP-group details.

path Parameters

apGroupId

required

string

AP-group ID

Responses

Response samples

Content type

application/json

{"aps": [{"apGroupId": "string",
"bonjourGateway": {"rules": [{"enabled": false,
"fromVlan": 1,
"mdnsName": "string",
"mdnsProtocol": "TCP",
"service": "AIRDISK",
"toVlan": 1
}
]
},
"bssColoring": {"bssColoringEnabled": false,
"useVenueSettings": true
},
"clientAdmissionControl": {"enable24G": false,
"enable50G": false,
"maxRadioLoad24G": 75,
"maxRadioLoad50G": 75,
"minClientCount24G": 10,
"minClientCount50G": 20,
"minClientThroughput24G": 0,
"minClientThroughput50G": 0,
"useVenueSettings": true
},
"clientCount": 0,
"description": "string",
"deviceGps": {"latitude": "string",
"longitude": "string"
},
"externalIp": "null",
"firmware": "null",
"indoorModel": false,
"ip": "null",
"lanPorts": {"lanPorts": [{"enabled": true,
"portId": "string",
"type": "ACCESS",
"untagId": 1,
"vlanMembers": "string"
}
],
"poeOut": false,
"useVenueSettings": false
},
"lastContacted": "null",
"lastUpdated": "null",
"mac": "null",
"meshRole": "null",
"model": "null",
"name": "string",
"poePortStatus": "null",
"position": {"floorplanId": "string",
"xPercent": 0,
"yPercent": 0
},
"radio": {"apRadioParams24G": {"allowedChannels": ["1"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams50G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams6G": {"allowedChannels": ["1"
],
"bssMinRate6G": "HE_MCS_0",
"changeInterval": 33,
"channelBandwidth": "AUTO",
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastUplinkRateLimiting": false,
"manualChannel": 0,
"method": "MANUAL",
"mgmtTxRate6G": "6",
"multicastDownlinkRateLimiting": 1,
"multicastUplinkRateLimiting": 1,
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "MAX",
"useVenueSettings": false
},
"apRadioParamsDual5G": {"enabled": true,
"lower5gEnabled": false,
"radioParamsLower5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"radioParamsUpper5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"upper5gEnabled": false,
"useVenueEnabled": false
},
"enable24G": false,
"enable50G": false,
"enable6G": false,
"useVenueSettings": true
},
"serialNumber": "string",
"softDeleted": false,
"softDeletedDate": "2019-08-24T14:15:22Z",
"state": "InSetupPhase",
"subState": "NeverContactedCloud",
"tags": ["string"
],
"uptime_seconds": 0,
"venueId": "string"
}
],
"description": "string",
"id": "string",
"isDefault": false,
"name": "string",
"venueId": "string"
}

Update AP-Group Deprecated

Update an AP-group.
Note: AP-Groups cannot be moved between venues, but a single AP can be moved between venues using the update AP endpoint.

path Parameters

apGroupId

required

string

AP-group ID

Request Body schema: application/json
required

	Array of objects (Wi-Fi_API_and_Model_Documentation_ApSerialNumber)
description	string [ 2 .. 180 ] characters
name required	string(?=^((?!(`\|\$\()).){2,64}$)^(\S.*\S)$
venueId	string Deprecated

Responses

Request samples

Payload

Content type

application/json

{"apSerialNumbers": [{"serialNumber": "string",
"softDeleted": false,
"softDeletedDate": "2019-08-24T14:15:22Z"
}
],
"description": "string",
"name": "string",
"venueId": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP-Groups by Venue Deprecated

Get the AP-group list by venue.

path Parameters

venueId

required

string

Venue ID

query Parameters

defaultOnly

boolean

Default: false

Only get the details of default AP Group in this venue.

Responses

Response samples

Content type

application/json

[{"aps": [{"apGroupId": "string",
"bonjourGateway": {"rules": [{"enabled": false,
"fromVlan": 1,
"mdnsName": "string",
"mdnsProtocol": "TCP",
"service": "AIRDISK",
"toVlan": 1
}
]
},
"bssColoring": {"bssColoringEnabled": false,
"useVenueSettings": true
},
"clientAdmissionControl": {"enable24G": false,
"enable50G": false,
"maxRadioLoad24G": 75,
"maxRadioLoad50G": 75,
"minClientCount24G": 10,
"minClientCount50G": 20,
"minClientThroughput24G": 0,
"minClientThroughput50G": 0,
"useVenueSettings": true
},
"clientCount": 0,
"description": "string",
"deviceGps": {"latitude": "string",
"longitude": "string"
},
"externalIp": "null",
"firmware": "null",
"indoorModel": false,
"ip": "null",
"lanPorts": {"lanPorts": [{"enabled": true,
"portId": "string",
"type": "ACCESS",
"untagId": 1,
"vlanMembers": "string"
}
],
"poeOut": false,
"useVenueSettings": false
},
"lastContacted": "null",
"lastUpdated": "null",
"mac": "null",
"meshRole": "null",
"model": "null",
"name": "string",
"poePortStatus": "null",
"position": {"floorplanId": "string",
"xPercent": 0,
"yPercent": 0
},
"radio": {"apRadioParams24G": {"allowedChannels": ["1"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams50G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"apRadioParams6G": {"allowedChannels": ["1"
],
"bssMinRate6G": "HE_MCS_0",
"changeInterval": 33,
"channelBandwidth": "AUTO",
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastUplinkRateLimiting": false,
"manualChannel": 0,
"method": "MANUAL",
"mgmtTxRate6G": "6",
"multicastDownlinkRateLimiting": 1,
"multicastUplinkRateLimiting": 1,
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "MAX",
"useVenueSettings": false
},
"apRadioParamsDual5G": {"enabled": true,
"lower5gEnabled": false,
"radioParamsLower5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"radioParamsUpper5G": {"allowedChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"manualChannel": 0,
"method": "MANUAL",
"operativeChannel": 0,
"operativeTxPower": "string",
"snr_dB": 0,
"txPower": "Auto",
"useVenueSettings": false
},
"upper5gEnabled": false,
"useVenueEnabled": false
},
"enable24G": false,
"enable50G": false,
"enable6G": false,
"useVenueSettings": true
},
"serialNumber": "string",
"softDeleted": false,
"softDeletedDate": "2019-08-24T14:15:22Z",
"state": "InSetupPhase",
"subState": "NeverContactedCloud",
"tags": ["string"
],
"uptime_seconds": 0,
"venueId": "string"
}
],
"description": "string",
"id": "string",
"isDefault": false,
"name": "string",
"venueId": "string"
}
]

Create AP-Group

Create a new AP-group. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

	Array of objects (Wi-Fi_API_and_Model_Documentation_ApSerialNumber)
description	string [ 2 .. 180 ] characters
name required	string(?=^((?!(`\|\$\()).){2,64}$)^(\S.*\S)$
venueId	string Deprecated

Responses

Request samples

Payload

Content type

application/json

{"apSerialNumbers": [{"serialNumber": "string",
"softDeleted": false,
"softDeletedDate": "2019-08-24T14:15:22Z"
}
],
"description": "string",
"name": "string",
"venueId": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Delete AP Group

Delete an AP group.

path Parameters

venueId required	string Venue ID
apGroupId required	string AP Group ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Group

Get the AP group details.

path Parameters

venueId required	string Venue ID
apGroupId required	string AP Group ID

Responses

Response samples

Content type

application/json

{"apSerialNumbers": ["string"
],
"description": "string",
"id": "string",
"isDefault": false,
"name": "string"
}

Update AP Group

Update an AP group.

path Parameters

venueId required	string Venue ID
apGroupId required	string AP Group ID

Request Body schema:
application/json
required

apSerialNumbers	Array of strings List of AP serial-numbers which are associated to the AP group.
description	string [ 2 .. 180 ] characters
name	string(?=^((?!(`\|\$\()).){2,64}$)^(\S.*\S)$ The name of the AP group. Is required during creation and modification but not for the default AP group.

Responses

Request samples

Payload

Content type

application/json

{"apSerialNumbers": ["string"
],
"description": "string",
"name": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate AP Group On Wi-Fi Network

Deactivate the AP group and remove the settings on the Wi-Fi network with the venue.

path Parameters

venueId required	string Venue ID
wifiNetworkId required	string Wi-Fi Network ID
apGroupId required	string AP Group ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate AP Group On Wi-Fi Network

Activate the AP group on the Wi-Fi network with the venue.

path Parameters

venueId required	string Venue ID
wifiNetworkId required	string Wi-Fi Network ID
apGroupId required	string AP Group ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP Group Settings On Wi-Fi Network

Get the activated AP group settings on the Wi-Fi network with the venue.

path Parameters

venueId required	string Venue ID
wifiNetworkId required	string Wi-Fi Network ID
apGroupId required	string AP Group ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}/settings

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}/settings

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}/settings

Response samples

Content type

application/json

{"radioTypes": ["2.4-GHz"
],
"vlanId": 1
}

Update AP Group Settings On Wi-Fi Network

Update the activated AP group settings on the Wi-Fi network with the venue.

path Parameters

venueId required	string Venue ID
wifiNetworkId required	string Wi-Fi Network ID
apGroupId required	string AP Group ID

Request Body schema:
application/json
required

radioTypes	Array of strings Items Enum: "2.4-GHz" "5-GHz" "6-GHz"
vlanId	integer <int32> [ 1 .. 4094 ]

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}/settings

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}/settings

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/apGroups/{apGroupId}/settings

Request samples

Payload

Content type

application/json

{"radioTypes": ["2.4-GHz"
],
"vlanId": 1
}

Response samples

Content type

application/json

{"requestId": "string"
}

Client

Manage client connections.

Clients Control Deprecated

Control a list of clients.

Request Body schema: application/json
required

action required	string Value: "disconnect"
	Array of objects (Wi-Fi_API_and_Model_Documentation_DisconnectClientBySerialNumber)

Responses

Request samples

Payload

Content type

application/json

{"action": "disconnect",
"clients": [{"clientMac": "string",
"serialNumber": "string"
}
]
}

Response samples

Content type

application/json

{"requestId": "string"
}

Patch AP Client

Patch the AP's client.

path Parameters

venueId required	string The ID of the venue.
serialNumber required	string The serial number of the AP.
clientMacAddress required	string The mac address of the client.

Request Body schema:
application/json
required

status

required

string

Value: "DISCONNECTED"

Responses

Request samples

Payload

Content type

application/json

{"status": "DISCONNECTED"
}

Response samples

Content type

application/json

{"requestId": "string"
}

DHCP Configuration Service Profile

Manage DHCP configuration service profiles.

Delete DHCP Configuration Service Profiles Deprecated

Delete a list of DHCP configuration service profiles. Use DELETE:/venues/{venueId}/dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId} instead.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get DHCP Configuration Service Profiles Deprecated

Get the DHCP configuration service profiles.

Responses

Response samples

Content type

application/json

[{"dhcpMode": "EnableOnEachAPs",
"dhcpPools": [{"description": "string",
"endIpAddress": "string",
"id": "string",
"leaseTimeHours": 24,
"leaseTimeMinutes": 59,
"name": "string",
"primaryDnsIp": "string",
"secondaryDnsIp": "string",
"startIpAddress": "string",
"subnetAddress": "string",
"subnetMask": "string",
"vlanId": 1
}
],
"id": "string",
"serviceName": "string",
"usage": [{"totalIpCount": 0,
"usedIpCount": 0,
"venueId": "string"
}
],
"venueIds": ["string"
]
}
]

Create DHCP Configuration Service Profile

Create a new DHCP configuration service profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Request Body schema:
application/json
required

dhcpMode	string Default: "DhcpModeEnum.EnableOnEachAPs" Enum: "EnableOnEachAPs" "EnableOnMultipleAPs" "EnableOnHierarchicalAPs"
required	Array of objects (Wi-Fi_API_and_Model_Documentation_DhcpPool) [ 1 .. 4 ] items
serviceName required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Payload

Content type

application/json

{"dhcpMode": "EnableOnEachAPs",
"dhcpPools": [{"description": "string",
"endIpAddress": "string",
"leaseTimeHours": 24,
"leaseTimeMinutes": 59,
"name": "string",
"primaryDnsIp": "string",
"secondaryDnsIp": "string",
"startIpAddress": "string",
"subnetAddress": "string",
"subnetMask": "string",
"vlanId": 1
}
],
"serviceName": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"dhcpMode": "EnableOnEachAPs",
"dhcpPools": [{"description": "string",
"endIpAddress": "string",
"id": "string",
"leaseTimeHours": 24,
"leaseTimeMinutes": 59,
"name": "string",
"primaryDnsIp": "string",
"secondaryDnsIp": "string",
"startIpAddress": "string",
"subnetAddress": "string",
"subnetMask": "string",
"vlanId": 1
}
],
"id": "string",
"serviceName": "string",
"usage": [{"totalIpCount": 0,
"usedIpCount": 0,
"venueId": "string"
}
],
"venueIds": ["string"
]
}
}

Delete DHCP Configuration Service Profile

Delete a DHCP configuration service profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

dhcpConfigServiceProfileId

required

string

DHCP Config Service Profile ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get DHCP Configuration Service Profile

Get the DHCP configuration service profile details. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

dhcpConfigServiceProfileId

required

string

DHCP Config Service Profile ID

Responses

Response samples

Content type

application/json

{"dhcpMode": "EnableOnEachAPs",
"dhcpPools": [{"description": "string",
"endIpAddress": "string",
"id": "string",
"leaseTimeHours": 24,
"leaseTimeMinutes": 59,
"name": "string",
"primaryDnsIp": "string",
"secondaryDnsIp": "string",
"startIpAddress": "string",
"subnetAddress": "string",
"subnetMask": "string",
"vlanId": 1
}
],
"id": "string",
"serviceName": "string",
"usage": [{"totalIpCount": 0,
"usedIpCount": 0,
"venueId": "string"
}
],
"venueIds": ["string"
]
}

Update DHCP Configuration Service Profile

Update a DHCP configuration service profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

dhcpConfigServiceProfileId

required

string

DHCP Config Service Profile ID

Request Body schema:
application/json
required

dhcpMode	string Default: "DhcpModeEnum.EnableOnEachAPs" Enum: "EnableOnEachAPs" "EnableOnMultipleAPs" "EnableOnHierarchicalAPs"
required	Array of objects (Wi-Fi_API_and_Model_Documentation_DhcpPool) [ 1 .. 4 ] items
serviceName required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Payload

Content type

application/json

{"dhcpMode": "EnableOnEachAPs",
"dhcpPools": [{"description": "string",
"endIpAddress": "string",
"leaseTimeHours": 24,
"leaseTimeMinutes": 59,
"name": "string",
"primaryDnsIp": "string",
"secondaryDnsIp": "string",
"startIpAddress": "string",
"subnetAddress": "string",
"subnetMask": "string",
"vlanId": 1
}
],
"serviceName": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP DHCP Client Leases

Get a list of DHCP client leases of the AP.

path Parameters

venueId required	string Venue ID
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"wifiDhcpClientLeases": [{"dhcpPoolName": "string",
"hostname": "string",
"ipAddress": "string",
"leaseExpiration": "string",
"macAddress": "string",
"status": "string"
}
]
}

Get DHCP Pools Usage in This AP

Get DHCP pools usage in this AP.

path Parameters

venueId required	string Venue ID
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"wifiDhcpPoolUsages": [{"description": "string",
"name": "string",
"totalIpCount": 0,
"usedIpCount": 0
}
]
}

Deactivate DHCP Configuration Service Profile On This Venue

Deactivate DHCP configuration service profile on this venue.

path Parameters

venueId required	string Venue ID
dhcpConfigServiceProfileId required	string DHCP Config Service Profile ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

Get DHCP Service Profile Settings of This Venue

Get DHCP service profile settings of this venue.

path Parameters

venueId required	string Venue ID
dhcpConfigServiceProfileId required	string DHCP Config Service Profile ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId}

Response samples

Content type

application/json

{"activeDhcpPoolNames": ["string"
],
"dhcpServiceAps": [{"dhcpIps": ["string"
],
"role": "PrimaryServer",
"serialNumber": "stringstring"
}
],
"wanPortSelectionMode": "Dynamic"
}

Activate DHCP Configuration Service Profile On This Venue and Update Settings

Activate DHCP configuration service profile on this venue and update settings.

path Parameters

venueId required	string Venue ID
dhcpConfigServiceProfileId required	string DHCP Config Service Profile ID

Request Body schema:
application/json
required

activeDhcpPoolNames	Array of strings
	Array of objects (Wi-Fi_API_and_Model_Documentation_DhcpServiceAp)
wanPortSelectionMode	string Default: "DhcpWanPortSelectionModeEnum.Dynamic" Enum: "Dynamic" "Manual"

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId}

Request samples

Payload

Content type

application/json

{"activeDhcpPoolNames": ["string"
],
"dhcpServiceAps": [{"dhcpIps": ["string"
],
"role": "PrimaryServer",
"serialNumber": "stringstring"
}
],
"wanPortSelectionMode": "Dynamic"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue DHCP Leases

Get a list of DHCP leases of the venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"wifiDhcpClientLeases": [{"dhcpPoolName": "string",
"hostname": "string",
"ipAddress": "string",
"leaseExpiration": "string",
"macAddress": "string",
"status": "string"
}
]
}

Get DHCP Pools Usage in Venue

Get DHCP pools usage in this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"wifiDhcpPoolUsages": [{"description": "string",
"name": "string",
"totalIpCount": 0,
"usedIpCount": 0
}
]
}

MAC Registration Pool

Manage MAC registration pool profiles.

Deactivate MAC Registration Pool On Wi-Fi Network

Use this API command to delete the relationship between MAC registration pool and Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
macRegistrationPoolId required	string MAC Registration Pool ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/wifiNetworks/{wifiNetworkId}/macRegistrationPools/{macRegistrationPoolId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/wifiNetworks/{wifiNetworkId}/macRegistrationPools/{macRegistrationPoolId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/wifiNetworks/{wifiNetworkId}/macRegistrationPools/{macRegistrationPoolId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate MAC Registration Pool On Wi-Fi Network

Use this API command to build the relationship between MAC registration pool and Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
macRegistrationPoolId required	string MAC Registration Pool ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/wifiNetworks/{wifiNetworkId}/macRegistrationPools/{macRegistrationPoolId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/wifiNetworks/{wifiNetworkId}/macRegistrationPools/{macRegistrationPoolId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/wifiNetworks/{wifiNetworkId}/macRegistrationPools/{macRegistrationPoolId}

Response samples

Content type

application/json

{"requestId": "string"
}

AP SNMP Agent Profile

Manage AP SNMP policy profiles.

Delete AP SNMP Agent Profiles Deprecated

Delete a list of AP SNMP agent profiles.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP SNMP Agent Profiles Deprecated

Get the AP SNMP agent profiles.

Responses

Response samples

Content type

application/json

[{"id": "string",
"policyName": "string",
"snmpV2Agents": [{"communityName": "string",
"notificationType": "Trap",
"readPrivilege": false,
"targetAddr": "string",
"targetPort": 162,
"trapPrivilege": false
}
],
"snmpV3Agents": [{"authPassword": "stringst",
"authProtocol": "SHA",
"notificationType": "Trap",
"privacyPassword": "stringst",
"privacyProtocol": "None",
"readPrivilege": false,
"targetAddr": "string",
"targetPort": 162,
"trapPrivilege": false,
"userName": "string"
}
],
"tenantId": "string"
}
]

Create AP SNMP Agent Profile Deprecated

Create a new AP SNMP agent profile.

Request Body schema: application/json
required

policyName required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
	Array of objects (Wi-Fi_API_and_Model_Documentation_ApSnmpV2Agent) [ 0 .. 2 ] items
	Array of objects (Wi-Fi_API_and_Model_Documentation_ApSnmpV3Agent) [ 0 .. 2 ] items

Responses

Request samples

Payload

Content type

application/json

{"policyName": "string",
"snmpV2Agents": [{"communityName": "string",
"notificationType": "Trap",
"readPrivilege": false,
"targetAddr": "string",
"targetPort": 162,
"trapPrivilege": false
}
],
"snmpV3Agents": [{"authPassword": "stringst",
"authProtocol": "SHA",
"notificationType": "Trap",
"privacyPassword": "stringst",
"privacyProtocol": "None",
"readPrivilege": false,
"targetAddr": "string",
"targetPort": 162,
"trapPrivilege": false,
"userName": "string"
}
]
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"id": "string",
"policyName": "string",
"snmpV2Agents": [{"communityName": "string",
"notificationType": "Trap",
"readPrivilege": false,
"targetAddr": "string",
"targetPort": 162,
"trapPrivilege": false
}
],
"snmpV3Agents": [{"authPassword": "stringst",
"authProtocol": "SHA",
"notificationType": "Trap",
"privacyPassword": "stringst",
"privacyProtocol": "None",
"readPrivilege": false,
"targetAddr": "string",
"targetPort": 162,
"trapPrivilege": false,
"userName": "string"
}
],
"tenantId": "string"
}
}

Delete AP SNMP Agent Profile Deprecated

Delete a AP SNMP agent profile.

path Parameters

apSnmpProfileId

required

string

AP SNMP Agent Profile ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP SNMP Profile Deprecated

Get the details for this AP SNMP profile.

path Parameters

apSnmpProfileId

required

string

AP SNMP Agent Profile ID

Responses

Response samples

Content type

application/json

{"id": "string",
"policyName": "string",
"snmpV2Agents": [{"communityName": "string",
"notificationType": "Trap",
"readPrivilege": false,
"targetAddr": "string",
"targetPort": 162,
"trapPrivilege": false
}
],
"snmpV3Agents": [{"authPassword": "stringst",
"authProtocol": "SHA",
"notificationType": "Trap",
"privacyPassword": "stringst",
"privacyProtocol": "None",
"readPrivilege": false,
"targetAddr": "string",
"targetPort": 162,
"trapPrivilege": false,
"userName": "string"
}
],
"tenantId": "string"
}

Update AP SNMP Agent Profile Deprecated

Update a AP SNMP agent profile.

path Parameters

apSnmpProfileId

required

string

AP SNMP Agent Profile ID

Request Body schema: application/json
required

policyName required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
	Array of objects (Wi-Fi_API_and_Model_Documentation_ApSnmpV2Agent) [ 0 .. 2 ] items
	Array of objects (Wi-Fi_API_and_Model_Documentation_ApSnmpV3Agent) [ 0 .. 2 ] items

Responses

Request samples

Payload

Content type

application/json

{"policyName": "string",
"snmpV2Agents": [{"communityName": "string",
"notificationType": "Trap",
"readPrivilege": false,
"targetAddr": "string",
"targetPort": 162,
"trapPrivilege": false
}
],
"snmpV3Agents": [{"authPassword": "stringst",
"authProtocol": "SHA",
"notificationType": "Trap",
"privacyPassword": "stringst",
"privacyProtocol": "None",
"readPrivilege": false,
"targetAddr": "string",
"targetPort": 162,
"trapPrivilege": false,
"userName": "string"
}
]
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get AP SNMP Agent Profile AP Usage Deprecated

Get a list of APs of the AP SNMP agent profile.

path Parameters

apSnmpProfileId

required

string

AP SNMP Agent Profile ID

Request Body schema: application/json
required

page	integer <int32> Default: 1
pageSize	integer <int32> Default: 25
searchString	string Search by AP name or venue name.
sortField	string AP name or venue name only.
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"page": 1,
"pageSize": 25,
"searchString": "string",
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

Content type

application/json

{"data": [{"apId": "string",
"apName": "string",
"venueId": "string",
"venueName": "string"
}
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Hotspot 2.0 Operator

Manage Hotspot 2.0 Operators.

Create Hotspot 2.0 Operator

Create a new Hotspot 2.0 operator.

Request Body schema:
application/json
required

domainNames required	Array of strings [ 1 .. 8 ] items [ items [ 1 .. 8 ] characters ]
	Array of objects (Wi-Fi_API_and_Model_Documentation_Hotspot20FriendlyName) [ 1 .. 2147483647 ] items
name required	string [ 2 .. 32 ] characters

Responses

Request samples

Payload

Content type

application/json

{"domainNames": ["string"
],
"friendlyNames": [{"language": "ENG",
"name": "string"
}
],
"name": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"id": "string"
}
}

Delete Hotspot 2.0 Operator

Delete a Hotspot 2.0 operator.

path Parameters

hotspot20OperatorId

required

string

Hotspot 2.0 Operator ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Hotspot 2.0 Operator

Get the Hotspot 2.0 operator details.

path Parameters

hotspot20OperatorId

required

string

Hotspot 2.0 Operator ID

Responses

Response samples

Content type

application/json

{"domainNames": ["string"
],
"friendlyNames": [{"language": "ENG",
"name": "string"
}
],
"id": "string",
"name": "string"
}

Update Hotspot 2.0 Operator

Update a Hotspot 2.0 operator.

path Parameters

hotspot20OperatorId

required

string

Hotspot 2.0 Operator ID

Request Body schema:
application/json
required

domainNames required	Array of strings [ 1 .. 8 ] items [ items [ 1 .. 8 ] characters ]
	Array of objects (Wi-Fi_API_and_Model_Documentation_Hotspot20FriendlyName) [ 1 .. 2147483647 ] items
name required	string [ 2 .. 32 ] characters

Responses

Request samples

Payload

Content type

application/json

{"domainNames": ["string"
],
"friendlyNames": [{"language": "ENG",
"name": "string"
}
],
"name": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate Hotspot 2.0 Operator On Wi-Fi Network

Deactivate Hotspot 2.0 operator on Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
hotspot20OperatorId required	string Hotspot 2.0 Operator ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/wifiNetworks/{wifiNetworkId}/hotspot20Operators/{hotspot20OperatorId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/wifiNetworks/{wifiNetworkId}/hotspot20Operators/{hotspot20OperatorId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/wifiNetworks/{wifiNetworkId}/hotspot20Operators/{hotspot20OperatorId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Hotspot 2.0 Operator On Wi-Fi Network

Activate Hotspot 2.0 operator on Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
hotspot20OperatorId required	string Hotspot 2.0 Operator ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/wifiNetworks/{wifiNetworkId}/hotspot20Operators/{hotspot20OperatorId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/wifiNetworks/{wifiNetworkId}/hotspot20Operators/{hotspot20OperatorId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/wifiNetworks/{wifiNetworkId}/hotspot20Operators/{hotspot20OperatorId}

Response samples

Content type

application/json

{"requestId": "string"
}

Rogue AP Detection Policy

Manage rogue AP detection policies.

Rogue APs are Wi-Fi APs which are in radio range of your Wi-Fi network, but are unknown to the Ruckus cloud. For example, these may be APs in installed your venues without explicit authorization from your administrators, whether added by a well-meaning employee or by a malicious attacker; as such, they could be on the same LAN as your authorized APs. They could also be APs installed in nearby venues (for example, if your venue is part of a multi-tenant facility). Rogue classification polices help to automatically classify these unknown APs by setting up rules which trigger a rogue AP report when specific-rogue detection criteria are met.

Delete AP Detection Policies Deprecated

Delete a list of rogue AP detection policies. Use DELETE /roguePolicies/{roguePolicyId} instead.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Rogue AP Detection Policies Deprecated

Get a list of rogue AP detection policies. Use POST /roguePolicies/query instead.

Responses

Response samples

Content type

application/json

[{"description": "string",
"id": "string",
"name": "string",
"rules": [{"classification": "Ignored",
"moreInfo": "string",
"name": "string",
"priority": 1,
"type": "AdhocRule"
}
],
"venues": [{"id": "string",
"name": "string"
}
]
}
]

Create Rogue AP Detection Policy Deprecated

Create a rogue AP detection policy. Use POST /roguePolicies instead.

Request Body schema: application/json
required

description	string [ 0 .. 255 ] characters
name required	string [ 2 .. 32 ] characters (?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
	Array of objects (Wi-Fi_API_and_Model_Documentation_RogueClassificationPolicyRule)
	Array of objects (Wi-Fi_API_and_Model_Documentation_IdAndName) Deprecated

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"rules": [{"classification": "Ignored",
"moreInfo": "string",
"name": "string",
"priority": 1,
"type": "AdhocRule"
}
],
"venues": [{"id": "string",
"name": "string"
}
]
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"description": "string",
"id": "string",
"name": "string",
"rules": [{"classification": "Ignored",
"moreInfo": "string",
"name": "string",
"priority": 1,
"type": "AdhocRule"
}
],
"venues": [{"id": "string",
"name": "string"
}
]
}
}

Delete Rogue AP Detection Policy Deprecated

Delete this rogue AP detection policy. Use DELETE /roguePolicies/{roguePolicyId} instead.

path Parameters

roguePolicyId

required

string

Rogue AP Detection Policy ID.

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Rogue AP Detection Policy Deprecated

Get this rogue AP detection policy. Use GET /roguePolicies/{roguePolicyId} instead.

path Parameters

roguePolicyId

required

string

Rogue AP Detection Policy ID.

Responses

Response samples

Content type

application/json

{"description": "string",
"id": "string",
"name": "string",
"rules": [{"classification": "Ignored",
"moreInfo": "string",
"name": "string",
"priority": 1,
"type": "AdhocRule"
}
],
"venues": [{"id": "string",
"name": "string"
}
]
}

Update Rogue AP Detection Policy Deprecated

Update this rogue AP detection policy. Use PUT /roguePolicies/{roguePolicyId} instead.

path Parameters

roguePolicyId

required

string

Rogue AP Detection Policy ID.

Request Body schema: application/json
required

description	string [ 0 .. 255 ] characters
name required	string [ 2 .. 32 ] characters (?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
	Array of objects (Wi-Fi_API_and_Model_Documentation_RogueClassificationPolicyRule)
	Array of objects (Wi-Fi_API_and_Model_Documentation_IdAndName) Deprecated

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"rules": [{"classification": "Ignored",
"moreInfo": "string",
"name": "string",
"priority": 1,
"type": "AdhocRule"
}
],
"venues": [{"id": "string",
"name": "string"
}
]
}

Response samples

Content type

application/json

{"requestId": "string"
}

Unbind Rogue AP Detection Policy from Venues Deprecated

Delete the binding between a rogue AP detection policy and its list of venues and apply the default policy to those venues instead. Note that unbinding a policy from a venue does not disable rogue AP detection in that venue. Use DELETE /venues/{venueId}/roguePolicies/{roguePolicyId} instead.

path Parameters

roguePolicyId

required

string

Rogue AP Detection Policy ID.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Create Rogue AP Detection Policy Venue Bindings Deprecated

Bind a rogue AP detection policy to a list of venues. Use PUT /venues/{venueId}/roguePolicies/{roguePolicyId} instead.

path Parameters

roguePolicyId

required

string

Rogue AP Detection Policy ID.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Create Rogue AP Detection Policy

Create a rogue AP detection policy.

Request Body schema:
application/json
required

description	string [ 0 .. 255 ] characters
name required	string [ 2 .. 32 ] characters (?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
	Array of objects (Wi-Fi_API_and_Model_Documentation_RogueClassificationPolicyRule)

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"rules": [{"classification": "Ignored",
"moreInfo": "string",
"name": "string",
"priority": 1,
"type": "AdhocRule"
}
]
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"id": "string"
}
}

Delete Rogue AP Detection Policy

Delete this rogue AP detection policy.

path Parameters

roguePolicyId

required

string

Rogue AP Detection Policy ID.

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Rogue AP Detection Policy

Get this rogue AP detection policy.

path Parameters

roguePolicyId

required

string

Rogue AP Detection Policy ID.

Responses

Response samples

Content type

application/json

{"description": "string",
"id": "string",
"name": "string",
"rules": [{"classification": "Ignored",
"moreInfo": "string",
"name": "string",
"priority": 1,
"type": "AdhocRule"
}
]
}

Update Rogue AP Detection Policy

Update this rogue AP detection policy.

path Parameters

roguePolicyId

required

string

Rogue AP Detection Policy ID.

Request Body schema:
application/json
required

description	string [ 0 .. 255 ] characters
name required	string [ 2 .. 32 ] characters (?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
	Array of objects (Wi-Fi_API_and_Model_Documentation_RogueClassificationPolicyRule)

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"rules": [{"classification": "Ignored",
"moreInfo": "string",
"name": "string",
"priority": 1,
"type": "AdhocRule"
}
]
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate Rogue AP Detection Policy On Venue

Deactivate a rogue AP detection policy on a venue and apply the default policy to that venue instead. Note that deactivate a policy from a venue does not disable rogue AP detection in that venue.

path Parameters

venueId required	string Venue ID.
roguePolicyId required	string Rogue AP Detection Policy ID.

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Rogue AP Detection Policy On Venue

Activate a rogue AP detection policy on a venue.

path Parameters

venueId required	string Venue ID.
roguePolicyId required	string Rogue AP Detection Policy ID.

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Rogue Policy Settings

Get the venue rogue policy settings.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"reportThreshold": 0
}

Update Venue Rogue Policy Settings

Update the venue rogue policy settings.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

reportThreshold

integer <int32> [ 0 .. 100 ]

Default: 0

Responses

Request samples

Payload

Content type

application/json

{"reportThreshold": 0
}

Response samples

Content type

application/json

{"requestId": "string"
}

AP Venue

Manage Wi-Fi venue configuration, including radio settings, mesh, LEDs, LAN-ports, and syslog.

Get Available LTE Bands

Get available LTE bands for each region.

Responses

Response samples

Content type

application/json

[{"band3G": ["string"
],
"band4G": ["string"
],
"countryCodes": ["string"
],
"region": "DOMAIN_1"
}
]

Get Venue All AP-Model Capabilities

Get all AP model capabilities of the venue.

Responses

Response samples

Content type

application/json

{"apModels": [{"allowCbandCountry": ["string"
],
"allowDfsCountry": ["string"
],
"bandCombinationCapabilities": ["DUAL"
],
"canSupportCellular": false,
"canSupportLacp": false,
"canSupportPoeMode": false,
"canSupportPoeOut": false,
"capabilityScore": 0,
"defaultBandCombination": "DUAL",
"externalAntenna": {"coupled": false,
"enable24G": false,
"enable50G": false,
"gain24G": 60,
"gain50G": 60,
"supportDisable": false
},
"has160MHzChannelBandwidth": false,
"isOutdoor": false,
"lanPortPictureDownloadUrl": "string",
"lanPorts": [{"defaultType": "string",
"displayLabel": "string",
"id": "string",
"isPoeOutPort": false,
"isPoePort": false,
"supportDisable": false,
"trunkPortOnly": false,
"untagId": 0,
"vlanMembers": "string"
}
],
"ledOn": false,
"lldpAdInterval": 0,
"lldpEnable": false,
"lldpHoldTime": 0,
"lldpMgmtEnable": false,
"maxChannelization24G": 0,
"maxChannelization5G": 0,
"maxChannelization6G": 0,
"model": "string",
"pictureDownloadUrl": "string",
"poeModeCapabilities": ["string"
],
"primaryWanRecoveryTimer": 0,
"requireOneEnabledTrunkPort": false,
"simCardPrimaryApn": "string",
"simCardPrimaryCellularNetworkSelection": "string",
"simCardPrimaryEnabled": true,
"simCardPrimaryRoaming": true,
"simCardSecondaryApn": "string",
"simCardSecondaryCellularNetworkSelection": "string",
"simCardSecondaryEnabled": true,
"simCardSecondaryRoaming": true,
"support11AX": false,
"supportBandCombination": false,
"supportChannel144": false,
"supportDual5gMode": false,
"supportMesh": true,
"supportTriRadio": false,
"version": "string",
"wanConnection": "string"
}
]
}

Get Available LTE Bands Deprecated

Get available LTE bands for each region.

Responses

Response samples

Content type

application/json

[{"band3G": ["string"
],
"band4G": ["string"
],
"countryCodes": ["string"
],
"region": "DOMAIN_1"
}
]

Get Venues Wi-Fi Settings Deprecated

Get the venue list of Wi-Fi details.

Responses

Response samples

Content type

application/json

[{"apPassword": "string",
"apSnmpAgent": {"apSnmpAgentProfileId": "string",
"enableApSnmp": false
},
"bandBalancing": {"clientPercent24": 25,
"enabled": false
},
"bssColoring": {"bssColoringEnabled": true
},
"clientAdmissionControl": {"enable24G": false,
"enable50G": false,
"maxRadioLoad24G": 75,
"maxRadioLoad50G": 75,
"minClientCount24G": 10,
"minClientCount50G": 20,
"minClientThroughput24G": 0,
"minClientThroughput50G": 0
},
"countryCode": "string",
"denialOfServiceProtection": {"blockingPeriod": 60,
"checkPeriod": 30,
"enabled": false,
"failThreshold": 5
},
"dhcpServiceSetting": {"dhcpServiceAps": [{"dhcpIps": ["string"
],
"role": "PrimaryServer",
"serialNumber": "stringstring"
}
],
"dhcpServiceProfileIds": ["string"
],
"enableClientIsolationAllowlist": false,
"enabled": false,
"mode": "EnableOnEachAPs",
"wanPortSelectionMode": "Dynamic"
},
"directedMulticast": {"networkEnabled": true,
"wiredEnabled": true,
"wirelessEnabled": true
},
"enableClientIsolationAllowlist": false,
"id": "string",
"loadBalancing": {"bandBalancingClientPercent24G": 25,
"bandBalancingEnabled": true,
"enabled": false,
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"steeringMode": "BASIC"
},
"lteBandLockChannels": [{"band3G": ["string"
],
"band4G": ["string"
],
"region": "DOMAIN_1"
}
],
"mesh": {"enabled": false,
"passphrase": "string",
"radioType": "2.4-GHz",
"ssid": "string"
},
"radioCustomization": {"radioParams24G": {"allowedChannels": ["1"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParams50G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"combineChannels": false,
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParams6G": {"allowedChannels": ["1"
],
"bssMinRate6G": "HE_MCS_0",
"changeInterval": 33,
"channelBandwidth": "AUTO",
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastUplinkRateLimiting": false,
"method": "MANUAL",
"mgmtTxRate6G": "6",
"multicastDownlinkRateLimiting": 1,
"multicastUplinkRateLimiting": 1,
"scanInterval": 10,
"txPower": "MAX"
},
"radioParamsDual5G": {"enabled": false,
"inheritParamsLower5G": true,
"inheritParamsUpper5G": true,
"radioParamsLower5G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParamsUpper5G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
}
}
},
"rogueAp": {"enabled": false,
"reportThreshold": 0,
"roguePolicyId": "string"
},
"syslog": {"enabled": false,
"facility": "KEEP_ORIGINAL",
"flowLevel": "GENERAL_LOGS",
"port": 514,
"priority": "EMERGENCY",
"protocol": "TCP",
"secondaryPort": 514,
"secondaryProtocol": "TCP",
"secondaryServer": "string",
"server": "string"
},
"tenantId": "string",
"wifiFirmwareVersion": "string"
}
]

Get Venue Basic Service Set Coloring Settings

Get basic service set coloring settings of this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"bssColoringEnabled": true
}

Update Venue Basic Service Set Coloring Settings

Update basic service set coloring settings of this venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

bssColoringEnabled

boolean

Default: true

Responses

Request samples

Payload

Content type

application/json

{"bssColoringEnabled": true
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue AP-Model Cellular

Get AP model cellular settings and LTE band lock channels of the venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"model": "string",
"primarySim": {"apn": "string",
"enabled": true,
"lteBands": [{"band3G": ["string"
],
"band4G": ["string"
],
"region": "DOMAIN_1"
}
],
"networkSelection": "AUTO",
"roaming": true
},
"primaryWanRecoveryTimer": 10,
"secondarySim": {"apn": "string",
"enabled": true,
"lteBands": [{"band3G": ["string"
],
"band4G": ["string"
],
"region": "DOMAIN_1"
}
],
"networkSelection": "AUTO",
"roaming": true
},
"wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}

Update Venue AP-Model Cellular

Update AP model cellular settings and LTE band lock channels of the venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

model	string [ 0 .. 64 ] characters
	object (Wi-Fi_API_and_Model_Documentation_SimSettings) SIM setting object.
primaryWanRecoveryTimer required	integer <int32> [ 10 .. 300 ]
	object (Wi-Fi_API_and_Model_Documentation_SimSettings) SIM setting object.
wanConnection required	string Enum: "ETH_WITH_CELLULAR_FAILOVER" "CELLULAR_WITH_ETH_FAILOVER" "ETH" "CELLULAR"

Responses

Request samples

Payload

Content type

application/json

{"model": "string",
"primarySim": {"apn": "string",
"enabled": true,
"lteBands": [{"band3G": ["string"
],
"band4G": ["string"
],
"region": "DOMAIN_1"
}
],
"networkSelection": "AUTO",
"roaming": true
},
"primaryWanRecoveryTimer": 10,
"secondarySim": {"apn": "string",
"enabled": true,
"lteBands": [{"band3G": ["string"
],
"band4G": ["string"
],
"region": "DOMAIN_1"
}
],
"networkSelection": "AUTO",
"roaming": true
},
"wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Client Admission Control Settings

Get this venue's client admission control settings.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"enable24G": false,
"enable50G": false,
"maxRadioLoad24G": 75,
"maxRadioLoad50G": 75,
"minClientCount24G": 10,
"minClientCount50G": 20,
"minClientThroughput24G": 0,
"minClientThroughput50G": 0
}

Update Venue Client Admission Control Settings

Update this venue's client admission control settings.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

enable24G	boolean Default: false
enable50G	boolean Default: false
maxRadioLoad24G	integer <int32> [ 50 .. 100 ] Default: 75
maxRadioLoad50G	integer <int32> [ 50 .. 100 ] Default: 75
minClientCount24G	integer <int32> [ 0 .. 100 ] Default: 10
minClientCount50G	integer <int32> [ 0 .. 100 ] Default: 20
minClientThroughput24G	integer <int32> [ 0 .. 100 ] Default: 0
minClientThroughput50G	integer <int32> [ 0 .. 100 ] Default: 0

Responses

Request samples

Payload

Content type

application/json

{"enable24G": false,
"enable50G": false,
"maxRadioLoad24G": 75,
"maxRadioLoad50G": 75,
"minClientCount24G": 10,
"minClientCount50G": 20,
"minClientThroughput24G": 0,
"minClientThroughput50G": 0
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Directed Multicast Settings

Get directed multicast settings for this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"networkEnabled": true,
"wiredEnabled": true,
"wirelessEnabled": true
}

Update Venue Directed Multicast Settings

Venue directed multicast settings of this venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

networkEnabled	boolean Default: true
wiredEnabled	boolean Default: true
wirelessEnabled	boolean Default: true

Responses

Request samples

Payload

Content type

application/json

{"networkEnabled": true,
"wiredEnabled": true,
"wirelessEnabled": true
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue DoS Protection

Get DoS protection of this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"blockingPeriod": 60,
"checkPeriod": 30,
"enabled": false,
"failThreshold": 5
}

Update Venue DoS Protection

Update DoS protection of this venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

blockingPeriod	integer <int32> [ 30 .. 600 ] Default: 60
checkPeriod	integer <int32> [ 30 .. 600 ] Default: 30
enabled	boolean Default: false
failThreshold	integer <int32> [ 2 .. 25 ] Default: 5

Responses

Request samples

Payload

Content type

application/json

{"blockingPeriod": 60,
"checkPeriod": 30,
"enabled": false,
"failThreshold": 5
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue IP Mode Settings for APs

Get IP mode settings of the APs in this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"mode": "NONE"
}

Update Venue IP Mode Settings for APs

Update IP mode settings of the APs in this venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

mode	string Default: "IpModeEnum.IPV4" Enum: "NONE" "IPV4" "IPV6" "IPV4_IPV6"

Responses

Request samples

Payload

Content type

application/json

{"mode": "NONE"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Load Balancing Settings

Get load balancing settings for this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"bandBalancingClientPercent24G": 25,
"bandBalancingEnabled": true,
"enabled": false,
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"steeringMode": "BASIC"
}

Update Venue Load Balancing Settings

Update venue load balancing settings of this venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

bandBalancingClientPercent24G	integer <int32> [ 0 .. 100 ] Default: 25
bandBalancingEnabled	boolean Default: true
enabled	boolean Default: false
loadBalancingMethod	string Default: "LoadBalancingMethodEnum.BASED_ON_CLIENT_COUNT" Enum: "BASED_ON_CLIENT_COUNT" "BASED_ON_CAPACITY"
steeringMode	string Default: "SteeringModeEnum.BASIC" Enum: "BASIC" "PROACTIVE" "STRICT"

Responses

Request samples

Payload

Content type

application/json

{"bandBalancingClientPercent24G": 25,
"bandBalancingEnabled": true,
"enabled": false,
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"steeringMode": "BASIC"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue AP Management VLAN Settings

Get AP management traffic VLAN settings of this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"vlanId": 1
}

Update Venue AP Management VLAN Settings

Update AP management traffic VLAN settings of this venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

vlanId

integer <int32> [ 1 .. 4094 ]

Responses

Request samples

Payload

Content type

application/json

{"vlanId": 1
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Mesh Settings

Get the venue mesh settings.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"enabled": false,
"passphrase": "string",
"radioType": "2.4-GHz",
"ssid": "string"
}

Update Mesh

Enable/disable the venue mesh.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

enabled	boolean Default: false
passphrase	string(^[!-~]([ -~]){6,61}[!-~]$)\|(^([0-9a-fA-F]){6...
radioType	string Default: "MeshRadioTypeEnum._5_GHz" Enum: "2.4-GHz" "5-GHz"
ssid	string(^(?!.*(\$\(\|`))(([!-~]([ -~]){0,30}[!-~]$)\|(...

Responses

Request samples

Payload

Content type

application/json

{"enabled": false,
"passphrase": "string",
"radioType": "2.4-GHz",
"ssid": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Antenna Type

Get venue antenna type settings. The settings are defined per AP model.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

[{"model": "string"
}
]

Update Venue Antenna Type

Update venue antenna type settings. The settings are defined per AP model.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

Array

model

string [ 0 .. 64 ] characters

Responses

Request samples

Payload

Content type

application/json

[{"model": "string"
}
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Band Mode

Get venue band mode settings. The settings are defined per AP model.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

[{"bandMode": "DUAL",
"model": "string"
}
]

Update Venue Band Mode

Update venue band mode settings. The settings are defined per AP model.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

Array

bandMode	string Enum: "DUAL" "TRIPLE"
model	string [ 0 .. 64 ] characters

Responses

Request samples

Payload

Content type

application/json

[{"bandMode": "DUAL",
"model": "string"
}
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue AP-Model Capabilities

Get AP model capabilities of the venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"apModels": [{"allowCbandCountry": ["string"
],
"allowDfsCountry": ["string"
],
"bandCombinationCapabilities": ["DUAL"
],
"canSupportCellular": false,
"canSupportLacp": false,
"canSupportPoeMode": false,
"canSupportPoeOut": false,
"capabilityScore": 0,
"defaultBandCombination": "DUAL",
"externalAntenna": {"coupled": false,
"enable24G": false,
"enable50G": false,
"gain24G": 60,
"gain50G": 60,
"supportDisable": false
},
"has160MHzChannelBandwidth": false,
"isOutdoor": false,
"lanPortPictureDownloadUrl": "string",
"lanPorts": [{"defaultType": "string",
"displayLabel": "string",
"id": "string",
"isPoeOutPort": false,
"isPoePort": false,
"supportDisable": false,
"trunkPortOnly": false,
"untagId": 0,
"vlanMembers": "string"
}
],
"ledOn": false,
"lldpAdInterval": 0,
"lldpEnable": false,
"lldpHoldTime": 0,
"lldpMgmtEnable": false,
"maxChannelization24G": 0,
"maxChannelization5G": 0,
"maxChannelization6G": 0,
"model": "string",
"pictureDownloadUrl": "string",
"poeModeCapabilities": ["string"
],
"primaryWanRecoveryTimer": 0,
"requireOneEnabledTrunkPort": false,
"simCardPrimaryApn": "string",
"simCardPrimaryCellularNetworkSelection": "string",
"simCardPrimaryEnabled": true,
"simCardPrimaryRoaming": true,
"simCardSecondaryApn": "string",
"simCardSecondaryCellularNetworkSelection": "string",
"simCardSecondaryEnabled": true,
"simCardSecondaryRoaming": true,
"support11AX": false,
"supportBandCombination": false,
"supportChannel144": false,
"supportDual5gMode": false,
"supportMesh": true,
"supportTriRadio": false,
"version": "string",
"wanConnection": "string"
}
]
}

Get Venue AP Model External Antenna Settings

List venue external antenna settings. The settings are defined per AP model.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

[{"enable24G": false,
"enable50G": false,
"gain24G": 60,
"gain50G": 60,
"model": "string"
}
]

Update Venue AP Model External Antenna Settings

Update a venue external antenna settings. The settings are defined per AP model.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

Array

enable24G	boolean Default: false
enable50G	boolean Default: false
gain24G	integer <int32> [ 0 .. 60 ]
gain50G	integer <int32> [ 0 .. 60 ]
model	string [ 0 .. 64 ] characters

Responses

Request samples

Payload

Content type

application/json

[{"enable24G": false,
"enable50G": false,
"gain24G": 60,
"gain50G": 60,
"model": "string"
}
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue LAN-Ports Deprecated

List venue LAN-port settings. The settings are defined per AP model.

path Parameters

venueId

required

string

Venue ID

query Parameters

defaultOnly

boolean

Default: false

Only get the details of default LAN-port settings in this venue.

Responses

Response samples

Content type

application/json

[{"lanPorts": [{"enabled": true,
"portId": "string",
"type": "ACCESS",
"untagId": 1,
"vlanMembers": "string"
}
],
"model": "string",
"poeMode": "Auto",
"poeOut": false
}
]

Update Venue LAN-Ports Deprecated

Update a venue LAN-port settings. The settings are defined per AP model.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

Array

	Array of objects (Wi-Fi_API_and_Model_Documentation_VenueLanPort)
model	string [ 0 .. 64 ] characters
poeMode	string Enum: "Auto" "802.3af" "802.3at" "802.3bt-Class_5" "802.3bt-Class_6" "802.3bt-Class_7" "802.3bt-Class_8"
poeOut	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

[{"lanPorts": [{"enabled": true,
"portId": "string",
"type": "ACCESS",
"untagId": 1,
"vlanMembers": "string"
}
],
"model": "string",
"poeMode": "Auto",
"poeOut": false
}
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue LED

Get venue LED settings. The settings are defined per AP model.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

[{"ledEnabled": false,
"model": "string"
}
]

Update Venue LED

Update venue LED settings. The settings are defined per AP model.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

Array

ledEnabled	boolean Default: false
model	string [ 0 .. 64 ] characters

Responses

Request samples

Payload

Content type

application/json

[{"ledEnabled": false,
"model": "string"
}
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Multicast DNS Fencing Settings

Get multicast DNS fencing settings of the APs in this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"enabled": false,
"rules": [{"customMappingEnabled": false,
"customServiceName": "string",
"customStrings": ["string"
],
"description": "string",
"service": "AIRDISK",
"wiredEnabled": false,
"wiredRules": [{"closestApMac": "string",
"deviceMacAddresses": ["string"
],
"fencingRange": "SAME_AP",
"name": "string"
}
],
"wirelessEnabled": false,
"wirelessRule": {"fencingRange": "SAME_AP"
}
}
]
}

Update Venue Multicast DNS Fencing Settings

Update multicast DNS fencing settings of the APs in this venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

enabled	boolean Default: false
	Array of objects (Wi-Fi_API_and_Model_Documentation_MulticastDnsFencingRule)

Responses

Request samples

Payload

Content type

application/json

{"enabled": false,
"rules": [{"customMappingEnabled": false,
"customServiceName": "string",
"customStrings": ["string"
],
"description": "string",
"service": "AIRDISK",
"wiredEnabled": false,
"wiredRules": [{"closestApMac": "string",
"deviceMacAddresses": ["string"
],
"fencingRange": "SAME_AP",
"name": "string"
}
],
"wirelessEnabled": false,
"wirelessRule": {"fencingRange": "SAME_AP"
}
}
]
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Radio

Get the venue radio.

path Parameters

venueId

required

string

Venue ID

query Parameters

defaultOnly

boolean

Default: false

Only get the details of default radio settings in this venue.

Responses

Response samples

Content type

application/json

{"radioParams24G": {"allowedChannels": ["1"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParams50G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"combineChannels": false,
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParams6G": {"allowedChannels": ["1"
],
"allowedIndoorChannels": ["1"
],
"allowedOutdoorChannels": ["1"
],
"bssMinRate6G": "HE_MCS_0",
"changeInterval": 33,
"channelBandwidth": "AUTO",
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastUplinkRateLimiting": false,
"method": "MANUAL",
"mgmtTxRate6G": "6",
"multicastDownlinkRateLimiting": 1,
"multicastUplinkRateLimiting": 1,
"scanInterval": 10,
"txPower": "MAX"
},
"radioParamsDual5G": {"enabled": false,
"inheritParamsLower5G": true,
"inheritParamsUpper5G": true,
"radioParamsLower5G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParamsUpper5G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
}
}
}

Update Venue Radio

Update the venue radio.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

	object (Wi-Fi_API_and_Model_Documentation_VenueApRadio24GHzSettings) Customized settings for 2.4-GHz radio.
	object (Wi-Fi_API_and_Model_Documentation_VenueApRadio5GHzSettings) Customized settings for 5-GHz radio.
	object (Wi-Fi_API_and_Model_Documentation_VenueApRadio6GHzSettingsV1_1) Customized settings for 6-GHz radio.
	object (Wi-Fi_API_and_Model_Documentation_VenueApRadioDual5GHzSettings) Customized settings for lower/upper 5-GHz radios.

Responses

Request samples

Payload

Content type

application/json

{"radioParams24G": {"allowedChannels": ["1"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParams50G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"combineChannels": false,
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParams6G": {"allowedChannels": ["1"
],
"allowedIndoorChannels": ["1"
],
"allowedOutdoorChannels": ["1"
],
"bssMinRate6G": "HE_MCS_0",
"changeInterval": 33,
"channelBandwidth": "AUTO",
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastUplinkRateLimiting": false,
"mgmtTxRate6G": "6",
"multicastDownlinkRateLimiting": 1,
"multicastUplinkRateLimiting": 1,
"scanInterval": 10,
"txPower": "MAX"
},
"radioParamsDual5G": {"enabled": false,
"inheritParamsLower5G": true,
"inheritParamsUpper5G": true,
"radioParamsLower5G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParamsUpper5G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
}
}
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue RADIUS Options Settings

Get this venue's RADIUS options settings.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"calledStationIdType": "BSSID",
"nasIdDelimiter": "DASH",
"nasIdType": "USER",
"nasMaxRetry": 2,
"nasReconnectPrimaryMin": 5,
"nasRequestTimeoutSec": 3,
"overrideEnabled": false,
"singleSessionIdAccounting": false,
"userDefinedNasId": "string"
}

Update Venue RADIUS Options Settings

Update this venue's RADIUS options settings.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

calledStationIdType	string Default: "CalledStationIdTypeEnum.BSSID" Enum: "BSSID" "AP_MAC" "NONE" "AP_GROUP"
nasIdDelimiter	string Default: "NasIdDelimiterEnum.DASH" Enum: "DASH" "COLON"
nasIdType	string Default: "NasIdTypeEnum.BSSID" Enum: "USER" "BSSID" "AP_MAC" "VENUE_NAME"
nasMaxRetry	integer <int32> [ 2 .. 10 ] Default: 2
nasReconnectPrimaryMin	integer <int32> [ 1 .. 300 ] Default: 5
nasRequestTimeoutSec	integer <int32> [ 2 .. 20 ] Default: 3
overrideEnabled	boolean Default: false
singleSessionIdAccounting	boolean Default: false
userDefinedNasId	string [ 2 .. 64 ] characters ^((?!`\|\$\()[ -~]){2,64}$

Responses

Request samples

Payload

Content type

application/json

{"calledStationIdType": "BSSID",
"nasIdDelimiter": "DASH",
"nasIdType": "USER",
"nasMaxRetry": 2,
"nasReconnectPrimaryMin": 5,
"nasRequestTimeoutSec": 3,
"overrideEnabled": false,
"singleSessionIdAccounting": false,
"userDefinedNasId": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Smart Monitor Settings

Get this venue's smart monitor settings.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"enabled": false,
"interval": 10,
"threshold": 3
}

Update Venue Smart Monitor Settings

Update this venue's smart monitor settings.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

enabled	boolean Default: false
interval	integer <int32> [ 5 .. 60 ] Default: 10 The interval how often smart monitor checks uplink status, measured by seconds.
threshold	integer <int32> [ 1 .. 10 ] Default: 3 The retry threshold for turning off the WLANs.

Responses

Request samples

Payload

Content type

application/json

{"enabled": false,
"interval": 10,
"threshold": 3
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Transport Layer Security KEY Enhanced Mode Settings for APs

Get transport layer security key enhanced mode settings of the APs in this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"tlsKeyEnhancedModeEnabled": false
}

Update Venue Transport Layer Security KEY Enhanced Mode Settings for APs

Update transport layer security key enhanced mode settings of the APs in this venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema:
application/json
required

tlsKeyEnhancedModeEnabled

boolean

Default: false

Responses

Request samples

Payload

Content type

application/json

{"tlsKeyEnhancedModeEnabled": false
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue AP-Model Capabilities Deprecated

Get AP model capabilities of the venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"apModels": [{"allowCbandCountry": ["string"
],
"allowDfsCountry": ["string"
],
"bandCombinationCapabilities": ["DUAL"
],
"canSupportCellular": false,
"canSupportLacp": false,
"canSupportPoeMode": false,
"canSupportPoeOut": false,
"capabilityScore": 0,
"defaultBandCombination": "DUAL",
"externalAntenna": {"coupled": false,
"enable24G": false,
"enable50G": false,
"gain24G": 60,
"gain50G": 60,
"supportDisable": false
},
"has160MHzChannelBandwidth": false,
"isOutdoor": false,
"lanPortPictureDownloadUrl": "string",
"lanPorts": [{"defaultType": "string",
"displayLabel": "string",
"id": "string",
"isPoeOutPort": false,
"isPoePort": false,
"supportDisable": false,
"trunkPortOnly": false,
"untagId": 0,
"vlanMembers": "string"
}
],
"ledOn": false,
"lldpAdInterval": 0,
"lldpEnable": false,
"lldpHoldTime": 0,
"lldpMgmtEnable": false,
"maxChannelization24G": 0,
"maxChannelization5G": 0,
"maxChannelization6G": 0,
"model": "string",
"pictureDownloadUrl": "string",
"poeModeCapabilities": ["string"
],
"primaryWanRecoveryTimer": 0,
"requireOneEnabledTrunkPort": false,
"simCardPrimaryApn": "string",
"simCardPrimaryCellularNetworkSelection": "string",
"simCardPrimaryEnabled": true,
"simCardPrimaryRoaming": true,
"simCardSecondaryApn": "string",
"simCardSecondaryCellularNetworkSelection": "string",
"simCardSecondaryEnabled": true,
"simCardSecondaryRoaming": true,
"support11AX": false,
"supportBandCombination": false,
"supportChannel144": false,
"supportDual5gMode": false,
"supportMesh": true,
"supportTriRadio": false,
"version": "string",
"wanConnection": "string"
}
]
}

Get Venue Basic Service Set Coloring Settings Deprecated

Get basic service set coloring settings of this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"bssColoringEnabled": true
}

Update Venue Basic Service Set Coloring Settings Deprecated

Update basic service set coloring settings of this venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema: application/json
required

bssColoringEnabled

boolean

Default: true

Responses

Request samples

Payload

Content type

application/json

{"bssColoringEnabled": true
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue AP-Model Cellular Deprecated

Get AP model cellular settings and LTE band lock channels of the venue.

path Parameters

venueId

required

string

Responses

Response samples

Content type

application/json

{"model": "string",
"primarySim": {"apn": "string",
"enabled": true,
"lteBands": [{"band3G": ["string"
],
"band4G": ["string"
],
"region": "DOMAIN_1"
}
],
"networkSelection": "AUTO",
"roaming": true
},
"primaryWanRecoveryTimer": 10,
"secondarySim": {"apn": "string",
"enabled": true,
"lteBands": [{"band3G": ["string"
],
"band4G": ["string"
],
"region": "DOMAIN_1"
}
],
"networkSelection": "AUTO",
"roaming": true
},
"wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}

Update Venue AP-Model Cellular Deprecated

Update AP model cellular settings and LTE band lock channels of the venue.

path Parameters

venueId

required

string

Request Body schema: application/json
required

model	string [ 0 .. 64 ] characters
	object (Wi-Fi_API_and_Model_Documentation_SimSettings) SIM setting object.
primaryWanRecoveryTimer required	integer <int32> [ 10 .. 300 ]
	object (Wi-Fi_API_and_Model_Documentation_SimSettings) SIM setting object.
wanConnection required	string Enum: "ETH_WITH_CELLULAR_FAILOVER" "CELLULAR_WITH_ETH_FAILOVER" "ETH" "CELLULAR"

Responses

Request samples

Payload

Content type

application/json

{"model": "string",
"primarySim": {"apn": "string",
"enabled": true,
"lteBands": [{"band3G": ["string"
],
"band4G": ["string"
],
"region": "DOMAIN_1"
}
],
"networkSelection": "AUTO",
"roaming": true
},
"primaryWanRecoveryTimer": 10,
"secondarySim": {"apn": "string",
"enabled": true,
"lteBands": [{"band3G": ["string"
],
"band4G": ["string"
],
"region": "DOMAIN_1"
}
],
"networkSelection": "AUTO",
"roaming": true
},
"wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Default Regulatory-Channels Deprecated

Get venue default regulatory channels.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"2.4GChannels": {"20MHz": ["1"
],
"40MHz": ["1"
],
"auto": ["1"
]
},
"5GChannels": {"dfs": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoorForOutdoorAp": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"outdoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
}
},
"5GLowerChannels": {"dfs": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoorForOutdoorAp": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"outdoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
}
},
"5GUpperChannels": {"dfs": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoorForOutdoorAp": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"outdoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
}
},
"6GChannels": {"160MHz": ["1"
],
"20MHz": ["1"
],
"40MHz": ["1"
],
"80MHz": ["1"
],
"auto": ["1"
]
}
}

Get Venue Client Admission Control Settings Deprecated

Get this venue's client admission control settings.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"enable24G": false,
"enable50G": false,
"maxRadioLoad24G": 75,
"maxRadioLoad50G": 75,
"minClientCount24G": 10,
"minClientCount50G": 20,
"minClientThroughput24G": 0,
"minClientThroughput50G": 0
}

Update Venue Client Admission Control Settings Deprecated

Update this venue's client admission control settings.

path Parameters

venueId

required

string

Venue ID

Request Body schema: application/json
required

enable24G	boolean Default: false
enable50G	boolean Default: false
maxRadioLoad24G	integer <int32> [ 50 .. 100 ] Default: 75
maxRadioLoad50G	integer <int32> [ 50 .. 100 ] Default: 75
minClientCount24G	integer <int32> [ 0 .. 100 ] Default: 10
minClientCount50G	integer <int32> [ 0 .. 100 ] Default: 20
minClientThroughput24G	integer <int32> [ 0 .. 100 ] Default: 0
minClientThroughput50G	integer <int32> [ 0 .. 100 ] Default: 0

Responses

Request samples

Payload

Content type

application/json

{"enable24G": false,
"enable50G": false,
"maxRadioLoad24G": 75,
"maxRadioLoad50G": 75,
"minClientCount24G": 10,
"minClientCount50G": 20,
"minClientThroughput24G": 0,
"minClientThroughput50G": 0
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get DHCP Service Profile Settings of This Venue Deprecated

Get DHCP service profile settings of this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"dhcpServiceAps": [{"dhcpIps": ["string"
],
"role": "PrimaryServer",
"serialNumber": "stringstring"
}
],
"enabled": false,
"id": "string",
"serviceProfileId": "string",
"wanPortSelectionMode": "Dynamic"
}

Update DHCP Service Profile Settings of This Venue Deprecated

Update DHCP service profile settings of this venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema: application/json
required

	Array of objects (Wi-Fi_API_and_Model_Documentation_DhcpServiceAp)
enabled	boolean Default: false
serviceProfileId	string
wanPortSelectionMode	string Default: "DhcpWanPortSelectionModeEnum.Dynamic" Enum: "Dynamic" "Manual"

Responses

Request samples

Payload

Content type

application/json

{"dhcpServiceAps": [{"dhcpIps": ["string"
],
"role": "PrimaryServer",
"serialNumber": "stringstring"
}
],
"enabled": false,
"serviceProfileId": "string",
"wanPortSelectionMode": "Dynamic"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue DHCP Leases Deprecated

Get a list of DHCP leases of the venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

[{"dhcpPoolId": "string",
"dhcpPoolName": "string",
"hostname": "string",
"ipAddress": "string",
"leaseExpiration": "string",
"macAddress": "string",
"status": "string"
}
]

Get DHCP Pools Usage in Venue Deprecated

Get DHCP pool data and usage in this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

[{"active": false,
"description": "string",
"endIpAddress": "string",
"id": "string",
"leaseTimeHours": 24,
"leaseTimeMinutes": 59,
"name": "string",
"primaryDnsIp": "string",
"secondaryDnsIp": "string",
"startIpAddress": "string",
"subnetAddress": "string",
"subnetMask": "string",
"totalIpCount": 0,
"usedIpCount": 0,
"vlanId": 1
}
]

Deactivate DHCP Pools in Venue Deprecated

Deactivate DHCP pools in venue.

path Parameters

venueId required	string
dhcpPoolId required	string

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Activate DHCP Pools in Venue Deprecated

Activate DHCP pools in venue.

path Parameters

venueId required	string
dhcpPoolId required	string

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Directed Multicast Settings Deprecated

Get directed multicast settings for this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"networkEnabled": true,
"wiredEnabled": true,
"wirelessEnabled": true
}

Update Venue Directed Multicast Settings Deprecated

Update venue directed multicast settings of this venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema: application/json
required

networkEnabled	boolean Default: true
wiredEnabled	boolean Default: true
wirelessEnabled	boolean Default: true

Responses

Request samples

Payload

Content type

application/json

{"networkEnabled": true,
"wiredEnabled": true,
"wirelessEnabled": true
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue DoS Protection Deprecated

Get DoS protection of this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"blockingPeriod": 60,
"checkPeriod": 30,
"enabled": false,
"failThreshold": 5
}

Update Venue DoS Protection Deprecated

Update DoS protection of this venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema: application/json
required

blockingPeriod	integer <int32> [ 30 .. 600 ] Default: 60
checkPeriod	integer <int32> [ 30 .. 600 ] Default: 30
enabled	boolean Default: false
failThreshold	integer <int32> [ 2 .. 25 ] Default: 5

Responses

Request samples

Payload

Content type

application/json

{"blockingPeriod": 60,
"checkPeriod": 30,
"enabled": false,
"failThreshold": 5
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue External Antenna Deprecated

List venue external antenna settings. The settings are defined per AP model.

path Parameters

venueId

required

string

Responses

Response samples

Content type

application/json

[{"enable24G": false,
"enable50G": false,
"gain24G": 60,
"gain50G": 60,
"model": "string"
}
]

Update Venue External Antenna Deprecated

Update a venue external antenna settings. The settings are defined per AP model.

path Parameters

venueId

required

string

Request Body schema: application/json
required

Array

enable24G	boolean Default: false
enable50G	boolean Default: false
gain24G	integer <int32> [ 0 .. 60 ]
gain50G	integer <int32> [ 0 .. 60 ]
model	string [ 0 .. 64 ] characters

Responses

Request samples

Payload

Content type

application/json

[{"enable24G": false,
"enable50G": false,
"gain24G": 60,
"gain50G": 60,
"model": "string"
}
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Client Isolation Allowlists Deprecated

Get a list of client isolation allowlists of the venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema: application/json
required

page	integer <int32> Default: 1
pageSize	integer <int32> Default: 25
sortField	string Support name only
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"page": 1,
"pageSize": 25,
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

Content type

application/json

{"data": [{"clientCount": 0,
"clientMacs": ["string"
],
"description": "string",
"id": "string",
"name": "string",
"networkCount": 0,
"networkNames": ["string"
]
}
],
"fields": ["string"
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Get Venue LAN-Ports Deprecated

List venue LAN-port settings. The settings are defined per AP model.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

[{"lanPorts": [{"enabled": true,
"portId": "string",
"type": "ACCESS",
"untagId": 1,
"vlanMembers": "string"
}
],
"model": "string",
"poeMode": "Auto",
"poeOut": false
}
]

Update Venue LAN-Ports Deprecated

Update a venue LAN-port settings. The settings are defined per AP model.

path Parameters

venueId

required

string

Venue ID

Request Body schema: application/json
required

Array

	Array of objects (Wi-Fi_API_and_Model_Documentation_VenueLanPort)
model	string [ 0 .. 64 ] characters
poeMode	string Enum: "Auto" "802.3af" "802.3at" "802.3bt-Class_5" "802.3bt-Class_6" "802.3bt-Class_7" "802.3bt-Class_8"
poeOut	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

[{"lanPorts": [{"enabled": true,
"portId": "string",
"type": "ACCESS",
"untagId": 1,
"vlanMembers": "string"
}
],
"model": "string",
"poeMode": "Auto",
"poeOut": false
}
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue LED Deprecated

Get venue LED settings. The settings are defined per AP model.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

[{"ledEnabled": false,
"model": "string"
}
]

Update Venue LED Deprecated

Update venue LED settings. The settings are defined per AP model.

path Parameters

venueId

required

string

Venue ID

Request Body schema: application/json
required

Array

ledEnabled	boolean Default: false
model	string [ 0 .. 64 ] characters

Responses

Request samples

Payload

Content type

application/json

[{"ledEnabled": false,
"model": "string"
}
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Load Balancing Settings Deprecated

Get load balancing settings for this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"bandBalancingClientPercent24G": 25,
"bandBalancingEnabled": true,
"enabled": false,
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"steeringMode": "BASIC"
}

Update Venue Load Balancing Settings Deprecated

Update venue load balancing settings of this venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema: application/json
required

bandBalancingClientPercent24G	integer <int32> [ 0 .. 100 ] Default: 25
bandBalancingEnabled	boolean Default: true
enabled	boolean Default: false
loadBalancingMethod	string Default: "LoadBalancingMethodEnum.BASED_ON_CLIENT_COUNT" Enum: "BASED_ON_CLIENT_COUNT" "BASED_ON_CAPACITY"
steeringMode	string Default: "SteeringModeEnum.BASIC" Enum: "BASIC" "PROACTIVE" "STRICT"

Responses

Request samples

Payload

Content type

application/json

{"bandBalancingClientPercent24G": 25,
"bandBalancingEnabled": true,
"enabled": false,
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"steeringMode": "BASIC"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Multicast DNS Fencing Settings Deprecated

Get this venue's multicast DNS fencing settings.

path Parameters

venueId

required

string

Responses

Response samples

Content type

application/json

{"enabled": false,
"services": [{"customMappingEnabled": false,
"customServiceName": "string",
"customStrings": ["string"
],
"description": "string",
"service": "AIRDISK",
"wiredEnabled": false,
"wiredRules": [{"closestApMac": "string",
"deviceMacAddresses": ["string"
],
"fencingRange": "SAME_AP",
"name": "string"
}
],
"wirelessEnabled": false,
"wirelessRule": {"fencingRange": "SAME_AP"
}
}
]
}

Update Multicast DNS Fencing Settings Deprecated

Update this venue's multicast DNS fencing settings.

path Parameters

venueId

required

string

Request Body schema: application/json
required

enabled	boolean Default: false
	Array of objects (Wi-Fi_API_and_Model_Documentation_MdnsFencing)

Responses

Request samples

Payload

Content type

application/json

{"enabled": false,
"services": [{"customMappingEnabled": false,
"customServiceName": "string",
"customStrings": ["string"
],
"description": "string",
"service": "AIRDISK",
"wiredEnabled": false,
"wiredRules": [{"closestApMac": "string",
"deviceMacAddresses": ["string"
],
"fencingRange": "SAME_AP",
"name": "string"
}
],
"wirelessEnabled": false,
"wirelessRule": {"fencingRange": "SAME_AP"
}
}
]
}

Response samples

Content type

application/json

{"requestId": "string"
}

Update Mesh Deprecated

Enable/disable the venue mesh.

path Parameters

venueId

required

string

Venue ID

Request Body schema: application/json
required

enabled	boolean Default: false
passphrase	string(^[!-~]([ -~]){6,61}[!-~]$)\|(^([0-9a-fA-F]){6...
radioType	string Default: "MeshRadioTypeEnum._5_GHz" Enum: "2.4-GHz" "5-GHz"
ssid	string(^(?!.*(\$\(\|`))(([!-~]([ -~]){0,30}[!-~]$)\|(...

Responses

Request samples

Payload

Content type

application/json

{"enabled": false,
"passphrase": "string",
"radioType": "2.4-GHz",
"ssid": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Reset Venue Radio Deprecated

Reset venue radio to default values.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Radio Deprecated

Get the venue radio.

path Parameters

venueId

required

string

Venue ID

query Parameters

defaultOnly

boolean

Default: false

Only get the details of default radio settings in this venue.

Responses

Response samples

Content type

application/json

{"radioParams24G": {"allowedChannels": ["1"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParams50G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"combineChannels": false,
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParams6G": {"allowedChannels": ["1"
],
"bssMinRate6G": "HE_MCS_0",
"changeInterval": 33,
"channelBandwidth": "AUTO",
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastUplinkRateLimiting": false,
"method": "MANUAL",
"mgmtTxRate6G": "6",
"multicastDownlinkRateLimiting": 1,
"multicastUplinkRateLimiting": 1,
"scanInterval": 10,
"txPower": "MAX"
},
"radioParamsDual5G": {"enabled": false,
"inheritParamsLower5G": true,
"inheritParamsUpper5G": true,
"radioParamsLower5G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParamsUpper5G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
}
}
}

Update Venue Radio Deprecated

Update the venue radio.

path Parameters

venueId

required

string

Venue ID

Request Body schema: application/json
required

	object (Wi-Fi_API_and_Model_Documentation_RadioParams24G) Radio customization for 2.4GHz.
	object (Wi-Fi_API_and_Model_Documentation_RadioParams50G) Radio customization for 5GHz.
	object (Wi-Fi_API_and_Model_Documentation_RadioParams6G) Radio customization for 6GHz.
	object (Wi-Fi_API_and_Model_Documentation_RadioParamsDual5G) Radio customization for dual 5GHz radios.

Responses

Request samples

Payload

Content type

application/json

{"radioParams24G": {"allowedChannels": ["1"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParams50G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"combineChannels": false,
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParams6G": {"allowedChannels": ["1"
],
"bssMinRate6G": "HE_MCS_0",
"changeInterval": 33,
"channelBandwidth": "AUTO",
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastUplinkRateLimiting": false,
"mgmtTxRate6G": "6",
"multicastDownlinkRateLimiting": 1,
"multicastUplinkRateLimiting": 1,
"scanInterval": 10,
"txPower": "MAX"
},
"radioParamsDual5G": {"enabled": false,
"inheritParamsLower5G": true,
"inheritParamsUpper5G": true,
"radioParamsLower5G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParamsUpper5G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
}
}
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue RADIUS Options Settings Deprecated

Get this venue's RADIUS options settings.

path Parameters

venueId

required

string

Responses

Response samples

Content type

application/json

{"calledStationIdType": "BSSID",
"nasIdDelimiter": "DASH",
"nasIdType": "USER",
"nasMaxRetry": 2,
"nasReconnectPrimaryMin": 5,
"nasRequestTimeoutSec": 3,
"overrideEnabled": false,
"singleSessionIdAccounting": false,
"userDefinedNasId": "string"
}

Update Venue RADIUS Options Settings Deprecated

Update this venue's RADIUS options settings.

path Parameters

venueId

required

string

Request Body schema: application/json
required

calledStationIdType	string Default: "CalledStationIdTypeEnum.BSSID" Enum: "BSSID" "AP_MAC" "NONE" "AP_GROUP"
nasIdDelimiter	string Default: "NasIdDelimiterEnum.DASH" Enum: "DASH" "COLON"
nasIdType	string Default: "NasIdTypeEnum.BSSID" Enum: "USER" "BSSID" "AP_MAC" "VENUE_NAME"
nasMaxRetry	integer <int32> [ 2 .. 10 ] Default: 2
nasReconnectPrimaryMin	integer <int32> [ 1 .. 300 ] Default: 5
nasRequestTimeoutSec	integer <int32> [ 2 .. 20 ] Default: 3
overrideEnabled	boolean Default: false
singleSessionIdAccounting	boolean Default: false
userDefinedNasId	string [ 2 .. 64 ] characters ^((?!`\|\$\()[ -~]){2,64}$

Responses

Request samples

Payload

Content type

application/json

{"calledStationIdType": "BSSID",
"nasIdDelimiter": "DASH",
"nasIdType": "USER",
"nasMaxRetry": 2,
"nasReconnectPrimaryMin": 5,
"nasRequestTimeoutSec": 3,
"overrideEnabled": false,
"singleSessionIdAccounting": false,
"userDefinedNasId": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Rogue AP Deprecated

Get the venue rogue AP settings. Use GET /venues/{venueId}/roguePolicySettings instead.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"enabled": false,
"reportThreshold": 0,
"roguePolicyId": "string"
}

Update Venue Rogue AP Deprecated

Update the venue rogue AP settings. Use PUT /venues/{venueId}/roguePolicySettings instead.

path Parameters

venueId

required

string

Venue ID

Request Body schema: application/json
required

enabled	boolean Default: false
reportThreshold	integer <int32> [ 0 .. 100 ] Default: 0
roguePolicyId	string

Responses

Request samples

Payload

Content type

application/json

{"enabled": false,
"reportThreshold": 0,
"roguePolicyId": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue AP SNMP Agent Settings Deprecated

Get AP SNMP settings for this venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"apSnmpAgentProfileId": "string",
"enableApSnmp": false
}

Update Venue AP SNMP Agent Settings Deprecated

Update AP SNMP settings of this venue.

path Parameters

venueId

required

string

Venue ID

Request Body schema: application/json
required

apSnmpAgentProfileId	string
enableApSnmp	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"apSnmpAgentProfileId": "string",
"enableApSnmp": false
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Syslog Server Profile Settings Deprecated

Get venue syslog server profile settings.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"enabled": false,
"serviceProfileId": "string"
}

Update Venue Syslog Server Profile Settings Deprecated

Update a venue syslog server profile settings.

path Parameters

venueId

required

string

Venue ID

Request Body schema: application/json
required

enabled	boolean Default: false
serviceProfileId	string

Responses

Request samples

Payload

Content type

application/json

{"enabled": false,
"serviceProfileId": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Reset Venue Syslog Deprecated

Reset venue syslog settings to default values.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Syslog Deprecated

Get the venue syslog settings.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"enabled": false,
"facility": "KEEP_ORIGINAL",
"flowLevel": "GENERAL_LOGS",
"port": 514,
"priority": "EMERGENCY",
"protocol": "TCP",
"secondaryPort": 514,
"secondaryProtocol": "TCP",
"secondaryServer": "string",
"server": "string"
}

Update Venue Syslog Deprecated

Update the venue syslog settings.

path Parameters

venueId

required

string

Venue ID

Request Body schema: application/json
required

enabled	boolean Default: false
facility	string Default: "FacilityEnum.KEEP_ORIGINAL" Enum: "KEEP_ORIGINAL" "LOCAL0" "LOCAL1" "LOCAL2" "LOCAL3" "LOCAL4" "LOCAL5" "LOCAL6" "LOCAL7"
flowLevel	string Default: "FlowLevelEnum.CLIENT_FLOW" Enum: "GENERAL_LOGS" "CLIENT_FLOW" "ALL"
port	integer <int32> [ 1 .. 65535 ] Default: 514
priority	string Default: "PriorityEnum.INFO" Enum: "EMERGENCY" "ALERT" "CRITICAL" "ERROR" "WARNING" "NOTICE" "INFO" "ALL"
protocol	string Default: "ProtocolEnum.UDP" Enum: "TCP" "UDP"
secondaryPort	integer <int32> [ 1 .. 65535 ] Default: 514
secondaryProtocol	string Default: "ProtocolEnum.TCP" Enum: "TCP" "UDP"
secondaryServer	string(^((22[0-3]\|2[0-1][0-9]\|1[0-9][0-9]\|[1-9][0-9...
server	string(^((22[0-3]\|2[0-1][0-9]\|1[0-9][0-9]\|[1-9][0-9...

Responses

Request samples

Payload

Content type

application/json

{"enabled": false,
"facility": "KEEP_ORIGINAL",
"flowLevel": "GENERAL_LOGS",
"port": 514,
"priority": "EMERGENCY",
"protocol": "TCP",
"secondaryPort": 514,
"secondaryProtocol": "TCP",
"secondaryServer": "string",
"server": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Available Channels

Get venue available channels.

path Parameters

venueId

required

string

Venue ID.

Responses

Response samples

Content type

application/json

{"2.4GChannels": {"20MHz": ["1"
],
"40MHz": ["1"
],
"auto": ["1"
]
},
"5GChannels": {"dfs": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoorForOutdoorAp": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"outdoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
}
},
"5GLowerChannels": {"dfs": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoorForOutdoorAp": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"outdoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
}
},
"5GUpperChannels": {"dfs": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"indoorForOutdoorAp": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
},
"outdoor": {"160MHz": ["36"
],
"20MHz": ["36"
],
"40MHz": ["36"
],
"80MHz": ["36"
],
"auto": ["36"
]
}
},
"6GChannels": {"160MHz": ["1"
],
"20MHz": ["1"
],
"40MHz": ["1"
],
"80MHz": ["1"
],
"auto": ["1"
],
"indoor": {"160MHz": ["1"
],
"20MHz": ["1"
],
"40MHz": ["1"
],
"80MHz": ["1"
],
"auto": ["1"
]
},
"outdoor": {"160MHz": ["1"
],
"20MHz": ["1"
],
"40MHz": ["1"
],
"80MHz": ["1"
],
"auto": ["1"
]
}
}
}

Get Venue Wi-Fi Settings Deprecated

Get the venue Wi-Fi details.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

{"apPassword": "string",
"apSnmpAgent": {"apSnmpAgentProfileId": "string",
"enableApSnmp": false
},
"bandBalancing": {"clientPercent24": 25,
"enabled": false
},
"bssColoring": {"bssColoringEnabled": true
},
"clientAdmissionControl": {"enable24G": false,
"enable50G": false,
"maxRadioLoad24G": 75,
"maxRadioLoad50G": 75,
"minClientCount24G": 10,
"minClientCount50G": 20,
"minClientThroughput24G": 0,
"minClientThroughput50G": 0
},
"countryCode": "string",
"denialOfServiceProtection": {"blockingPeriod": 60,
"checkPeriod": 30,
"enabled": false,
"failThreshold": 5
},
"dhcpServiceSetting": {"dhcpServiceAps": [{"dhcpIps": ["string"
],
"role": "PrimaryServer",
"serialNumber": "stringstring"
}
],
"dhcpServiceProfileIds": ["string"
],
"enableClientIsolationAllowlist": false,
"enabled": false,
"mode": "EnableOnEachAPs",
"wanPortSelectionMode": "Dynamic"
},
"directedMulticast": {"networkEnabled": true,
"wiredEnabled": true,
"wirelessEnabled": true
},
"enableClientIsolationAllowlist": false,
"id": "string",
"loadBalancing": {"bandBalancingClientPercent24G": 25,
"bandBalancingEnabled": true,
"enabled": false,
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"steeringMode": "BASIC"
},
"lteBandLockChannels": [{"band3G": ["string"
],
"band4G": ["string"
],
"region": "DOMAIN_1"
}
],
"mesh": {"enabled": false,
"passphrase": "string",
"radioType": "2.4-GHz",
"ssid": "string"
},
"radioCustomization": {"radioParams24G": {"allowedChannels": ["1"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParams50G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"combineChannels": false,
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParams6G": {"allowedChannels": ["1"
],
"bssMinRate6G": "HE_MCS_0",
"changeInterval": 33,
"channelBandwidth": "AUTO",
"enableMulticastDownlinkRateLimiting": false,
"enableMulticastUplinkRateLimiting": false,
"method": "MANUAL",
"mgmtTxRate6G": "6",
"multicastDownlinkRateLimiting": 1,
"multicastUplinkRateLimiting": 1,
"scanInterval": 10,
"txPower": "MAX"
},
"radioParamsDual5G": {"enabled": false,
"inheritParamsLower5G": true,
"inheritParamsUpper5G": true,
"radioParamsLower5G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
},
"radioParamsUpper5G": {"allowedIndoorChannels": ["36"
],
"allowedOutdoorChannels": ["36"
],
"changeInterval": 33,
"channelBandwidth": "AUTO",
"method": "MANUAL",
"scanInterval": 20,
"txPower": "Auto"
}
}
},
"rogueAp": {"enabled": false,
"reportThreshold": 0,
"roguePolicyId": "string"
},
"syslog": {"enabled": false,
"facility": "KEEP_ORIGINAL",
"flowLevel": "GENERAL_LOGS",
"port": 514,
"priority": "EMERGENCY",
"protocol": "TCP",
"secondaryPort": 514,
"secondaryProtocol": "TCP",
"secondaryServer": "string",
"server": "string"
},
"tenantId": "string",
"wifiFirmwareVersion": "string"
}

Tunnel Service Profile

Manage tunnel service profiles.

Add Tunnel Service Profile

Use this API command to create a new tunnel service profile.

Request Body schema:
application/json
required

ageTimeMinutes	integer <int32> [ 5 .. 10080 ] Default: 20
forceFragmentation	boolean Default: false
keepAliveInterval	integer <int32> [ 1 .. 5 ] Default: 2 The unit is seconds.
keepAliveRetry	integer <int32> [ 3 .. 10 ] Default: 5
mtuRequestRetry	integer <int32> [ 3 .. 64 ] This setting is only effective in path maximum transmission unit auto mode.
mtuRequestTimeout	integer <int32> [ 10 .. 10000 ] The unit is milliseconds. This setting is only effective in path maximum transmission unit auto mode.
mtuSize	integer <int32> [ 576 .. 1450 ]
mtuType	string Default: "TunnelMtuTypeEnum.AUTO" Enum: "MANUAL" "AUTO"
name required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
tag	string
type	string Default: "TunnelTypeEnum.VXLAN" Enum: "VXLAN" "VLAN_VXLAN" Network segment type.

Responses

Request samples

Payload

Content type

application/json

{"ageTimeMinutes": 20,
"forceFragmentation": false,
"keepAliveInterval": 2,
"keepAliveRetry": 5,
"mtuRequestRetry": 3,
"mtuRequestTimeout": 10,
"mtuSize": 576,
"mtuType": "MANUAL",
"name": "string",
"tag": "string",
"type": "VXLAN"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"id": "string"
}
}

Delete Tunnel Service Profile

Use this API command to delete a tunnel service profile.

path Parameters

tunnelServiceProfileId

required

string

Tunnel Service Profile ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Tunnel Service Profile

Use this API command to get the tunnel service profile details.

path Parameters

tunnelServiceProfileId

required

string

Tunnel Service Profile ID

Responses

Response samples

Content type

application/json

{"ageTimeMinutes": 20,
"forceFragmentation": false,
"id": "string",
"keepAliveInterval": 2,
"keepAliveRetry": 5,
"mtuRequestRetry": 3,
"mtuRequestTimeout": 10,
"mtuSize": 576,
"mtuType": "MANUAL",
"name": "string",
"tag": "string",
"type": "VXLAN"
}

Partial Update Tunnel Service Profile

Use this API command to partial update a tunnel service profile.

path Parameters

tunnelServiceProfileId

required

string

Tunnel Service Profile ID

Request Body schema:
application/json
required

ageTimeMinutes	integer <int32> [ 5 .. 10080 ] Default: 20
forceFragmentation	boolean Default: false
keepAliveInterval	integer <int32> [ 1 .. 5 ] Default: 2 The unit is seconds.
keepAliveRetry	integer <int32> [ 3 .. 10 ] Default: 5
mtuRequestRetry	integer <int32> [ 3 .. 64 ] This setting is only effective in path maximum transmission unit auto mode.
mtuRequestTimeout	integer <int32> [ 10 .. 10000 ] The unit is milliseconds. This setting is only effective in path maximum transmission unit auto mode.
mtuSize	integer <int32> [ 576 .. 1450 ]
mtuType	string Default: "TunnelMtuTypeEnum.AUTO" Enum: "MANUAL" "AUTO"
name required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
tag	string
type	string Default: "TunnelTypeEnum.VXLAN" Enum: "VXLAN" "VLAN_VXLAN" Network segment type.

Responses

Request samples

Payload

Content type

application/json

{"ageTimeMinutes": 20,
"forceFragmentation": false,
"keepAliveInterval": 2,
"keepAliveRetry": 5,
"mtuRequestRetry": 3,
"mtuRequestTimeout": 10,
"mtuSize": 576,
"mtuType": "MANUAL",
"name": "string",
"tag": "string",
"type": "VXLAN"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Update Tunnel Service Profile

Use this API command to update a tunnel service profile.

path Parameters

tunnelServiceProfileId

required

string

Tunnel Service Profile ID

Request Body schema:
application/json
required

ageTimeMinutes	integer <int32> [ 5 .. 10080 ] Default: 20
forceFragmentation	boolean Default: false
keepAliveInterval	integer <int32> [ 1 .. 5 ] Default: 2 The unit is seconds.
keepAliveRetry	integer <int32> [ 3 .. 10 ] Default: 5
mtuRequestRetry	integer <int32> [ 3 .. 64 ] This setting is only effective in path maximum transmission unit auto mode.
mtuRequestTimeout	integer <int32> [ 10 .. 10000 ] The unit is milliseconds. This setting is only effective in path maximum transmission unit auto mode.
mtuSize	integer <int32> [ 576 .. 1450 ]
mtuType	string Default: "TunnelMtuTypeEnum.AUTO" Enum: "MANUAL" "AUTO"
name required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
tag	string
type	string Default: "TunnelTypeEnum.VXLAN" Enum: "VXLAN" "VLAN_VXLAN" Network segment type.

Responses

Request samples

Payload

Content type

application/json

{"ageTimeMinutes": 20,
"forceFragmentation": false,
"keepAliveInterval": 2,
"keepAliveRetry": 5,
"mtuRequestRetry": 3,
"mtuRequestTimeout": 10,
"mtuSize": 576,
"mtuType": "MANUAL",
"name": "string",
"tag": "string",
"type": "VXLAN"
}

Response samples

Content type

application/json

{"requestId": "string"
}

L2ACL Policy

Manage layer-2 ACL policy profiles.

Deactivate Layer-2 ACL Policy On Access Control Profile

Deactivate layer-2 ACL policy on access control profile.

path Parameters

accessControlProfileId required	string Access Control Profile ID
l2AclPolicyId required	string L2Acl Policy ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/l2AclPolicies/{l2AclPolicyId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/l2AclPolicies/{l2AclPolicyId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/l2AclPolicies/{l2AclPolicyId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Layer-2 ACL Policy On Access Control Profile

Activate layer-2 ACL policy on access control profile.

path Parameters

accessControlProfileId required	string Access Control Profile ID
l2AclPolicyId required	string L2Acl Policy ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/l2AclPolicies/{l2AclPolicyId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/l2AclPolicies/{l2AclPolicyId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/l2AclPolicies/{l2AclPolicyId}

Response samples

Content type

application/json

{"requestId": "string"
}

Delete Layer-2 ACL Policies. Deprecated

Delete layer-2 ACL policies.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Layer-2 ACL Policies. Deprecated

Get layer-2 ACL policy collection.

Responses

Response samples

Content type

application/json

[{"access": "ALLOW",
"description": "string",
"id": "string",
"macAddresses": ["string"
],
"name": "string"
}
]

Add Layer-2 ACL

Add layer-2 ACL by policy. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Request Body schema:
application/json
required

access	string Default: "AccessEnum.BLOCK" Enum: "ALLOW" "BLOCK"
description	string
macAddresses required	Array of strings [ 1 .. 128 ] items [ items [ 1 .. 128 ] characters ]
name required	string [ 2 .. 32 ] characters

Responses

Request samples

Payload

Content type

application/json

{"access": "ALLOW",
"description": "string",
"macAddresses": ["string"
],
"name": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"access": "ALLOW",
"description": "string",
"id": "string",
"macAddresses": ["string"
],
"name": "string"
}
}

Delete Layer-2 ACL

Delete layer-2 ACL by policy id. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

l2AclPolicyId

required

string

L2Acl Policy ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Layer-2 ACL

Get layer-2 ACL by policy id.

path Parameters

l2AclPolicyId

required

string

L2Acl Policy ID

Responses

Response samples

Content type

application/json

{"access": "ALLOW",
"description": "string",
"id": "string",
"macAddresses": ["string"
],
"name": "string"
}

Update Layer-2 ACL

Update layer-2 ACL by policy id. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

l2AclPolicyId

required

string

L2Acl Policy ID

Request Body schema:
application/json
required

access	string Default: "AccessEnum.BLOCK" Enum: "ALLOW" "BLOCK"
description	string
macAddresses required	Array of strings [ 1 .. 128 ] items [ items [ 1 .. 128 ] characters ]
name required	string [ 2 .. 32 ] characters

Responses

Request samples

Payload

Content type

application/json

{"access": "ALLOW",
"description": "string",
"macAddresses": ["string"
],
"name": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate Layer-2 ACL Policy On Wi-Fi Network

Deactivate layer-2 ACL policy on Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
l2AclPolicyId required	string L2Acl Policy ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Layer-2 ACL Policy On Wi-Fi Network

Activate layer-2 ACL policy on Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
l2AclPolicyId required	string L2Acl Policy ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

SNMP Agent Profile

Manage SNMP agent profiles.

Create SNMP Agent Profile

Create a new SNMP agent profile.

Request Body schema:
application/json
required

name required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
	Array of objects (Wi-Fi_API_and_Model_Documentation_SnmpV2Agent) [ 0 .. 2 ] items
	Array of objects (Wi-Fi_API_and_Model_Documentation_SnmpV3AgentV1_1) [ 0 .. 2 ] items

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"snmpV2Agents": [{"communityName": "string",
"notificationPrivilege": false,
"notificationSettings": {"targetIpAddress": "string",
"targetPort": 162,
"type": "TRAP"
},
"readOnlyPrivilege": false
}
],
"snmpV3Agents": [{"authenticationPassphrase": "stringst",
"authenticationType": "SHA",
"notificationPrivilege": false,
"notificationSettings": {"targetIpAddress": "string",
"targetPort": 162,
"type": "TRAP"
},
"privacyPassphrase": "stringst",
"privacyType": "NONE",
"readOnlyPrivilege": false,
"userName": "string"
}
]
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"id": "string"
}
}

Delete SNMP Agent Profile

Delete a SNMP agent profile.

path Parameters

snmpAgentProfileId

required

string

SNMP Agent Profile ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get SNMP Agent Profile

Get the details for this SNMP agent profile.

path Parameters

snmpAgentProfileId

required

string

SNMP Agent Profile ID

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"snmpV2Agents": [{"communityName": "string",
"notificationPrivilege": false,
"notificationSettings": {"targetIpAddress": "string",
"targetPort": 162,
"type": "TRAP"
},
"readOnlyPrivilege": false
}
],
"snmpV3Agents": [{"authenticationPassphrase": "stringst",
"authenticationType": "SHA",
"notificationPrivilege": false,
"notificationSettings": {"targetIpAddress": "string",
"targetPort": 162,
"type": "TRAP"
},
"privacyPassphrase": "stringst",
"privacyType": "NONE",
"readOnlyPrivilege": false,
"userName": "string"
}
]
}

Update SNMP Agent Profile

Update a SNMP agent profile.

path Parameters

snmpAgentProfileId

required

string

SNMP Agent Profile ID

Request Body schema:
application/json
required

name required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$
	Array of objects (Wi-Fi_API_and_Model_Documentation_SnmpV2Agent) [ 0 .. 2 ] items
	Array of objects (Wi-Fi_API_and_Model_Documentation_SnmpV3AgentV1_1) [ 0 .. 2 ] items

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"snmpV2Agents": [{"communityName": "string",
"notificationPrivilege": false,
"notificationSettings": {"targetIpAddress": "string",
"targetPort": 162,
"type": "TRAP"
},
"readOnlyPrivilege": false
}
],
"snmpV3Agents": [{"authenticationPassphrase": "stringst",
"authenticationType": "SHA",
"notificationPrivilege": false,
"notificationSettings": {"targetIpAddress": "string",
"targetPort": 162,
"type": "TRAP"
},
"privacyPassphrase": "stringst",
"privacyType": "NONE",
"readOnlyPrivilege": false,
"userName": "string"
}
]
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get SNMP Agent Profile Settings On AP

Get the SNMP agent profile settings on AP.

path Parameters

venueId required	string Venue ID
serialNumber required	string The serial number of the AP.

Responses

Response samples

Content type

application/json

{"useVenueSettings": true
}

Update SNMP Agent Profile Settings On AP

Update the SNMP agent profile settings on AP.

path Parameters

venueId required	string Venue ID
serialNumber required	string The serial number of the AP.

Request Body schema:
application/json
required

useVenueSettings

boolean

Default: true

Responses

Request samples

Payload

Content type

application/json

{"useVenueSettings": true
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate SNMP Agent Profile On AP

Deactivate the SNMP agent profile on the AP with the venue.

path Parameters

venueId required	string Venue ID
serialNumber required	string The serial number of the AP.
snmpAgentProfileId required	string SNMP Agent Profile ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/snmpAgentProfiles/{snmpAgentProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/snmpAgentProfiles/{snmpAgentProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/snmpAgentProfiles/{snmpAgentProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate SNMP Agent Profile On AP

Activate the SNMP agent profile on the AP with the venue.

path Parameters

venueId required	string Venue ID
serialNumber required	string The serial number of the AP.
snmpAgentProfileId required	string SNMP Agent Profile ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/snmpAgentProfiles/{snmpAgentProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/snmpAgentProfiles/{snmpAgentProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/aps/{serialNumber}/snmpAgentProfiles/{snmpAgentProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate SNMP Agent Profile On Venue

Deactivate the SNMP agent profile on the venue.

path Parameters

venueId required	string Venue ID
snmpAgentProfileId required	string SNMP Agent Profile ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Activate SNMP Agent Profile On Venue

Activate the SNMP agent profile on the venue.

path Parameters

venueId required	string Venue ID
snmpAgentProfileId required	string SNMP Agent Profile ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Device Policy

Manage device policies.

Deactivate Device Policy On Access Control Profile

Use this API command to delete a relationship between device policy and access control profile.

path Parameters

accessControlProfileId required	string Access Control Profile ID
devicePolicyId required	string Device Policy ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/devicePolicies/{devicePolicyId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/devicePolicies/{devicePolicyId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/devicePolicies/{devicePolicyId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Device Policy On Access Control Profile

Use this API command to build a relationship between device policy and access control profile.

path Parameters

accessControlProfileId required	string Access Control Profile ID
devicePolicyId required	string Device Policy ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/devicePolicies/{devicePolicyId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/devicePolicies/{devicePolicyId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/accessControlProfiles/{accessControlProfileId}/devicePolicies/{devicePolicyId}

Response samples

Content type

application/json

{"requestId": "string"
}

Delete Device-Policies Deprecated

Delete a list of device-policies.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get All Device Policies Deprecated

Get the device-policy collection.

Responses

Response samples

Content type

application/json

[{"defaultAccess": "ALLOW",
"description": "string",
"id": "string",
"name": "string",
"rules": [{"action": "ALLOW",
"deviceType": "Laptop",
"downloadRateLimit": 200,
"name": "string",
"osVendor": "All",
"uploadRateLimit": 200,
"vlan": 1
}
],
"tenantId": "string"
}
]

Create Device-Policy

Create a new device-policy. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Request Body schema:
application/json
required

defaultAccess	string Default: "AccessEnum.ALLOW" Enum: "ALLOW" "BLOCK"
description	string [ 2 .. 180 ] characters
name required	string [ 2 .. 32 ] characters
	Array of objects (Wi-Fi_API_and_Model_Documentation_DevicePolicyRule) [ 1 .. 32 ] items

Responses

Request samples

Payload

Content type

application/json

{"defaultAccess": "ALLOW",
"description": "string",
"name": "string",
"rules": [{"action": "ALLOW",
"deviceType": "Laptop",
"downloadRateLimit": 200,
"name": "string",
"osVendor": "All",
"uploadRateLimit": 200,
"vlan": 1
}
]
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"defaultAccess": "ALLOW",
"description": "string",
"id": "string",
"name": "string",
"rules": [{"action": "ALLOW",
"deviceType": "Laptop",
"downloadRateLimit": 200,
"name": "string",
"osVendor": "All",
"uploadRateLimit": 200,
"vlan": 1
}
],
"tenantId": "string"
}
}

Delete Device-Policy

Delete a device-policy. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

devicePolicyId

required

string

Device-policy ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Device-Policy

Get the device-policy details.

path Parameters

devicePolicyId

required

string

Device-policy ID

Responses

Response samples

Content type

application/json

{"defaultAccess": "ALLOW",
"description": "string",
"id": "string",
"name": "string",
"rules": [{"action": "ALLOW",
"deviceType": "Laptop",
"downloadRateLimit": 200,
"name": "string",
"osVendor": "All",
"uploadRateLimit": 200,
"vlan": 1
}
],
"tenantId": "string"
}

Update Device-Policy

Update a device-policy. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters

devicePolicyId

required

string

Device-policy ID

Request Body schema:
application/json
required

defaultAccess	string Default: "AccessEnum.ALLOW" Enum: "ALLOW" "BLOCK"
description	string [ 2 .. 180 ] characters
name required	string [ 2 .. 32 ] characters
	Array of objects (Wi-Fi_API_and_Model_Documentation_DevicePolicyRule) [ 1 .. 32 ] items

Responses

Request samples

Payload

Content type

application/json

{"defaultAccess": "ALLOW",
"description": "string",
"name": "string",
"rules": [{"action": "ALLOW",
"deviceType": "Laptop",
"downloadRateLimit": 200,
"name": "string",
"osVendor": "All",
"uploadRateLimit": 200,
"vlan": 1
}
]
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate Device Policy On Wi-Fi Network

Use this API command to delete a relationship between device policy and Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
policyId required	string Device Policy ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Device Policy On Wi-Fi Network

Use this API command to build a relationship between device policy and Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
policyId required	string Device Policy ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Hotspot 2.0 Identity Provider

Manage Hotspot 2.0 Identity Providers.

Add Hotspot 2.0 Identity Provider

Add a Hotspot 2.0 identity provider.

Request Body schema:
application/json
required

accountingRadiusEnabled	boolean Default: false
required	Array of objects (Wi-Fi_API_and_Model_Documentation_Hotspot20NaiRealm) [ 1 .. 16 ] items
name required	string [ 2 .. 32 ] characters
	Array of objects (Wi-Fi_API_and_Model_Documentation_Hotspot20Plmn) [ 0 .. 16 ] items
	Array of objects (Wi-Fi_API_and_Model_Documentation_Hotspot20RoamConsortium) [ 0 .. 12 ] items

Responses

Request samples

Payload

Content type

application/json

{"accountingRadiusEnabled": false,
"naiRealms": [{"eaps": [{"authInfos": [{"credentialType": "SIM",
"eapInnerAuth": "EAP_TLS",
"info": "Expanded",
"nonEapAuth": "PAP",
"tunneledType": "SIM",
"vendorId": "string",
"vendorType": "string"
}
],
"method": "MD5"
}
],
"encoding": "RFC4282",
"name": "string"
}
],
"name": "string",
"plmns": [{"mcc": "string",
"mnc": "string"
}
],
"roamConsortiumOIs": [{"name": "string",
"organizationId": "string"
}
]
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"id": "string"
}
}

Delete Hotspot 2.0 Identity Provider

Delete a Hotspot 2.0 identity provider.

path Parameters

hotspot20IdentityProviderId

required

string

Hotspot 2.0 Identity Provider ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Hotspot 2.0 Identity Provider

Get a Hotspot 2.0 identity provider.

path Parameters

hotspot20IdentityProviderId

required

string

Hotspot 2.0 Identity Provider ID

Responses

Response samples

Content type

application/json

{"accountingRadiusEnabled": false,
"id": "string",
"naiRealms": [{"eaps": [{"authInfos": [{"credentialType": "SIM",
"eapInnerAuth": "EAP_TLS",
"info": "Expanded",
"nonEapAuth": "PAP",
"tunneledType": "SIM",
"vendorId": "string",
"vendorType": "string"
}
],
"method": "MD5"
}
],
"encoding": "RFC4282",
"name": "string"
}
],
"name": "string",
"plmns": [{"mcc": "string",
"mnc": "string"
}
],
"roamConsortiumOIs": [{"name": "string",
"organizationId": "string"
}
]
}

Update Hotspot 2.0 Identity Provider

Update a Hotspot 2.0 identity provider.

path Parameters

hotspot20IdentityProviderId

required

string

Hotspot 2.0 Identity Provider ID

Request Body schema:
application/json
required

accountingRadiusEnabled	boolean Default: false
required	Array of objects (Wi-Fi_API_and_Model_Documentation_Hotspot20NaiRealm) [ 1 .. 16 ] items
name required	string [ 2 .. 32 ] characters
	Array of objects (Wi-Fi_API_and_Model_Documentation_Hotspot20Plmn) [ 0 .. 16 ] items
	Array of objects (Wi-Fi_API_and_Model_Documentation_Hotspot20RoamConsortium) [ 0 .. 12 ] items

Responses

Request samples

Payload

Content type

application/json

{"accountingRadiusEnabled": false,
"naiRealms": [{"eaps": [{"authInfos": [{"credentialType": "SIM",
"eapInnerAuth": "EAP_TLS",
"info": "Expanded",
"nonEapAuth": "PAP",
"tunneledType": "SIM",
"vendorId": "string",
"vendorType": "string"
}
],
"method": "MD5"
}
],
"encoding": "RFC4282",
"name": "string"
}
],
"name": "string",
"plmns": [{"mcc": "string",
"mnc": "string"
}
],
"roamConsortiumOIs": [{"name": "string",
"organizationId": "string"
}
]
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate Hotspot 2.0 Identity Provider On Wi-Fi Network

Deactivate Hotspot 2.0 identity provider on Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
hotspot20IdentityProviderId required	string Hotspot 2.0 Identity Provider ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/wifiNetworks/{wifiNetworkId}/hotspot20IdentityProviders/{hotspot20IdentityProviderId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/wifiNetworks/{wifiNetworkId}/hotspot20IdentityProviders/{hotspot20IdentityProviderId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/wifiNetworks/{wifiNetworkId}/hotspot20IdentityProviders/{hotspot20IdentityProviderId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Hotspot 2.0 Identity Provider On Wi-Fi Network

Activate Hotspot 2.0 identity provider on Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
hotspot20IdentityProviderId required	string Hotspot 2.0 Identity Provider ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/wifiNetworks/{wifiNetworkId}/hotspot20IdentityProviders/{hotspot20IdentityProviderId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/wifiNetworks/{wifiNetworkId}/hotspot20IdentityProviders/{hotspot20IdentityProviderId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/wifiNetworks/{wifiNetworkId}/hotspot20IdentityProviders/{hotspot20IdentityProviderId}

Response samples

Content type

application/json

{"requestId": "string"
}

MDNS Proxy Service Profile

Manage Multicast DNS proxy service profiles.

Delete Multicast DNS Proxy Service Profiles Deprecated

Delete a list of multicast DNS proxy service profiles.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Multicast DNS Proxy Service Profiles Deprecated

Get the multicast DNS proxy service profiles.

Responses

Response samples

Content type

application/json

[{"aps": [{"serialNumber": "string",
"venueId": "string"
}
],
"id": "string",
"rules": [{"enabled": true,
"fromVlan": 1,
"mdnsName": "string",
"mdnsProtocol": "TCP",
"service": "AIRDISK",
"toVlan": 1
}
],
"serviceName": "string"
}
]

Create Multicast DNS Proxy Service Profile Deprecated

Create a new multicast DNS proxy service profile.

Request Body schema: application/json
required

aps	Array of strings
	Array of objects (Wi-Fi_API_and_Model_Documentation_MulticastDnsProxyServiceRule)
serviceName required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Payload

Content type

application/json

{"aps": ["string"
],
"rules": [{"enabled": true,
"fromVlan": 1,
"mdnsName": "string",
"mdnsProtocol": "TCP",
"service": "AIRDISK",
"toVlan": 1
}
],
"serviceName": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Delete Multicast DNS Proxy Service Profile Deprecated

Delete a multicast DNS proxy service profile.

path Parameters

mDnsProxyProfileId

required

string

Multicast DNS Proxy Service Profile ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Multicast DNS Proxy Service Profile Deprecated

Get the multicast DNS proxy service profile details.

path Parameters

mDnsProxyProfileId

required

string

Multicast DNS Proxy profile ID

Responses

Response samples

Content type

application/json

{"aps": [{"serialNumber": "string",
"venueId": "string"
}
],
"id": "string",
"rules": [{"enabled": true,
"fromVlan": 1,
"mdnsName": "string",
"mdnsProtocol": "TCP",
"service": "AIRDISK",
"toVlan": 1
}
],
"serviceName": "string"
}

Update Multicast DNS Proxy Service Profile Deprecated

Update a multicast DNS proxy service profile.

path Parameters

mDnsProxyProfileId

required

string

Multicast DNS Proxy Service Profile ID

Request Body schema: application/json
required

aps	Array of strings
	Array of objects (Wi-Fi_API_and_Model_Documentation_MulticastDnsProxyServiceRule)
serviceName required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Payload

Content type

application/json

{"aps": ["string"
],
"rules": [{"enabled": true,
"fromVlan": 1,
"mdnsName": "string",
"mdnsProtocol": "TCP",
"service": "AIRDISK",
"toVlan": 1
}
],
"serviceName": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate Multicast DNS Proxy Service Profile for APs Deprecated

Deactivate multicast DNS proxy service profile for APs.

path Parameters

mDnsProxyProfileId

required

string

Multicast DNS Proxy Service Profile ID

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Multicast DNS Proxy Service Profile for APs Deprecated

Activate multicast DNS proxy service profile for APs.

path Parameters

mDnsProxyProfileId

required

string

Multicast DNS Proxy Service Profile ID

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Create Multicast DNS Proxy Service Profile

Create a new multicast DNS proxy service profile.

Request Body schema:
application/json
required

	Array of objects (Wi-Fi_API_and_Model_Documentation_MulticastDnsProxyServiceRule)
serviceName required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Payload

Content type

application/json

{"rules": [{"enabled": true,
"fromVlan": 1,
"mdnsName": "string",
"mdnsProtocol": "TCP",
"service": "AIRDISK",
"toVlan": 1
}
],
"serviceName": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"id": "string"
}
}

Delete Multicast DNS Proxy Service Profile

Delete a multicast DNS proxy service profile.

path Parameters

multicastDnsProxyProfileId

required

string

Multicast DNS Proxy Profile ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Multicast DNS Proxy Service Profile

Get the multicast DNS proxy service profile details.

path Parameters

multicastDnsProxyProfileId

required

string

Multicast DNS Proxy profile ID

Responses

Response samples

Content type

application/json

{"id": "string",
"rules": [{"enabled": true,
"fromVlan": 1,
"mdnsName": "string",
"mdnsProtocol": "TCP",
"service": "AIRDISK",
"toVlan": 1
}
],
"serviceName": "string"
}

Update Multicast DNS Proxy Service Profile

Update a multicast DNS proxy service profile.

path Parameters

multicastDnsProxyProfileId

required

string

Multicast DNS Proxy Profile ID

Request Body schema:
application/json
required

	Array of objects (Wi-Fi_API_and_Model_Documentation_MulticastDnsProxyServiceRule)
serviceName required	string(?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Payload

Content type

application/json

{"rules": [{"enabled": true,
"fromVlan": 1,
"mdnsName": "string",
"mdnsProtocol": "TCP",
"service": "AIRDISK",
"toVlan": 1
}
],
"serviceName": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate Multicast DNS Proxy Service Profile On the AP

Deactivate multicast DNS proxy service profile on the AP.

path Parameters

venueId required	string Venue ID
apSerialNumber required	string The serial number of the AP.
multicastDnsProxyProfileId required	string Multicast DNS Proxy Profile ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/aps/{apSerialNumber}/multicastDnsProxyProfiles/{multicastDnsProxyProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/aps/{apSerialNumber}/multicastDnsProxyProfiles/{multicastDnsProxyProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/aps/{apSerialNumber}/multicastDnsProxyProfiles/{multicastDnsProxyProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Multicast DNS Proxy Service Profile On the AP

Activate multicast DNS proxy service profile on the AP.

path Parameters

venueId required	string Venue ID
apSerialNumber required	string The serial number of the AP.
multicastDnsProxyProfileId required	string Multicast DNS Proxy Profile ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/aps/{apSerialNumber}/multicastDnsProxyProfiles/{multicastDnsProxyProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/aps/{apSerialNumber}/multicastDnsProxyProfiles/{multicastDnsProxyProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/aps/{apSerialNumber}/multicastDnsProxyProfiles/{multicastDnsProxyProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Multicast DNS Proxy Service Profile APs by Venue Deprecated

Get multicast DNS proxy service profile APs detail by venue.

path Parameters

venueId

required

string

Venue ID

Responses

Response samples

Content type

application/json

[{"apName": "string",
"rules": [{"enabled": true,
"fromVlan": 1,
"mdnsName": "string",
"mdnsProtocol": "TCP",
"service": "AIRDISK",
"toVlan": 1
}
],
"serialNumber": "string",
"serviceId": "string",
"serviceName": "string",
"venueId": "string",
"venueName": "string"
}
]

SoftGRE Profile

Manage SoftGRE profiles.

Add SoftGRE Profile

Add a SoftGRE profile.

Request Body schema:
application/json
required

description	string [ 0 .. 64 ] characters
disassociateClientEnabled	boolean Default: false
keepAliveInterval	integer <int32> [ 1 .. 180 ] Default: 10
keepAliveRetryTimes	integer <int32> [ 2 .. 10 ] Default: 5
mtuSize	integer <int32> [ 850 .. 9018 ] The MTU size, it's required if the MTU type is manual.
mtuType	string Default: "TunnelMtuTypeEnum.AUTO" Enum: "MANUAL" "AUTO"
name required	string [ 2 .. 32 ] characters
primaryGatewayAddress required	string(^((22[0-3]\|2[0-1][0-9]\|1[0-9][0-9]\|[1-9][0-9...
secondaryGatewayAddress	string(^((22[0-3]\|2[0-1][0-9]\|1[0-9][0-9]\|[1-9][0-9...

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"disassociateClientEnabled": false,
"keepAliveInterval": 10,
"keepAliveRetryTimes": 5,
"mtuSize": 850,
"mtuType": "MANUAL",
"name": "string",
"primaryGatewayAddress": "string",
"secondaryGatewayAddress": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"id": "string"
}
}

Delete SoftGRE Profile

Delete the specified SoftGRE profile.

path Parameters

softGreProfileId

required

string

SoftGRE profile identity

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get SoftGRE Profile

Get a SoftGRE profile by profile identity.

path Parameters

softGreProfileId

required

string

SoftGRE profile identity

Responses

Response samples

Content type

application/json

{"description": "string",
"disassociateClientEnabled": false,
"id": "string",
"keepAliveInterval": 10,
"keepAliveRetryTimes": 5,
"mtuSize": 850,
"mtuType": "MANUAL",
"name": "string",
"primaryGatewayAddress": "string",
"secondaryGatewayAddress": "string"
}

Update SoftGRE Profile

Update the specified SoftGRE profile.

path Parameters

softGreProfileId

required

string

SoftGRE profile identity

Request Body schema:
application/json
required

description	string [ 0 .. 64 ] characters
disassociateClientEnabled	boolean Default: false
keepAliveInterval	integer <int32> [ 1 .. 180 ] Default: 10
keepAliveRetryTimes	integer <int32> [ 2 .. 10 ] Default: 5
mtuSize	integer <int32> [ 850 .. 9018 ] The MTU size, it's required if the MTU type is manual.
mtuType	string Default: "TunnelMtuTypeEnum.AUTO" Enum: "MANUAL" "AUTO"
name required	string [ 2 .. 32 ] characters
primaryGatewayAddress required	string(^((22[0-3]\|2[0-1][0-9]\|1[0-9][0-9]\|[1-9][0-9...
secondaryGatewayAddress	string(^((22[0-3]\|2[0-1][0-9]\|1[0-9][0-9]\|[1-9][0-9...

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"disassociateClientEnabled": false,
"keepAliveInterval": 10,
"keepAliveRetryTimes": 5,
"mtuSize": 850,
"mtuType": "MANUAL",
"name": "string",
"primaryGatewayAddress": "string",
"secondaryGatewayAddress": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate SoftGRE Profile On Venue Wi-Fi Network

Deactivate the SoftGRE profile on the Wi-Fi network with the venue.

path Parameters

venueId required	string Venue ID
wifiNetworkId required	string Wi-Fi Network ID
softGreProfileId required	string SoftGRE profile identity

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/softGreProfiles/{softGreProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/softGreProfiles/{softGreProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/softGreProfiles/{softGreProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate SoftGRE Profile On Venue Wi-Fi Network

Activate the SoftGRE profile on the Wi-Fi network with the venue.

path Parameters

venueId required	string Venue ID
wifiNetworkId required	string Wi-Fi Network ID
softGreProfileId required	string SoftGRE profile identity

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/softGreProfiles/{softGreProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/softGreProfiles/{softGreProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/softGreProfiles/{softGreProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

Client Isolation Allowlist

Manage client isolation allowlists.

Client isolation features, when enabled, prevent clients residing on a common VLAN from exchanging packets with each other. Client isolation is enforced by APs working at layer 2 (bridging). If client isolation is needed between VLANs/IP subnets, routers must also be configured to prevent packet exchange at layer 3. A client isolation allowlist provides the capability for administrators to configure exceptions to this isolation behavior. For example, an administrator may want to allow clients on a public network to access a printer in a common area of their venue. If so, the MAC and IP addresses of the printer (or any excepted device) can be configured on the client isolation allowlist.

Client isolation can be used in conjunction with walled gardens for public networks. Walled gardens provide limited access to services prior to client authentication whereas client isolation allowlists provide connectivity options post authentication.

Client isolation does not work when clients are assigned static IP addresses. For this reason, Ruckus recommends using DHCP lease reservations in lieu of static IP addresses when using this feature. Administrators may also want to consider use of the force DHCP option, available during wireless network configuration.

Complications to client isolation can arise when the VLAN's default gateway employs VRRP or HSRP for high availability or when Bonjour gateway is configured on the same WLAN as the allowlist. If either of these situations applies in your network, please contact Ruckus customer support for assistance.

Delete Isolation Allowlists Deprecated

Delete client isolation allowlists.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get Client Isolation Allowlists Deprecated

Get the client isolation allowlists.

Responses

Response samples

Content type

application/json

[{"allowlist": [{"description": "string",
"mac": "string"
}
],
"description": "string",
"id": "string",
"name": "string",
"tenantId": "string"
}
]

Create Client Isolation Allowlist Deprecated

Create a new client isolation allowlist.

Request Body schema: application/json
required

required	Array of objects (Wi-Fi_API_and_Model_Documentation_ClientIsolationAllowlistEntry) [ 1 .. 64 ] items
description	string [ 0 .. 64 ] characters
name required	string [ 2 .. 32 ] characters (?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Payload

Content type

application/json

{"allowlist": [{"description": "string",
"mac": "string"
}
],
"description": "string",
"name": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"allowlist": [{"description": "string",
"mac": "string"
}
],
"description": "string",
"id": "string",
"name": "string",
"tenantId": "string"
}
}

Delete Client Isolation Allowlist Deprecated

Delete this client isolation allowlist.

path Parameters

clientIsolationAllowlistId

required

string

Client Isolation Allowlist ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Client Isolation Allowlist Deprecated

Get the details for this client isolation allowlist.

path Parameters

clientIsolationAllowlistId

required

string

Client Isolation Allowlist ID

Responses

Response samples

Content type

application/json

{"allowlist": [{"description": "string",
"mac": "string"
}
],
"description": "string",
"id": "string",
"name": "string",
"tenantId": "string"
}

Update Client Isolation Allowlist Deprecated

Update this client isolation allowlist.

path Parameters

clientIsolationAllowlistId

required

string

Client Isolation Allowlist ID

Request Body schema: application/json
required

required	Array of objects (Wi-Fi_API_and_Model_Documentation_ClientIsolationAllowlistEntry) [ 1 .. 64 ] items
description	string [ 0 .. 64 ] characters
name required	string [ 2 .. 32 ] characters (?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Payload

Content type

application/json

{"allowlist": [{"description": "string",
"mac": "string"
}
],
"description": "string",
"name": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Venue Usage Deprecated

Get a list of venues of the client isolation allowlist.

path Parameters

clientIsolationAllowlistId

required

string

Client Isolation Allowlist ID

Request Body schema: application/json
required

page	integer <int32> Default: 1
pageSize	integer <int32> Default: 25
searchVenueNameString	string Search venue name
sortField	string Support venue name only
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"page": 1,
"pageSize": 25,
"searchVenueNameString": "string",
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

Content type

application/json

{"data": [{"address": "string",
"networkCount": 0,
"networkNames": ["string"
],
"venueId": "string",
"venueName": "string"
}
],
"fields": ["string"
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Client Isolation Profile

Manage client isolation profiles.

Client isolation features, when enabled, prevent clients residing on a common VLAN from exchanging packets with each other. Client isolation is enforced by APs working at layer 2 (bridging). If client isolation is needed between VLANs/IP subnets, routers must also be configured to prevent packet exchange at layer 3. A client isolation profile provides the capability for administrators to configure exceptions to this isolation behavior. For example, an administrator may want to allow clients on a public network to access a printer in a common area of their venue. If so, the MAC and IP addresses of the printer (or any excepted device) can be configured on the client isolation profile.

Client isolation can be used in conjunction with walled gardens for public networks. Walled gardens provide limited access to services prior to client authentication whereas client isolation profiles provide connectivity options post authentication.

Client isolation does not work when clients are assigned static IP addresses. For this reason, Ruckus recommends using DHCP lease reservations in lieu of static IP addresses when using this feature. Administrators may also want to consider use of the force DHCP option, available during wireless network configuration.

Complications to client isolation can arise when the VLAN's default gateway employs VRRP or HSRP for high availability or when Bonjour gateway is configured on the same WLAN as the profile. If either of these situations applies in your network, please contact Ruckus customer support for assistance.

Create Client Isolation Profile

Create a new client isolation profile.

Request Body schema:
application/json
required

required	Array of objects (Wi-Fi_API_and_Model_Documentation_ClientIsolationAllowlistEntry) [ 1 .. 64 ] items
description	string [ 0 .. 64 ] characters
name required	string [ 2 .. 32 ] characters (?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Payload

Content type

application/json

{"allowlist": [{"description": "string",
"mac": "string"
}
],
"description": "string",
"name": "string"
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"id": "string"
}
}

Delete Client Isolation Profile

Delete this client isolation profile.

path Parameters

clientIsolationProfileId

required

string

Client Isolation Profile ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Client Isolation Profile

Get the details for this client isolation profile.

path Parameters

clientIsolationProfileId

required

string

Client Isolation Profile ID

Responses

Response samples

Content type

application/json

{"allowlist": [{"description": "string",
"mac": "string"
}
],
"description": "string",
"id": "string",
"name": "string"
}

Update Client Isolation Profile

Update this client isolation profile.

path Parameters

clientIsolationProfileId

required

string

Client Isolation Profile ID

Request Body schema:
application/json
required

required	Array of objects (Wi-Fi_API_and_Model_Documentation_ClientIsolationAllowlistEntry) [ 1 .. 64 ] items
description	string [ 0 .. 64 ] characters
name required	string [ 2 .. 32 ] characters (?=^((?!(`\|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Payload

Content type

application/json

{"allowlist": [{"description": "string",
"mac": "string"
}
],
"description": "string",
"name": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate Client Isolation Profile On Wi-Fi Network

Deactivate the client isolation profile on the Wi-Fi network with the venue.

path Parameters

venueId required	string Venue ID
wifiNetworkId required	string Wi-Fi Network ID
clientIsolationProfileId required	string Client Isolation Profile ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/clientIsolationProfiles/{clientIsolationProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/clientIsolationProfiles/{clientIsolationProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/clientIsolationProfiles/{clientIsolationProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Client Isolation Profile On Wi-Fi Network

Activate the client isolation profile on the Wi-Fi network with the venue.

path Parameters

venueId required	string Venue ID
wifiNetworkId required	string Wi-Fi Network ID
clientIsolationProfileId required	string Client Isolation Profile ID

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/clientIsolationProfiles/{clientIsolationProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/clientIsolationProfiles/{clientIsolationProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/venues/{venueId}/wifiNetworks/{wifiNetworkId}/clientIsolationProfiles/{clientIsolationProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

Access Control Profile

Manage access control profiles.

Delete Multiple Access Control Profiles Deprecated

Delete multiple access control profiles by profile identities.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get All Access Control Profiles Deprecated

Get all access control profiles.

Responses

Response samples

Content type

application/json

[{"applicationPolicy": {"enabled": false,
"id": "string"
},
"description": "string",
"devicePolicy": {"enabled": false,
"id": "string"
},
"id": "string",
"l2AclPolicy": {"enabled": false,
"id": "string"
},
"l3AclPolicy": {"enabled": false,
"id": "string"
},
"name": "string",
"rateLimiting": {"downlinkLimit": 0,
"enabled": false,
"uplinkLimit": 0
}
}
]

Add Access Control Profile

Add an access control profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/9/1.

Request Body schema:
application/json
required

	object (Wi-Fi_API_and_Model_Documentation_IdAndEnabled) Profile ID and enabled
description	string [ 0 .. 64 ] characters
	object (Wi-Fi_API_and_Model_Documentation_IdAndEnabled) Profile ID and enabled
	object (Wi-Fi_API_and_Model_Documentation_IdAndEnabled) Profile ID and enabled
	object (Wi-Fi_API_and_Model_Documentation_IdAndEnabled) Profile ID and enabled
name required	string [ 2 .. 32 ] characters
	object (Wi-Fi_API_and_Model_Documentation_RateLimiting) Client traffic rate limiting

Responses

Request samples

Payload

Content type

application/json

{"applicationPolicy": {"enabled": false,
"id": "string"
},
"description": "string",
"devicePolicy": {"enabled": false,
"id": "string"
},
"l2AclPolicy": {"enabled": false,
"id": "string"
},
"l3AclPolicy": {"enabled": false,
"id": "string"
},
"name": "string",
"rateLimiting": {"downlinkLimit": 0,
"enabled": false,
"uplinkLimit": 0
}
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"applicationPolicy": {"enabled": false,
"id": "string"
},
"description": "string",
"devicePolicy": {"enabled": false,
"id": "string"
},
"id": "string",
"l2AclPolicy": {"enabled": false,
"id": "string"
},
"l3AclPolicy": {"enabled": false,
"id": "string"
},
"name": "string",
"rateLimiting": {"downlinkLimit": 0,
"enabled": false,
"uplinkLimit": 0
}
}
}

Delete Access Control Profile

Delete the specified access control profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/9/1.

path Parameters

accessControlProfileId

required

string

Access control profile identity

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get Access Control Profile

Get an access control profile by profile identity. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/9/1.

path Parameters

accessControlProfileId

required

string

Access control profile identity

Responses

Response samples

Content type

application/json

{"applicationPolicy": {"enabled": false,
"id": "string"
},
"description": "string",
"devicePolicy": {"enabled": false,
"id": "string"
},
"id": "string",
"l2AclPolicy": {"enabled": false,
"id": "string"
},
"l3AclPolicy": {"enabled": false,
"id": "string"
},
"name": "string",
"rateLimiting": {"downlinkLimit": 0,
"enabled": false,
"uplinkLimit": 0
}
}

Update Access Control Profile

Update the specified access control profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/9/1.

path Parameters

accessControlProfileId

required

string

Access control profile identity

Request Body schema:
application/json
required

	object (Wi-Fi_API_and_Model_Documentation_IdAndEnabled) Profile ID and enabled
description	string [ 0 .. 64 ] characters
	object (Wi-Fi_API_and_Model_Documentation_IdAndEnabled) Profile ID and enabled
	object (Wi-Fi_API_and_Model_Documentation_IdAndEnabled) Profile ID and enabled
	object (Wi-Fi_API_and_Model_Documentation_IdAndEnabled) Profile ID and enabled
name required	string [ 2 .. 32 ] characters
	object (Wi-Fi_API_and_Model_Documentation_RateLimiting) Client traffic rate limiting

Responses

Request samples

Payload

Content type

application/json

{"applicationPolicy": {"enabled": false,
"id": "string"
},
"description": "string",
"devicePolicy": {"enabled": false,
"id": "string"
},
"l2AclPolicy": {"enabled": false,
"id": "string"
},
"l3AclPolicy": {"enabled": false,
"id": "string"
},
"name": "string",
"rateLimiting": {"downlinkLimit": 0,
"enabled": false,
"uplinkLimit": 0
}
}

Response samples

Content type

application/json

{"requestId": "string"
}

Deactivate Access Control Profile On Wi-Fi Network

Use this API command to delete a relationship between access control profile and Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
accessControlProfileId required	string Access control profile identity

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/wifiNetworks/{wifiNetworkId}/accessControlProfiles/{accessControlProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/wifiNetworks/{wifiNetworkId}/accessControlProfiles/{accessControlProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/wifiNetworks/{wifiNetworkId}/accessControlProfiles/{accessControlProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

Activate Access Control Profile On Wi-Fi Network

Use this API command to build a relationship between access control profile and Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
accessControlProfileId required	string Access control profile identity

Responses

RUCKUS One API host for North American region.

https://api.ruckus.cloud/wifiNetworks/{wifiNetworkId}/accessControlProfiles/{accessControlProfileId}

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/wifiNetworks/{wifiNetworkId}/accessControlProfiles/{accessControlProfileId}

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/wifiNetworks/{wifiNetworkId}/accessControlProfiles/{accessControlProfileId}

Response samples

Content type

application/json

{"requestId": "string"
}

VLAN Pool

Manage VLAN pool profiles.

Delete VLAN Pools Deprecated

Use this API command to delete a VLAN pool list.

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"requestId": "string"
}

Get VLAN Pools Deprecated

Use this API command to get the VLAN pool list.

Responses

Response samples

Content type

application/json

[{"description": "string",
"id": "string",
"name": "string",
"tenantId": "string",
"vlanMembers": ["string"
]
}
]

Add VLAN Pool Deprecated

Use this API command to create a new VLAN pool.

Request Body schema: application/json
required

description	string [ 0 .. 64 ] characters
name required	string [ 1 .. 32 ] characters
vlanMembers required	Array of strings [ 0 .. 16 ] items [ items [ 0 .. 16 ] characters ]

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"vlanMembers": ["string"
]
}

Response samples

Content type

application/json

{"requestId": "string",
"response": {"description": "string",
"id": "string",
"name": "string",
"tenantId": "string",
"vlanMembers": ["string"
]
}
}

Query VLAN Pool Deprecated

Use this API command to get the VLAN pool list by query.

Request Body schema: application/json
required

fields	Array of strings
page	integer <int32> Default: 1
pageSize	integer <int32> Default: 25
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"page": 1,
"pageSize": 25,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

Content type

application/json

{"data": [{"description": "string",
"id": "string",
"name": "string",
"networksCount": 0,
"networksNames": ["string"
]
}
],
"fields": ["string"
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Delete VLAN Pool Deprecated

Use this API command to delete a VLAN pool.

path Parameters

vlanPoolId

required

string

VLAN Pool ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Get VLAN Pool Deprecated

Use this API command to get the VLAN pool details.

path Parameters

vlanPoolId

required

string

VLAN Pool ID

Responses

Response samples

Content type

application/json

{"description": "string",
"id": "string",
"name": "string",
"tenantId": "string",
"vlanMembers": ["string"
]
}

Partial Update VLAN Pool Deprecated

Use this API command to partial update a VLAN pool.

path Parameters

vlanPoolId

required

string

VLAN Pool ID

Request Body schema: application/json
required

description	string [ 0 .. 64 ] characters
name	string [ 1 .. 32 ] characters
vlanMembers	Array of strings [ 0 .. 16 ] items [ items [ 0 .. 16 ] characters ]

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"vlanMembers": ["string"
]
}

Response samples

Content type

application/json

{"requestId": "string"
}

Update VLAN Pool Deprecated

Use this API command to update a VLAN pool.

path Parameters

vlanPoolId

required

string

VLAN Pool ID

Request Body schema: application/json
required

description	string [ 0 .. 64 ] characters
name required	string [ 1 .. 32 ] characters
vlanMembers required	Array of strings [ 0 .. 16 ] items [ items [ 0 .. 16 ] characters ]

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"vlanMembers": ["string"
]
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get VLAN Pool Venues Activations Deprecated

Use this API command to get venues activations of the VLAN pool list by query.

path Parameters

vlanPoolId

required

string

VLAN Pool ID

Request Body schema: application/json
required

fields	Array of strings
page	integer <int32> Default: 1
pageSize	integer <int32> Default: 25
searchString	string
searchTargetFields	Array of strings
sortField	string
sortOrder	string Enum: "ASC" "DESC"

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"page": 1,
"pageSize": 25,
"searchString": "string",
"searchTargetFields": ["string"
],
"sortField": "string",
"sortOrder": "ASC"
}

Response samples

Content type

application/json

{"data": [{"apGroupData": [{"apCount": 0,
"apGroupId": "string",
"apGroupName": "string"
}
],
"venueApCount": 0,
"venueId": "string",
"venueName": "string"
}
],
"fields": ["string"
],
"page": 0,
"totalCount": 0,
"totalPages": 0
}

Recovery

Retrieve and set the recovery PSK.

Get Application Policies Applications Deprecated

Responses

Response samples

Content type

application/json

[{"appName": "string",
"avcAppAndCatId": {"appId": 0,
"catId": 0
}
}
]

Get Application Policies Categories Deprecated

Responses

Response samples

Content type

application/json

[{"catId": 0,
"catName": "string"
}
]

Get Recovery PSK Deprecated

Get the PSK for the recovery network.

Responses

Response samples

Content type

application/json

{"obsolete": false,
"psk": "string",
"tenantId": "string"
}

Update Recovery PSK Deprecated

Update the PSK for the recovery network.

Request Body schema: application/json
required

obsolete	boolean Default: false
psk	string^([0-9]{4}){4}$

Responses

Request samples

Payload

Content type

application/json

{"obsolete": false,
"psk": "string"
}

Response samples

Content type

application/json

{"requestId": "string"
}

Get Capabilities Deprecated

Responses

Response samples

Content type

application/json

{"apModels": [{"allowCbandCountry": ["string"
],
"allowDfsCountry": ["string"
],
"bandCombinationCapabilities": ["DUAL"
],
"canSupportCellular": false,
"canSupportLacp": false,
"canSupportPoeMode": false,
"canSupportPoeOut": false,
"capabilityScore": 0,
"defaultBandCombination": "DUAL",
"externalAntenna": {"coupled": false,
"enable24G": false,
"enable50G": false,
"gain24G": 60,
"gain50G": 60,
"supportDisable": false
},
"has160MHzChannelBandwidth": false,
"isOutdoor": false,
"lanPortPictureDownloadUrl": "string",
"lanPorts": [{"defaultType": "string",
"displayLabel": "string",
"id": "string",
"isPoeOutPort": false,
"isPoePort": false,
"supportDisable": false,
"trunkPortOnly": false,
"untagId": 0,
"vlanMembers": "string"
}
],
"ledOn": false,
"lldpAdInterval": 0,
"lldpEnable": false,
"lldpHoldTime": 0,
"lldpMgmtEnable": false,
"maxChannelization24G": 0,
"maxChannelization5G": 0,
"maxChannelization6G": 0,
"model": "string",
"pictureDownloadUrl": "string",
"poeModeCapabilities": ["string"
],
"primaryWanRecoveryTimer": 0,
"requireOneEnabledTrunkPort": false,
"simCardPrimaryApn": "string",
"simCardPrimaryCellularNetworkSelection": "string",
"simCardPrimaryEnabled": true,
"simCardPrimaryRoaming": true,
"simCardSecondaryApn": "string",
"simCardSecondaryCellularNetworkSelection": "string",
"simCardSecondaryEnabled": true,
"simCardSecondaryRoaming": true,
"support11AX": false,
"supportBandCombination": false,
"supportChannel144": false,
"supportDual5gMode": false,
"supportMesh": true,
"supportTriRadio": false,
"version": "string",
"wanConnection": "string"
}
]
}

DPSK Service

Manage DPSK services.

Activate DPSK Service On Wi-Fi Network

Use this API command to build the relationship between DPSK service and Wi-Fi network.

path Parameters

wifiNetworkId required	string Wi-Fi Network ID
dpskServiceId required	string DPSK service ID

Responses

Response samples

Content type

application/json

{"requestId": "string"
}

Enum	Meaning
VAR	Return delegations to this VAR.
SUPPORT	Return delegations to RUCKUS customer support.
MSP	Return the MSP's MSP-ECs.
SUPPORT_EC	Return MSP-EC delegations to RUCKUS customer support.
MSP_INSTALLER	Return the MSP's installers.
MSP_INTEGRATOR	Return the MSP's integrators.
UNKNOWN	Unknown.

Enum	Meaning
REC	RUCKUS end customer.
VAR	Value-added reseller.
MSP	Managed service provider.
MSP_EC	MSP's end customer.
MSP_NON_VAR	This value is reserved for RUCKUS purposes.
MSP_INSTALLER	Installer organization which administratively reports to an MSP.
MSP_INTEGRATOR	Installer organization which administratively reports to an MSP.
UNKNOWN	Unknown.

RUCKUS ONE APIs

Overview

RUCKUS One API Hosts

Original R1 API Site

License and Terms of Service

Upcoming Changes

Rate Limiting

Versioning

API Authentication and JWT

Authenticating

How to Authenticate

Using the API's in Delegated Mode

Introduction to MSP & VAR Concepts

Business Entities

Entitlements/Licenses

Introduction to Wi-Fi Workflows

Switch Information

Introduction to Resident Portal API

API Changelog

2025-03-13

What's New

POST /events/details/query

What's Changed

POST /events/metas/query

Request:

POST /alarms/metas/query

Request:

2025-02-28

What's New

POST /templates/ethernetPortProfiles/query

What's Changed

GET /clients

Return Type:

GET /clients/{mac}

Return Type:

POST /venues/switches/switchPorts/query

Return Type:

POST /tunnelServiceProfiles/query

Return Type:

POST /switches/ports/query

Return Type:

POST /delegations

Return Type:

POST /wifiNetworks/query

Return Type:

POST /venues/switches/query

Return Type:

POST /venues/aps/clients/query

Return Type:

POST /techpartners/mspecs/query

Return Type:

POST /mspecs/query

Return Type:

POST /guestUsers/query

Return Type:

POST /clientIsolationProfiles/query

Return Type:

POST /venues/switches/aggregationDetails

Return Type:

POST /switches/aggregationDetails

Return Type:

2025-02-18

What's New

PUT /identityGroups/{id}/macRegistrationPools/{poolId}

PUT /identityGroups/{id}/dpskPools/{dpskPoolId}

PUT /identityGroups/{groupId}/identities/{id}/venues/{venueId}/ethernetPorts

GET /identityGroups

POST /identityGroups

GET /identityGroups/{groupId}/identities

POST /identityGroups/{groupId}/identities

DELETE /identityGroups/{groupId}/identities

POST /identityGroups/{groupId}/identities/{id}/devices

POST /identityGroups/{groupId}/identities/csvFile

POST /identityGroups/query

POST /identityGroups/csvFile

POST /identities/query

POST /identities/csvFile

GET /identityGroups/{id}

DELETE /identityGroups/{id}

PATCH /identityGroups/{id}

`POST` /events/details/query

`POST` /events/metas/query

`POST` /alarms/metas/query

`POST` /templates/ethernetPortProfiles/query

`GET` /clients

`GET` /clients/{mac}

`POST` /venues/switches/switchPorts/query

`POST` /tunnelServiceProfiles/query

`POST` /switches/ports/query

`POST` /delegations

`POST` /wifiNetworks/query

`POST` /venues/switches/query

`POST` /venues/aps/clients/query

`POST` /techpartners/mspecs/query

`POST` /mspecs/query

`POST` /guestUsers/query

`POST` /clientIsolationProfiles/query

`POST` /venues/switches/aggregationDetails

`POST` /switches/aggregationDetails

`PUT` /identityGroups/{id}/macRegistrationPools/{poolId}

`PUT` /identityGroups/{id}/dpskPools/{dpskPoolId}

`PUT` /identityGroups/{groupId}/identities/{id}/venues/{venueId}/ethernetPorts

`GET` /identityGroups

`POST` /identityGroups

`GET` /identityGroups/{groupId}/identities

`POST` /identityGroups/{groupId}/identities

`DELETE` /identityGroups/{groupId}/identities

`POST` /identityGroups/{groupId}/identities/{id}/devices

`POST` /identityGroups/{groupId}/identities/csvFile

`POST` /identityGroups/query

`POST` /identityGroups/csvFile

`POST` /identities/query

`POST` /identities/csvFile

`GET` /identityGroups/{id}

`DELETE` /identityGroups/{id}

`PATCH` /identityGroups/{id}

`GET` /identityGroups/{groupId}/identities/{id}

`DELETE` /identityGroups/{groupId}/identities/{id}

`PATCH` /identityGroups/{groupId}/identities/{id}

`GET` /identities

`DELETE` /identityGroups/{groupId}/identities/{id}/vnis

`DELETE` /identityGroups/{groupId}/identities/{id}/ethernetPorts/{macAddress}/{portIndex}

`DELETE` /identityGroups/{groupId}/identities/{id}/devices/{macAddress}

`POST` /tenants/{tenantId}/entitlements/assignments/query

`POST` /tenants/self/entitlements/assignments

`POST` /tenants/self/entitlements/assignments/query

`POST` /entitlements/utilizations/query

`POST` /entitlements/query

`POST` /entitlements/mileageReports/query

`POST` /entitlements/compliances/query

`POST` /entitlements/banners/query

`POST` /entitlements/availabilityReports/query

`POST` /entitlements/attentionNotes/query

`DELETE` /tenants/self/entitlements/assignments/{id}

`PATCH` /tenants/self/entitlements/assignments/{id}

`PUT` /portalServiceProfiles/{portalServiceProfileId}/poweredImages

`PUT` /portalServiceProfiles/{portalServiceProfileId}/photos

`PUT` /portalServiceProfiles/{portalServiceProfileId}/logos

`PUT` /portalServiceProfiles/{portalServiceProfileId}/backgroundImages

`POST` /wifiNetworks/{wifiNetworkId}/guestUsers

`PATCH` /wifiNetworks/{wifiNetworkId}/guestUsers

`GET` /wifiNetworks/{wifiNetworkId}/guestUsers/{guestUserId}

`DELETE` /wifiNetworks/{wifiNetworkId}/guestUsers/{guestUserId}

`PATCH` /wifiNetworks/{wifiNetworkId}/guestUsers/{guestUserId}

`POST` /wifiNetworks/query

`POST` /wifiCallingServiceProfiles/query

`POST` /vlanPoolProfiles/query

`POST` /venues/aps/query

`POST` /venues/aps/clients/query

`POST` /venues/apGroups/query

`POST` /syslogServerProfiles/query

`POST` /softGreProfiles/query

`POST` /snmpAgentProfiles/query

`POST` /roguePolicies/query

`POST` /radiusServerProfiles/query

`POST` /multicastDnsProxyProfiles/query

`POST` /lbsServerProfiles/query

`POST` /l3AclPolicies/query

`POST` /l2AclPolicies/query

`POST` /hotspot20Operators/query