What's New

POST /templates/{templateId}/dependencies/query

Query Template Dependency

PUT /templates/{templateId}/enforcementSettings

Set Template Enforcement Settings

POST /templates/{templateId}/instances/query

Query Drift Instances

POST /templates/{templateId}/tenants/{tenantId}

Apply Template

GET /templates/{templateId}/tenants/{tenantId}/diffReports

Retrieve Diff Reports

PATCH /templates/{templateId}/tenants/{tenantId}/diffReports

Sync Template

POST /templates/portalServiceProfiles

Add Portal Service Profile Template

GET /templates/portalServiceProfiles/{portalServiceProfileId}

Retrieve Portal Service Profile Template

PUT /templates/portalServiceProfiles/{portalServiceProfileId}

Update Portal Service Profile Template

DELETE /templates/portalServiceProfiles/{portalServiceProfileId}

Remove Portal Service Profile Template

PUT /templates/portalServiceProfiles/{portalServiceProfileId}/backgroundImages

Update Portal Service Profile Template Background Image

PUT /templates/portalServiceProfiles/{portalServiceProfileId}/logos

Update Portal Service Profile Template Logo

PUT /templates/portalServiceProfiles/{portalServiceProfileId}/photos

Update Portal Service Profile Template Photo

PUT /templates/portalServiceProfiles/{portalServiceProfileId}/poweredImages

Update Portal Service Profile Template Powered Image

GET /venues/{venueId}/switches/{switchId}/configBackups/{configBackupId}/formattedConfigs

Retrieve Formatted Configuration Backup

POST /templates/venues

Create Venue Template

GET /templates/venues/{venueTemplateId}

Get Venue Template by ID

PUT /templates/venues/{venueTemplateId}

Update Venue Template

DELETE /templates/venues/{venueTemplateId}

Delete Venue Template by ID

What's Deprecated

GET /banners

Get Banners

GET /assignments/summaries

Retrieve Device Type Summary

GET /licenseUsageReports

Get Entitlement Usage Report

GET /mspBanners

Retrieve MSP Banner Data

GET /mspEntitlements

MSP Entitlements

GET /mspEntitlements/summaries

Refresh MSP Entitlements

GET /clients

Get AP Clients

GET /entitlements/summaries

Get Entitlement Summaries

GET /guestUsers

Get Guest Users

POST /guestUsers

Add Guest Users

DELETE /guestUsers

Delete Guest Users

GET /portalServiceProfiles/networks

Get Network Filter of Portal Service Profiles

GET /portalServiceProfiles/tags

Get Tags Filter of Portal Service Profiles

PATCH /mspCustomers/delegations

Deprecated

PATCH /mspCustomers/mspAdmins/associations

Deprecated

GET /mspCustomers/{customerId}/activationStatus

Deprecated

GET /mspCustomers/{customerId}/admins

Deprecated

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

Deprecated

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

Deprecated

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

Deprecated

GET /mspCustomers/{customerId}/delegations

Deprecated

POST /mspCustomers/{customerId}/delegations

Deprecated

DELETE /mspCustomers/{customerId}/delegations

Deprecated

PUT /mspCustomers/{customerId}/delegatorAdmins

Deprecated

POST /mspCustomers/{customerId}/invitations

Deprecated

GET /mspCustomers/{customerId}/logoUrls

Deprecated

GET /mspCustomers/{customerId}/mspadmins

Deprecated

PUT /mspCustomers/{customerId}/mspadmins

Deprecated

GET /mspIntegrators/{integratorId}

Deprecated

PATCH /mspIntegrators/{integratorId}

Deprecated

GET /mspLabels/baseUrls

Deprecated

GET /mspLabels/{mspLabel}

Check MSP Label

POST /identityGroups/{groupId}/identities/csvFile

Import Identities Into the Group

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

Create Devices Into the Identity

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

Delete Device from the Identity

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

Delete Ethernet Port from Identity

GET /switches/acls/{aclId}

Get ACL

POST /switches/deviceRequests

Create Multiple Device Requests

POST /switches/dhcpServers/query

Query DHCP Servers

GET /switches/dhcpServers/{dhcpServerId}

Get DHCP Server-Setting

POST /switches/vlans/query

Retrieve Switch VLANs

GET /switches/{switchId}/aclUnions

Get ACL Union

GET /switches/{switchId}/acls

Get ACLs

POST /switches/{switchId}/acls/query

Retrieve ACLs

POST /switches/{switchId}/configBackups/query

Retrieve Switch Configuration Backups

POST /switches/{switchId}/deviceRequests

Sync/Reboot ICX Device

POST /switches/{switchId}/dhcpServerStateSettings

Update DHCP Server

POST /switches/{switchId}/dhcpServers/query

Query DHCP Servers

GET /switches/{switchId}/lags

Get LAGs

POST /switches/{switchId}/lags

Add LAGs

GET /switches/{switchId}/staticRoutes

Get Static Routes

POST /switches/{switchId}/staticRoutes

Add Static Route

GET /switches/{switchId}/transactions/{transactionId}/configHistDetails

Get Configuration History

GET /switches/{switchId}/vePorts

Retrieve Virtual Ethernet Settings

POST /switches/{switchId}/vePorts

Add Virtual Ethernet Settings

POST /switches/{switchId}/vePorts/query

Retrieve Virtual Ethernet Settings

GET /switches/{switchId}/vlanUnions

Retrieve VLANs

POST /switches/{switchId}/vlans/query

Query Switch VLANs

POST /templates/venues/aaaServers/query

Query Venue Template AAA Servers

POST /venues/aaaServers/query

Query AAA Servers

GET /venues/switchFirmwares/currentVersions

Get Current Versions

POST /venues/switchFirmwares/schedules

Create Upgrade Schedule

DELETE /venues/switchFirmwares/schedules

Delete Upgrade Schedule

POST /venues/switchFirmwares/upgradeStatusDetails/query

Get Venue Upgrade Statuses

GET /venues/switchFirmwares/versions/{versionType}

Get Versions

GET /venues/{venueId}/switchProfiles/acls

Get ACLs

POST /venues/{venueId}/taggedVlans/query

Retrieve Tagged-VLANs

GET /venues/{venueId}/trustedPorts

Get Trusted Ports

POST /venues/{venueId}/untaggedVlans/query

Retrieve Untagged-VLANs

GET /clients/{mac}

Get Client by MAC

POST /guestUsers/query/csvFiles

Export Guest CSV

GET /venues/{venueId}/apModels

Get Venue AP Models

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 /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/mappings

Create Network Activation Mappings

POST /networkActivations/query

Get Network Activations by Query Filter

GET /networks

Get Networks

POST /networks

Create Network

DELETE /networks

Delete Networks

GET /networks/qosMapSets

Get Default Rules for QoS Map Set

GET /networks/wisprProviders

Get External WISPr Providers

GET /networks/{networkId}

Get Network

PUT /networks/{networkId}

Update Network

DELETE /networks/{networkId}

Delete Network

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 /venues/apGroups

Get AP-Groups

DELETE /venues/apGroups

Delete AP-Groups

GET /venues/apGroups/{apGroupId}

Get AP-Group

PUT /venues/apGroups/{apGroupId}

Update AP-Group

DELETE /venues/apGroups/{apGroupId}

Delete AP-Group

GET /venues/apGroups/{apGroupId}/aps

Get APs by AP-Group

GET /venues/aps

Get APs

POST /venues/aps

Add APs

DELETE /venues/aps

Delete APs

GET /venues/aps/capabilities

Get Capabilities

GET /venues/aps/importResults

Get Result for Import APs from CSV File

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}/capabilities

Get AP Capabilities

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}/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}/ledSettings

Get AP LED

PUT /venues/aps/{serialNumber}/ledSettings

Update AP LED

DELETE /venues/aps/{serialNumber}/ledSettings

Reset AP LED

GET /venues/aps/{serialNumber}/logs

Download AP Log

GET /venues/aps/{serialNumber}/meshSettings

Get AP Mesh Settings

PUT /venues/aps/{serialNumber}/meshSettings

Update AP Mesh Settings

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}/pictures

Get AP Picture

PUT /venues/aps/{serialNumber}/pictures

Upload AP Picture

DELETE /venues/aps/{serialNumber}/pictures

Delete AP Picture

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/lteBands

Get Available LTE Bands

GET /venues/wifiSettings

Get Venues Wi-Fi Settings

GET /venues/{venueId}/apModelLanPortSettings

Get Venue LAN-Ports

PUT /venues/{venueId}/apModelLanPortSettings

Update Venue LAN-Ports

GET /venues/{venueId}/aps/capabilities

Get Venue AP-Model Capabilities

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}/clientAdmissionControlSettings

Get AP Client Admission Control Settings

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

Update AP Client Admission Control Settings

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

Get AP LAN-Ports

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

Update AP LAN-Ports

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}/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}/mDnsFencingSettings

Get Multicast DNS Fencing Settings

PUT /venues/{venueId}/mDnsFencingSettings

Update Multicast DNS Fencing 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

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

POST /vlanPools/{vlanPoolId}/venues

Get VLAN Pool Venues Activations

POST /dpskServices

Create New DPSK Pool

GET /dpskServices

Get DPSK Pools

GET /entitlements

Get Entitlements

POST /networks/{networkId}/guestUsers

Import Guest Users by Network ID

GET /mspCustomers

Deprecated

POST /mspCustomers

Deprecated

GET /mspCustomers/{customerId}

Deprecated

DELETE /mspCustomers/{customerId}

Deprecated

PUT /mspCustomers/{customerId}

Deprecated

GET /assignments

Retrieve Assignments

POST /assignments

Create multiple assignments

DELETE /assignments

Revoke multiple assignments

PATCH /assignments

Replace multiple assignments

POST /identities/csvFile

Export Identities Into File

GET /venues/propertyConfigs

Gets Property Configurations

GET /cliTemplates

Get Command-Line Interface Templates

DELETE /stacks/{stackSwitchSerialNumber}

Delete Stack Member

GET /switchProfiles

Get Switch Profiles

DELETE /switchProfiles

Delete Switch Profiles

GET /switchProfiles/{switchProfileId}/acls

Get ACLs

POST /switchProfiles/{switchProfileId}/acls

Add ACL

DELETE /switchProfiles/{switchProfileId}/acls

Delete ACLs

GET /switchProfiles/{switchProfileId}/acls/{aclId}

Get ACL

PUT /switchProfiles/{switchProfileId}/acls/{aclId}

Update ACL

DELETE /switchProfiles/{switchProfileId}/acls/{aclId}

Delete ACL

POST /switchProfiles/{switchProfileId}/trustedPorts

Add Trusted Port

DELETE /switchProfiles/{switchProfileId}/trustedPorts

Delete Trusted Ports

GET /switchProfiles/{switchProfileId}/trustedPorts/{trustedPortId}

Get Trusted Port

PUT /switchProfiles/{switchProfileId}/trustedPorts/{trustedPortId}

Update Trusted Port

DELETE /switchProfiles/{switchProfileId}/trustedPorts/{trustedPortId}

Delete Trusted Port

GET /switchProfiles/{switchProfileId}/vlans

Get Multiple VLANs

DELETE /switchProfiles/{switchProfileId}/vlans

Delete Multiple VLANs

GET /switchProfiles/{switchProfileId}/vlans/{vlanId}

Get Profile VLAN

PUT /switchProfiles/{switchProfileId}/vlans/{vlanId}

Update VLAN

DELETE /switchProfiles/{switchProfileId}/vlans/{vlanId}

Delete Profile VLAN

GET /switches

Get ICX Switches

POST /switches

Add ICX Switches

DELETE /switches

Delete ICX Switches

DELETE /switches/configBackups

Delete Switch Configuration Backups

GET /switches/configBackups/{configBackupId}

Get Switch Configuration Backup

PUT /switches/configBackups/{configBackupId}

Restore Switch Configuration Backup

DELETE /switches/configBackups/{configBackupId}

Delete Switch Configuration Backup

DELETE /switches/lags

Delete LAGs

GET /switches/lags/{lagId}

Get LAG

PUT /switches/lags/{lagId}

Update LAG

DELETE /switches/lags/{lagId}

Delete LAG

PUT /switches/portSettings

Update Ports

POST /switches/portSettings

Get Ports

DELETE /switches/staticRoutes

Delete Static Routes

GET /switches/staticRoutes/{staticRouteId}

Get Static Route

PUT /switches/staticRoutes/{staticRouteId}

Update Static Route

DELETE /switches/staticRoutes/{staticRouteId}

Delete Static Route

DELETE /switches/vePorts

Delete Virtual Ethernet Settings

GET /switches/vePorts/{vePortId}

Get Virtual Ethernet Setting

PUT /switches/vePorts/{vePortId}

Update Virtual Ethernet Setting

DELETE /switches/vePorts/{vePortId}

Delete Virtual Ethernet Setting

POST /switches/vlans

Add Switch VLANs

DELETE /switches/vlans

Delete Switch VLANs

GET /switches/vlans/{vlanId}

Get Switch VLAN

PUT /switches/vlans/{vlanId}

Update Switch VLAN

DELETE /switches/vlans/{vlanId}

Delete Switch VLAN

GET /switches/{switchId}

Get ICX Switch

PUT /switches/{switchId}

Update ICX Switch

DELETE /switches/{switchId}

Delete ICX Switch

GET /switches/{switchId}/configBackups

Get Switch Configuration Backups

POST /switches/{switchId}/configBackups

Add Switch Configuration Backup

POST /switches/{switchId}/configHistDetails/query

Get Configuration History

PUT /switches/{switchId}/dhcpServers

Update DHCP Server-Setting

POST /switches/{switchId}/dhcpServers

Add DHCP Server

DELETE /switches/{switchId}/dhcpServers

Delete DHCP Servers

DELETE /switches/{switchId}/dhcpServers/{dhcpServerId}

Delete DHCP Server-Setting

GET /switches/{switchId}/vlans

Get Switch VLANs

POST /switches/{switchId}/vlans

Add Switch VLAN

GET /templates/switchProfiles

Get Switch Profile Templates

DELETE /templates/switchProfiles

Delete Switch Profile Templates

DELETE /templates/venues/aaaServers

Delete Venue Template AAA Servers

GET /templates/venues/aaaServers/{aaaServerId}

Get Venue Template AAA Server

DELETE /templates/venues/aaaServers/{aaaServerId}

Delete Venue Template AAA Server

PUT /templates/venues/{venueId}/aaaSettings/{aaaSettingId}

Update Venue Template AAA Setting

DELETE /venues/aaaServers

Delete AAA Servers

GET /venues/aaaServers/{aaaServerId}

Get AAA Server-Setting

DELETE /venues/aaaServers/{aaaServerId}

Delete AAA Server

POST /venues/switches

Add Switches

PUT /venues/{venueId}/aaaSettings/{aaaSettingId}

Update AAA Setting

DELETE /venues/{venueId}/switchSettings

Delete Venue Switch Settings

GET /venues/{venueId}/vlans

Get VLANs

POST /aps/aggregationDetails

Get APs Aggregation Details

POST /aps/query

Get APs

POST /aps/query/csvFiles

Export AP Inventory

POST /cloudpaths/query

Get Cloudpath Servers

POST /enhancedAccessControlProfiles/query

Get Access Control Profiles

POST /enhancedApplicationPolicies/query

Get Application Policies

POST /enhancedDevicePolicies/query

Get Device Policies

POST /enhancedDhcpConfigServiceProfiles/query

Get DHCP Configuration Service Profiles

POST /enhancedIsolationAllowlists/query

Get Client Isolation Allowlists

POST /enhancedL2AclPolicies/query

Get Layer Two Policies

POST /enhancedL3AclPolicies/query

Get Layer Three Policies

POST /enhancedMdnsProxyProfiles/query

Get Multicast DNS Proxy Profiles

POST /enhancedRadiusServerProfiles/query

Get RADIUS Server Profiles

POST /enhancedRogueApPolicyProfiles/query

Get Rogue AP Policy Profiles

POST /enhancedSyslogServerProfiles/query

Get Syslog Server Profiles

POST /enhancedVlanPoolProfiles/query

Get VLAN Pool Profiles

POST /enhancedWifiCallingProfiles/query

Get Wifi Calling Profiles

POST /snmpAgents/query

Get AP SNMP Agents

POST /switches/aggregationDetails

Get Switches Aggregation Details

POST /switches/clients/query

Get Switch Clients

POST /switches/ports/query

Get Ports

POST /switches/query/csvFiles

Export Switch Inventory

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

GET /l2AclPolicies

Get Layer-2 ACL Policies.

DELETE /l2AclPolicies

Delete Layer-2 ACL Policies.

GET /l3AclPolicies

Get Layer-3 ACL Policies.

DELETE /l3AclPolicies

Delete Layer-3 ACL Policies.

DELETE /networkActivations/{networkVenueId}

Delete Network Activation

GET /networkActivations/{networkVenueId}

Get Network Activation

PUT /networkActivations/{networkVenueId}

Update Network Activation

GET /rogueApPolicyProfiles

Get Rogue AP Detection Policies

DELETE /rogueApPolicyProfiles

Delete AP Detection Policies

POST /rogueApPolicyProfiles

Create Rogue AP Detection Policy

GET /syslogServerProfiles

Get Syslog Server Profiles

DELETE /syslogServerProfiles

Delete Syslog Server Profiles

GET /venues/aps/{serialNumber}/packets

Get Packet Capture State

DELETE /venues/aps/{serialNumber}/packets

Stop Packet Capture

POST /venues/aps/{serialNumber}/packets

Start Packet Capture

DELETE /venues/aps/{serialNumber}/radioSettings

Reset AP Radio Customization

GET /venues/aps/{serialNumber}/radioSettings

Get AP Radio

PUT /venues/aps/{serialNumber}/radioSettings

Update AP Radio

DELETE /venues/aps/{serialNumber}/wifiOverwriteSettings

Reset AP Customization

GET /venues/aps/{serialNumber}/wifiOverwriteSettings

Get AP Customization

PUT /venues/aps/{serialNumber}/wifiOverwriteSettings

Update AP Customization

GET /venues/{venueId}/apGroups

Get AP-Groups by Venue

GET /venues/{venueId}/cellularSettings

Get Venue AP-Model Cellular

PUT /venues/{venueId}/cellularSettings

Update Venue AP-Model Cellular

GET /vlanPools

Get VLAN Pools

DELETE /vlanPools

Delete VLAN Pools

POST /vlanPools

Add VLAN Pool

GET /wifiCallingServiceProfiles

Get Wi-Fi Calling Service Profiles

DELETE /wifiCallingServiceProfiles

Delete Wi-Fi Calling Service Profiles

POST /x509certs

Validate X509 Certificates

DELETE /guestUsers/{guestUserId}

Delete Guest User by ID

GET /guestUsers/{guestUserId}

Get Guest User by ID

PATCH /guestUsers/{guestUserId}

Update Guest User

POST /mspCustomers/firmwareUpgradeSchedules

Deprecated

POST /identityGroups

Create an Identity Group

DELETE /identityGroups/{groupId}/identities

Delete the Identities in Group

POST /identityGroups/{groupId}/identities

Create Identity Into the Group

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

Delete the Identity

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

Update the Identity

DELETE /identityGroups/{id}

Delete the Identity Group

PATCH /identityGroups/{id}

Update the Identity Group

POST /policySetEvaluations

Evaluate Criteria

GET /policySets

Get Policy Sets

GET /policyTemplates

Get Policy Templates

GET /policyTemplates/policies

Get Policies Across Templates

DELETE /residentPortals

Delete Resident Portals

GET /residentPortals

Get Resident Portals

DELETE /venues/{venueId}/units

Delete Units for Venue

POST /switches/configBackups/comparisons

Compare Switch Configuration Backups

POST /venues/switchFirmwares/schedules/query

Get Venues

POST /venues/switchFirmwares/switches/schedules/query

Get Switches

GET /venues

Access Venues

DELETE /venues

Revoke Venues by IDs

GET /accessControlProfiles

Get All Access Control Profiles

DELETE /accessControlProfiles

Delete Multiple Access Control Profiles

DELETE /networkActivations

Delete Network Activation

POST /networkActivations

Create Network Activation

GET /radiusServerProfiles

List RADIUS Profiles

DELETE /radiusServerProfiles

Delete RADIUS Profiles

DELETE /venues/aps/{serialNumber}

Delete AP

PUT /venues/aps/{serialNumber}

Update AP

PATCH /venues/aps/{serialNumber}

Trigger AP Action

GET /venues/aps/{serialNumber}

Get AP

GET /venues/aps/{serialNumber}/channels

Get AP Default Regulatory-Channels

GET /venues/{venueId}/channels

Get Venue Default Regulatory-Channels

DELETE /venues/{venueId}/radioSettings

Reset Venue Radio

GET /venues/{venueId}/radioSettings

Get Venue Radio

PUT /venues/{venueId}/radioSettings

Update Venue Radio

DELETE /portalServiceProfiles

Remove Portal Service Profile

GET /portalServiceProfiles

Get Portal Service Profiles

GET /mspLabels

Retrieve Brand Settings

PUT /mspLabels

Update Brand Settings

POST /mspLabels

Add Brand Settings

GET /switches/{switchId}/portSettings

Get Ports

POST /switches/{switchId}/portSettings

Get Ports

PUT /switches/{switchId}/portSettings

Update Port

GET /venues/{venueId}/wifiSettings

Get Venue Wi-Fi Settings

What's Changed

GET /certificateAuthorities/{caId}/chains

Parameters:

Changed: caId in path

Certificate id

POST /certificateAuthorities/{caId}/privateKeys

Parameters:

Changed: caId in path

Certificate Authority id

DELETE /certificateAuthorities/{caId}/privateKeys

Parameters:

Changed: caId in path

Certificate Authority id

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

Parameters:

Changed: certId in path

Certificate id

Changed: templateId in path

Certificate template id

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

Parameters:

Changed: templateId in path

Template id

Changed: policySetId in path

Policy set id

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

Parameters:

Changed: templateId in path

Template id

Changed: policySetId in path

Policy set id

GET /certificates/{certId}/chains

Parameters:

Changed: certId in path

Certificate id

POST /dpskServices/{poolId}/passphrases/csvFiles

Parameters:

Changed: poolId in path

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

Parameters:

Changed: poolId in path

DPSK passphrase id

Changed: policySetId in path

Policy set id

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

Parameters:

Changed: poolId in path

DPSK passphrase id

Changed: policySetId in path

Policy set id

PUT /edgeDhcpServices/{dhcpId}/venues/{venueId}/edgeClusters/{edgeClusterId}

Parameters:

Changed: dhcpId in path

Changed: venueId in path

Changed: edgeClusterId in path

DELETE /edgeDhcpServices/{dhcpId}/venues/{venueId}/edgeClusters/{edgeClusterId}

Parameters:

Changed: dhcpId in path

Changed: venueId in path

Changed: edgeClusterId in path

PUT /edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}/venues/{venueId}/edgeClusters/{edgeClusterId}

Parameters:

Changed: multicastDnsProxyProfileId in path

Changed: venueId in path

Changed: edgeClusterId in path

DELETE /edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}/venues/{venueId}/edgeClusters/{edgeClusterId}

Parameters:

Changed: multicastDnsProxyProfileId in path

Changed: venueId in path

Changed: edgeClusterId in path

GET /banners

GET /files/{fileId}

Parameters:

Changed: fileId in path

GET /assignments/summaries

GET /licenseUsageReports

Parameters:

Changed: deviceDetails in query

True to include device detail in the report. False to exclude device detail in the report.

Changed: Content-Type in header

GET /mspBanners

GET /mspEntitlements

GET /mspEntitlements/summaries

POST /venues/{venueId}/units/notifications

Parameters:

Changed: venueId in path

Venue Id

Request:

GET /clients

POST /activities/query

Request:

POST /activities/{activityId}/devices/query

Parameters:

Changed: activityId in path

Request:

POST /certificateTemplates/{templateId}/certificates

Parameters:

Changed: templateId in path

Request:

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

Parameters:

Changed: certId in path

Certificate id

Changed: templateId in path

Certificate template id

Changed: includeChain in query

Return Type:

Changed response : 200 OK

Certificate

• Changed content type : application/json

  • Changed property certificateAuthoritiesName (object)

    The name of the template that this certificate generates from.

  • Changed property certificateTemplateName (object)

    The name of the template that this certificate generates from.

  • Changed property chain (object)

    The chain of the certificate.

  • Changed property commonName (object)

    The common name of the certificate.

  • Changed property country (object)

    The country included in the certificate.

  • Changed property createDate (object)

    The date that creates the certificate.

  • Changed property details (object)

    The details of the certificate.

  • Changed property email (object)

    The email of the certificate.

  • Changed property enrollmentType (object)

    The enrollment type of the certificate.

  • Changed property id (object)

    The unique for this certificate.

  • Changed property keyLength (object)

    The length of the key.

  • Changed property keyUsages (object)

    The key usage of this certificate.

  • Changed property locality (object)

    The locality included in the certificate.

  • Changed property notAfterDate (object)

    The date after which the certificate becomes invalid.

  • Changed property notBeforeDate (object)

    The date for which the certificate becomes valid.

  • Changed property organization (object)

    The organization of the certificate.

  • Changed property organizationUnit (object)

    The organization unit of the certificate.

  • Changed property privateKeyBase64 (object)

    The private key of the certificate.

  • Changed property publicKeyBase64 (object)

    The public key of the certificate.

  • Changed property revocationDate (object)

    The date after which the certificate be revoked.

  • Changed property serialNumber (object)

    The serial number of the certificate.

  • Changed property shaThumbprint (object)

    The thumbprint of the certificate.

  • Changed property state (object)

    The state included in the certificate.

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

  • Changed property certificateAuthoritiesName (object)

    The name of the template that this certificate generates from.

  • Changed property certificateTemplateName (object)

    The name of the template that this certificate generates from.

  • Changed property chain (object)

    The chain of the certificate.

  • Changed property commonName (object)

    The common name of the certificate.

  • Changed property country (object)

    The country included in the certificate.

  • Changed property createDate (object)

    The date that creates the certificate.

  • Changed property details (object)

    The details of the certificate.

  • Changed property email (object)

    The email of the certificate.

  • Changed property enrollmentType (object)

    The enrollment type of the certificate.

  • Changed property id (object)

    The unique for this certificate.

  • Changed property keyLength (object)

    The length of the key.

  • Changed property keyUsages (object)

    The key usage of this certificate.

  • Changed property locality (object)

    The locality included in the certificate.

  • Changed property notAfterDate (object)

    The date after which the certificate becomes invalid.

  • Changed property notBeforeDate (object)

    The date for which the certificate becomes valid.

  • Changed property organization (object)

    The organization of the certificate.

  • Changed property organizationUnit (object)

    The organization unit of the certificate.

  • Changed property privateKeyBase64 (object)

    The private key of the certificate.

  • Changed property publicKeyBase64 (object)

    The public key of the certificate.

  • Changed property revocationDate (object)

    The date after which the certificate be revoked.

  • Changed property serialNumber (object)

    The serial number of the certificate.

  • Changed property shaThumbprint (object)

    The thumbprint of the certificate.

  • Changed property state (object)

    The state included in the certificate.

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

Parameters:

Changed: certId in path

Certificate id

Changed: templateId in path

Certificate template id

Request:

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

Parameters:

Changed: templateId in path

Certificate Template id

Changed: certId in path

Certificate id

Request:

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

Parameters:

Changed: templateId in path

Changed: identityId in path

Request:

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

Parameters:

Changed: templateId in path

Certificate template id

Changed: msiPackageId in path

MSI package id

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

Parameters:

Changed: templateId in path

Certificate template id

Changed: msiPackageId in path

MSI package id

Return Type:

Changed response : 200 OK

MSI Package

• Changed content type : application/json

  • Changed property id (object)

    The unique identifier for this configuration.

  • Changed property passphrase (object)

    The passphrase for the package.

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

  • Changed property id (object)

    The unique identifier for this configuration.

  • Changed property passphrase (object)

    The passphrase for the package.

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

Parameters:

Changed: templateId in path

Certificate template id

Changed: msiPackageId in path

MSI Package id

Request:

Changed content type : application/json

• Changed property id (object)

  The unique identifier for this configuration.

• Changed property passphrase (object)

  The passphrase for the package.

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

• Changed property id (object)

  The unique identifier for this configuration.

• Changed property passphrase (object)

  The passphrase for the package.

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

Parameters:

Changed: templateId in path

Certificate template id

Changed: notificationId in path

Notification id

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

Parameters:

Changed: templateId in path

Certificate template id

Changed: notificationId in path

Notification id

Return Type:

Changed response : 200 OK

Notification

• Changed content type : application/json

  • Changed property id (object)

    The unique if the notification.

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

  • Changed property id (object)

    The unique if the notification.

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

Parameters:

Changed: templateId in path

Certificate template id

Changed: notificationId in path

Notification id

Request:

Changed content type : application/json

• Changed property id (object)

  The unique if the notification.

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

• Changed property id (object)

  The unique if the notification.

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

Parameters:

Changed: templateId in path

Certificate template id

Changed: scepKeyId in path

SCEP key id

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

Parameters:

Changed: templateId in path

Certificate template id

Changed: scepKeyId in path

SCEP key id

Return Type:

Changed response : 200 OK

SCEP Key

• Changed content type : application/json

  • Changed property enrollmentUrl (object)

    The URL for device enrollment.

  • Changed property id (object)

    The unique for this simple certificate enrollment protocol key.

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

  • Changed property enrollmentUrl (object)

    The URL for device enrollment.

  • Changed property id (object)

    The unique for this simple certificate enrollment protocol key.

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

Parameters:

Changed: templateId in path

Certificate template id

Changed: scepKeyId in path

ScepKey Id

Request:

Changed content type : application/json

• Changed property enrollmentUrl (object)

  The URL for device enrollment.

• Changed property id (object)

  The unique for this simple certificate enrollment protocol key.

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

• Changed property enrollmentUrl (object)

  The URL for device enrollment.

• Changed property id (object)

  The unique for this simple certificate enrollment protocol key.

DELETE /dpskServices/{poolId}

Parameters:

Changed: poolId in path

GET /dpskServices/{poolId}

Parameters:

Changed: poolId in path

DPSK pool id

Return Type:

Changed response : 200 OK

DPSK pool

• Changed content type : application/json

  • Changed property createdDate (object)

  • Changed property id (object)

    Unique identifier for pool.

  • Changed property identityId (object)

    Deprecated. Use identity group ID instead.

  • Changed property isEnforced (object)

    Template enforcement setting.

  • Changed property isReferenced (object)

    If this entity is referenced by an identity group and cannot be deleted.

  • Changed property lastModifiedDate (object)

  • Changed property networkCount (object)

    Number of networks associated with this pool.

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

  • Changed property createdDate (object)

  • Changed property id (object)

    Unique identifier for pool.

  • Changed property identityId (object)

    Deprecated. Use identity group ID instead.

  • Changed property isEnforced (object)

    Template enforcement setting.

  • Changed property isReferenced (object)

    If this entity is referenced by an identity group and cannot be deleted.

  • Changed property lastModifiedDate (object)

  • Changed property networkCount (object)

    Number of networks associated with this pool.

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

  • Changed property createdDate (object)

  • Changed property id (object)

    Unique identifier for pool.

  • Changed property identityId (object)

    Deprecated. Use identity group ID instead.

  • Changed property isEnforced (object)

    Template enforcement setting.

  • Changed property isReferenced (object)

    If this entity is referenced by an identity group and cannot be deleted.

  • Changed property lastModifiedDate (object)

  • Changed property networkCount (object)

    Number of networks associated with this pool.

PUT /dpskServices/{poolId}

Parameters:

Changed: poolId in path

DPSK pool id

Request:

Changed content type : application/json

• Changed property createdDate (object)

• Changed property id (object)

  Unique identifier for pool.

• Changed property identityId (object)

  Deprecated. Use identity group ID instead.

• Changed property isEnforced (object)

  Template enforcement setting.

• Changed property isReferenced (object)

  If this entity is referenced by an identity group and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property networkCount (object)

  Number of networks associated with this pool.

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

• Changed property createdDate (object)

• Changed property id (object)

  Unique identifier for pool.

• Changed property identityId (object)

  Deprecated. Use identity group ID instead.

• Changed property isEnforced (object)

  Template enforcement setting.

• Changed property isReferenced (object)

  If this entity is referenced by an identity group and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property networkCount (object)

  Number of networks associated with this pool.

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

• Changed property createdDate (object)

• Changed property id (object)

  Unique identifier for pool.

• Changed property identityId (object)

  Deprecated. Use identity group ID instead.

• Changed property isEnforced (object)

  Template enforcement setting.

• Changed property isReferenced (object)

  If this entity is referenced by an identity group and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property networkCount (object)

  Number of networks associated with this pool.

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

• Changed property createdDate (object)

• Changed property id (object)

  Unique identifier for pool.

• Changed property identityId (object)

  Deprecated. Use identity group ID instead.

• Changed property isEnforced (object)

  Template enforcement setting.

• Changed property isReferenced (object)

  If this entity is referenced by an identity group and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property networkCount (object)

  Number of networks associated with this pool.

PATCH /dpskServices/{poolId}

Parameters:

Changed: poolId in path

DPSK pool id

Request:

Changed content type : application/json

• Changed property createdDate (object)

• Changed property id (object)

  Unique identifier for pool.

• Changed property identityId (object)

  Deprecated. Use identity group ID instead.

• Changed property isEnforced (object)

  Template enforcement setting.

• Changed property isReferenced (object)

  If this entity is referenced by an identity group and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property networkCount (object)

  Number of networks associated with this pool.

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

• Changed property createdDate (object)

• Changed property id (object)

  Unique identifier for pool.

• Changed property identityId (object)

  Deprecated. Use identity group ID instead.

• Changed property isEnforced (object)

  Template enforcement setting.

• Changed property isReferenced (object)

  If this entity is referenced by an identity group and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property networkCount (object)

  Number of networks associated with this pool.

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

• Changed property createdDate (object)

• Changed property id (object)

  Unique identifier for pool.

• Changed property identityId (object)

  Deprecated. Use identity group ID instead.

• Changed property isEnforced (object)

  Template enforcement setting.

• Changed property isReferenced (object)

  If this entity is referenced by an identity group and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property networkCount (object)

  Number of networks associated with this pool.

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

• Changed property createdDate (object)

• Changed property id (object)

  Unique identifier for pool.

• Changed property identityId (object)

  Deprecated. Use identity group ID instead.

• Changed property isEnforced (object)

  Template enforcement setting.

• Changed property isReferenced (object)

  If this entity is referenced by an identity group and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property networkCount (object)

  Number of networks associated with this pool.

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

Parameters:

Changed: poolId in path

DPSK pool id

Changed: id in path

DPSK passphrase id

Return Type:

Changed response : 200 OK

DPSK passphrase

• Changed content type : application/json

  • Changed property createdDate (object)

    Passphrase creation date.

  • Changed property devices (object)

    The devices configured or connected to the passphrase.

  • Changed property id (object)

  • Changed property isReferenced (object)

    If this entity is referenced by an identity and cannot be deleted.

  • Changed property lastModifiedDate (object)

  • Changed property revocationDate (object)

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

  • Changed property createdDate (object)

    Passphrase creation date.

  • Changed property devices (object)

    The devices configured or connected to the passphrase.

  • Changed property id (object)

  • Changed property isReferenced (object)

    If this entity is referenced by an identity and cannot be deleted.

  • Changed property lastModifiedDate (object)

  • Changed property revocationDate (object)

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

  • Changed property createdDate (object)

    Passphrase creation date.

  • Changed property devices (object)

    The devices configured or connected to the passphrase.

  • Changed property id (object)

  • Changed property isReferenced (object)

    If this entity is referenced by an identity and cannot be deleted.

  • Changed property lastModifiedDate (object)

  • Changed property revocationDate (object)

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

Parameters:

Changed: poolId in path

DPSK pool id

Changed: id in path

DPSK passphrase id

Request:

Changed content type : application/json

• Changed property createdDate (object)

  Passphrase creation date.

• Changed property devices (object)

  The devices configured or connected to the passphrase.

• Changed property id (object)

• Changed property isReferenced (object)

  If this entity is referenced by an identity and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property revocationDate (object)

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

• Changed property createdDate (object)

  Passphrase creation date.

• Changed property devices (object)

  The devices configured or connected to the passphrase.

• Changed property id (object)

• Changed property isReferenced (object)

  If this entity is referenced by an identity and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property revocationDate (object)

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

• Changed property createdDate (object)

  Passphrase creation date.

• Changed property devices (object)

  The devices configured or connected to the passphrase.

• Changed property id (object)

• Changed property isReferenced (object)

  If this entity is referenced by an identity and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property revocationDate (object)

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

• Changed property createdDate (object)

  Passphrase creation date.

• Changed property devices (object)

  The devices configured or connected to the passphrase.

• Changed property id (object)

• Changed property isReferenced (object)

  If this entity is referenced by an identity and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property revocationDate (object)

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

Parameters:

Changed: poolId in path

DPSK pool id

Changed: id in path

DPSK passphrase id

Request:

Changed content type : application/json

• Changed property createdDate (object)

  Passphrase creation date.

• Changed property devices (object)

  The devices configured or connected to the passphrase.

• Changed property id (object)

• Changed property isReferenced (object)

  If this entity is referenced by an identity and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property revocationDate (object)

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

• Changed property createdDate (object)

  Passphrase creation date.

• Changed property devices (object)

  The devices configured or connected to the passphrase.

• Changed property id (object)

• Changed property isReferenced (object)

  If this entity is referenced by an identity and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property revocationDate (object)

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

• Changed property createdDate (object)

  Passphrase creation date.

• Changed property devices (object)

  The devices configured or connected to the passphrase.

• Changed property id (object)

• Changed property isReferenced (object)

  If this entity is referenced by an identity and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property revocationDate (object)

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

• Changed property createdDate (object)

  Passphrase creation date.

• Changed property devices (object)

  The devices configured or connected to the passphrase.

• Changed property id (object)

• Changed property isReferenced (object)

  If this entity is referenced by an identity and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property revocationDate (object)

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

Parameters:

Changed: passphraseId in path

DPSK passphrase ID

Changed: poolId in path

DPSK pool ID

Request:

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

Parameters:

Changed: passphraseId in path

DPSK passphrase ID

Changed: poolId in path

DPSK pool ID

Request:

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

Parameters:

Changed: passphraseId in path

DPSK passphrase id

Changed: poolId in path

DPSK pool id

Return Type:

Changed response : 200 OK

Get Passphrase Devices

• Changed content type : application/json

  • Changed property online (object)

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

  • Changed property online (object)

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

  • Changed property online (object)

POST /identityGroups/{identityGroupId}/dpskServices

Parameters:

Changed: identityGroupId in path

Identity group id

Request:

Changed content type : application/json

• Changed property createdDate (object)

• Changed property id (object)

  Unique identifier for pool.

• Changed property identityId (object)

  Deprecated. Use identity group ID instead.

• Changed property isEnforced (object)

  Template enforcement setting.

• Changed property isReferenced (object)

  If this entity is referenced by an identity group and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property networkCount (object)

  Number of networks associated with this pool.

POST /templates/dpskServices

Request:

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

• Changed property createdDate (object)

• Changed property id (object)

  Unique identifier for pool.

• Changed property identityId (object)

  Deprecated. Use identity group ID instead.

• Changed property isEnforced (object)

  Template enforcement setting.

• Changed property isReferenced (object)

  If this entity is referenced by an identity group and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property networkCount (object)

  Number of networks associated with this pool.

DELETE /templates/dpskServices/{poolTemplateId}

Parameters:

Changed: poolTemplateId in path

DPSK pool template id

GET /templates/dpskServices/{poolTemplateId}

Parameters:

Changed: poolTemplateId in path

DPSK pool template id

Return Type:

Changed response : 200 OK

DPSK pool template

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

  • Changed property createdDate (object)

  • Changed property id (object)

    Unique identifier for pool.

  • Changed property identityId (object)

    Deprecated. Use identity group ID instead.

  • Changed property isEnforced (object)

    Template enforcement setting.

  • Changed property isReferenced (object)

    If this entity is referenced by an identity group and cannot be deleted.

  • Changed property lastModifiedDate (object)

  • Changed property networkCount (object)

    Number of networks associated with this pool.

PUT /templates/dpskServices/{poolTemplateId}

Parameters:

Changed: poolTemplateId in path

DPSK pool template id

Request:

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

• Changed property createdDate (object)

• Changed property id (object)

  Unique identifier for pool.

• Changed property identityId (object)

  Deprecated. Use identity group ID instead.

• Changed property isEnforced (object)

  Template enforcement setting.

• Changed property isReferenced (object)

  If this entity is referenced by an identity group and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property networkCount (object)

  Number of networks associated with this pool.

PATCH /templates/dpskServices/{poolTemplateId}

Parameters:

Changed: poolTemplateId in path

DPSK pool template id

Request:

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

• Changed property createdDate (object)

• Changed property id (object)

  Unique identifier for pool.

• Changed property identityId (object)

  Deprecated. Use identity group ID instead.

• Changed property isEnforced (object)

  Template enforcement setting.

• Changed property isReferenced (object)

  If this entity is referenced by an identity group and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property networkCount (object)

  Number of networks associated with this pool.

POST /templates/dpskServices/{poolTemplateId}/cloneSettings

Parameters:

Changed: poolTemplateId in path

DPSK pool template id

Request:

POST /templates/identityGroups/{identityGroupId}/dpskServices

Parameters:

Changed: identityGroupId in path

Identity group id

Request:

Changed content type : application/json

• Changed property createdDate (object)

• Changed property id (object)

  Unique identifier for pool.

• Changed property identityId (object)

  Deprecated. Use identity group ID instead.

• Changed property isEnforced (object)

  Template enforcement setting.

• Changed property isReferenced (object)

  If this entity is referenced by an identity group and cannot be deleted.

• Changed property lastModifiedDate (object)

• Changed property networkCount (object)

  Number of networks associated with this pool.

GET /templates/wifiNetworks/{networkTemplateId}/dpskServices

Parameters:

Changed: networkTemplateId in path

Wifi network template id

Changed: pageable in query

parameters for paging

Return Type:

Changed response : 200 OK

DPSK pool template

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

  • Changed property createdDate (object)

  • Changed property id (object)

    Unique identifier for pool.

  • Changed property identityId (object)

    Deprecated. Use identity group ID instead.

  • Changed property isEnforced (object)

    Template enforcement setting.

  • Changed property isReferenced (object)

    If this entity is referenced by an identity group and cannot be deleted.

  • Changed property lastModifiedDate (object)

  • Changed property networkCount (object)

    Number of networks associated with this pool.

POST /edgeDhcpServices

Request:

DELETE /edgeDhcpServices/{dhcpId}

Parameters:

Changed: dhcpId in path

GET /edgeDhcpServices/{dhcpId}

Parameters:

Changed: dhcpId in path

PUT /edgeDhcpServices/{dhcpId}

Parameters:

Changed: dhcpId in path

Request:

PATCH /edgeDhcpServices/{dhcpId}

Parameters:

Changed: dhcpId in path

Request:

POST /edgeMulticastDnsProxyProfiles

Request:

Changed content type : application/json

• Changed property id (object)

  The identifier of the multicast DNS proxy.

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

• Changed property id (object)

  The identifier of the multicast DNS proxy.

GET /edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}

Parameters:

Changed: multicastDnsProxyProfileId in path

The ID of Multicast DNS profile.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property id (object)

    The identifier of the multicast DNS proxy.

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

  • Changed property id (object)

    The identifier of the multicast DNS proxy.

PUT /edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}

Parameters:

Changed: multicastDnsProxyProfileId in path

The ID of Multicast DNS profile.

Request:

Changed content type : application/json

• Changed property id (object)

  The identifier of the multicast DNS proxy.

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

• Changed property id (object)

  The identifier of the multicast DNS proxy.

DELETE /edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}

Parameters:

Changed: multicastDnsProxyProfileId in path

The ID of Multicast DNS profile.

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

Parameters:

Changed: venueId in path

The ID of venue.

Changed: clusterId in path

The ID of Edge cluster.

PUT /venues/{venueId}/edgeClusters/{clusterId}/arpTerminationSettings

Parameters:

Changed: venueId in path

The ID of venue.

Changed: clusterId in path

The ID of Edge cluster.

Request:

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

Parameters:

Changed: venueId in path

Changed: clusterId in path

Request:

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

Parameters:

Changed: venueId in path

Changed: clusterId in path

Changed: serialNumber in path

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

Parameters:

Changed: venueId in path

Changed: clusterId in path

Changed: serialNumber in path

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

Parameters:

Changed: venueId in path

Changed: clusterId in path

Changed: serialNumber in path

Request:

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

Parameters:

Changed: venueId in path

Changed: clusterId in path

Changed: serialNumber in path

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

Parameters:

Changed: venueId in path

Changed: clusterId in path

Changed: serialNumber in path

Request:

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

Parameters:

Changed: venueId in path

Changed: clusterId in path

Changed: serialNumber in path

The serial number of the EDGE.

Request:

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

Parameters:

Changed: venueId in path

Changed: clusterId in path

Changed: serialNumber in path

The SN of the Edge device

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

Parameters:

Changed: venueId in path

Changed: clusterId in path

Changed: serialNumber in path

The SN of the Edge device

Request:

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

Parameters:

Changed: venueId in path

Changed: clusterId in path

Changed: serialNumber in path

The SN of the Edge device

Changed: portId in path

The ID of the physical port

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

Parameters:

Changed: venueId in path

Changed: clusterId in path

Changed: serialNumber in path

The SN of the Edge device

Changed: portId in path

The ID of the physical port

Request:

Changed content type : application/json

• Changed property accessPortEnabled (object)

  Whether to mark this port as a access port.

• Changed property corePortEnabled (object)

  Whether to mark this port as a core port.

• Changed property id (object)

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

Parameters:

Changed: venueId in path

Changed: clusterId in path

Changed: serialNumber in path

The SN of the Edge device

Changed: portId in path

The ID of the physical port

Changed: subInterfaceId in path

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

Parameters:

Changed: venueId in path

Changed: clusterId in path

Changed: serialNumber in path

The SN of the Edge device

Changed: portId in path

The ID of the physical port

Changed: subInterfaceId in path

Request:

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

• Changed property accessPortEnabled (object)

  Whether to mark this port as a access port.

• Changed property corePortEnabled (object)

  Whether to mark this port as a core port.

• Changed property id (object)

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

Parameters:

Changed: venueId in path

Changed: clusterId in path

Changed: serialNumber in path

The SN of the Edge device

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

Parameters:

Changed: venueId in path

Changed: clusterId in path

Changed: serialNumber in path

The SN of the Edge device

Request:

PUT /venues/{venueId}/edgeClusters/{clusterId}/tunnelProfiles/{tunnelProfileId}

Parameters:

Changed: venueId in path

Changed: clusterId in path

Changed: tunnelProfileId in path

DELETE /venues/{venueId}/edgeClusters/{clusterId}/tunnelProfiles/{tunnelProfileId}

Parameters:

Changed: venueId in path

Changed: clusterId in path

Changed: tunnelProfileId in path

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

Parameters:

Changed: venueId in path

Changed: edgeClusterId in path

Changed: serialNumber in path

Request:

Changed content type : application/json

• Changed property accessPortEnabled (object)

  Whether to mark this port as a access port.

• Changed property corePortEnabled (object)

  Whether to mark this port as a core port.

• Changed property lagType (object)

  The type of the LAG only support the link aggregation control protocol.

• Changed property natEnabled (object)

  Whether to enable the network address translation on the wan port.

• Changed property reportIp (object)

  IP reported by edge device.

• Changed property reportSubnet (object)

  Sub-network mask reported by edge device.

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

• Changed property accessPortEnabled (object)

  Whether to mark this port as a access port.

• Changed property corePortEnabled (object)

  Whether to mark this port as a core port.

• Changed property lagType (object)

  The type of the LAG only support the link aggregation control protocol.

• Changed property natEnabled (object)

  Whether to enable the network address translation on the wan port.

• Changed property reportIp (object)

  IP reported by edge device.

• Changed property reportSubnet (object)

  Sub-network mask reported by edge device.

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

Parameters:

Changed: venueId in path

Changed: edgeClusterId in path

Changed: serialNumber in path

Changed: lagId in path

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property accessPortEnabled (object)

    Whether to mark this port as a access port.

  • Changed property corePortEnabled (object)

    Whether to mark this port as a core port.

  • Changed property lagType (object)

    The type of the LAG only support the link aggregation control protocol.

  • Changed property natEnabled (object)

    Whether to enable the network address translation on the wan port.

  • Changed property reportIp (object)

    IP reported by edge device.

  • Changed property reportSubnet (object)

    Sub-network mask reported by edge device.

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

  • Changed property accessPortEnabled (object)

    Whether to mark this port as a access port.

  • Changed property corePortEnabled (object)

    Whether to mark this port as a core port.

  • Changed property lagType (object)

    The type of the LAG only support the link aggregation control protocol.

  • Changed property natEnabled (object)

    Whether to enable the network address translation on the wan port.

  • Changed property reportIp (object)

    IP reported by edge device.

  • Changed property reportSubnet (object)

    Sub-network mask reported by edge device.