# Switch Services # Overview The Switch Service REST API facilitates the management and configuration of RUCKUS ICX switches via the RUCKUS One platform. This API allows for programmatic control of switch operations, network configurations, security policies, and monitoring across various environments. ## What This API Does - Manage ICX switch devices and their configurations - Configure network settings including VLANs, ports, LAGs, and virtual ethernet interfaces - Control security policies with AAA servers, ACLs, and trusted port settings - Create and apply switch profiles and templates for consistent configurations - Handle firmware upgrades and configuration backups - Configure DHCP servers and static routing - Import and onboard new switches to the platform - Manage CLI templates and web authentication pages ## Authentication All API calls require valid authentication via JWT (JSON Web Token) in Authorization header. ## Regional Endpoints Select the appropriate API endpoint based on your region: - *North America*: https://api.ruckus.cloud - *Europe*: https://api.eu.ruckus.cloud - *Asia*: https://api.asia.ruckus.cloud ## Error Handling The API uses standard HTTP status codes with detailed error messages in the response body. ## Common Error Responses All endpoints may return these common error responses: - *400 Bad Request*: Invalid input data or validation errors - *401 Unauthorized*: Missing or invalid authentication - *403 Forbidden*: Insufficient permissions - *404 Not Found*: Requested resource doesn't exist - *422 Unprocessable Entity*: Business rule violations - *500 Internal Server Error*: Unexpected server errors. Version: 0.4.0 License: RUCKUS Cloud Privacy Policy ## Servers RUCKUS One API host for North American region. ``` https://api.ruckus.cloud ``` RUCKUS One API host for European region. ``` https://api.eu.ruckus.cloud ``` RUCKUS One API host for Asian region. ``` https://api.asia.ruckus.cloud ``` ## Security ### jwtAuth Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description - [Switch Services](https://docs.ruckus.cloud/_bundle/api/switch-0.4.0.yaml) ## Switch Configuration Templates - [GET /templates/venues/{venueId}/switchSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/getvenuetemplatesetting.md): Get the switch settings of the venue template. - [PUT /templates/venues/{venueId}/switchSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/updatevenuetemplatesetting.md): Update the switch settings of the venue template. Use activity API with request id to get the status update. - [PUT /templates/venues/{venueId}/switchProfiles/{switchProfileId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/associateprofiletemplate.md): Associate a regular switch profile template or command line interface profile template to venue template. - [DELETE /templates/venues/{venueId}/switchProfiles/{switchProfileId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/disassociateprofiletemplate.md): Disassociate a regular switch profile template or command line interface profile template to venue template. - [GET /templates/venues/{venueId}/aaaSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/getvenuetemplateaaasettings.md): Retrieve venue template's authentication, authorization, and accounting setting. - [PUT /templates/venues/{venueId}/aaaSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/updatevenuetemplateaaasetting.md): Update venue template's authentication, authorization, and accounting setting by id. Use activity API with request id to get the status update. Add prefix '/rec' for REC templates. - [GET /templates/venues/{venueId}/aaaServers/{aaaServerId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/getvenuetemplateaaaserver.md): Get venue template's authentication, authorization, and accounting server. Add prefix '/rec' for REC templates. - [PUT /templates/venues/{venueId}/aaaServers/{aaaServerId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/updatevenuetemplateaaaserver.md): Update venue template's authentication, authorization, and accounting server by id. Use activity API with request id to get the status update. - [DELETE /templates/venues/{venueId}/aaaServers/{aaaServerId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/deletevenuetemplateaaaserver.md): Delete venue template's authentication, authorization, and accounting server by id. Add prefix '/rec' for REC templates. - [GET /templates/switchProfiles/{switchProfileId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/getprofiletemplatebyid.md): Get a regular switch profile template or command line interface profile template. - [PUT /templates/switchProfiles/{switchProfileId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/updateprofiletemplate.md): Update a regular switch profile template or command line interface profile template. Use activity API with request id to get the status update. - [DELETE /templates/switchProfiles/{switchProfileId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/deleteprofiletemplatebyid.md): Delete a regular switch profile template or command line interface profile template. - [POST /templates/venues/{venueId}/aaaServers](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/addvenuetemplateaaaserver.md): Add venue template's authentication, authorization, and accounting server. Use activity API with request id to get the status update. - [DELETE /templates/venues/{venueId}/aaaServers](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/deletevenuetemplateaaaservers.md): Delete venue template's multiple authentication, authorization, and accounting servers. Add prefix '/rec' for REC templates. - [POST /templates/venues/{venueId}/aaaServers/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/queryvenuetemplateaaaservers.md): List of venue template's authentication, authorization, and accounting servers. Add prefix '/rec' for REC templates. - [POST /templates/switchProfiles](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/addprofiletemplate.md): Add a regular switch profile template or command line interface profile template. Use activity API with request id to get the status update. - [POST /templates/switchProfiles/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/queryprofiletemplates.md): List the regular switch profile templates or command line interface profile templates. - [GET /templates/venues/{venueId}/switchProfiles](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/getprofiletemplatesbyvenueid.md): Get regular switch profile templates or command line interface profile templates of the venue. - [PUT /templates/venues/{venueId}/aaaSettings/{aaaSettingId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/updatevenuetemplateaaasetting_1.md): Update venue template's authentication, authorization, and accounting setting by id. Use activity API with request id to get the status update. This method will be removed no sooner than 08/31/2026. T - [POST /templates/venues/aaaServers/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/queryvenuetemplateaaaservers_1.md): List of venue template's authentication, authorization, and accounting servers. This method will be removed no sooner than 08/31/2026. The following URL /templates/venues/{venueId}/aaaServers/query ca - [GET /templates/switchProfiles](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/getprofiletemplates.md): Get multiple regular switch profile templates or command line interface profile templates. This method will be removed no sooner than 08/31/2026. The following URL /templates/switchProfiles/{switchPro - [DELETE /templates/switchProfiles](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/deleteprofiletemplates.md): Delete multiple regular switch profile templates or command line interface profile templates. This method will be removed no sooner than 08/31/2026. The following URL /templates/switchProfiles/{switch - [GET /templates/venues/aaaServers/{aaaServerId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/getvenuetemplateaaaserver_1.md): Get venue template's authentication, authorization, and accounting server. This method will be removed no sooner than 08/31/2026. The following URL /templates/venues/{venueId}/aaaServers/{aaaServerId} - [DELETE /templates/venues/aaaServers/{aaaServerId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/deletevenuetemplateaaaserver_1.md): Delete venue template's authentication, authorization, and accounting server by id. This method will be removed no sooner than 08/31/2026. The following URL /templates/venues/{venueId}/aaaServers/{aaa - [DELETE /templates/venues/aaaServers](https://docs.ruckus.cloud/api/switch-0.4.0/switch-configuration-templates/deletevenuetemplateaaaservers_1.md): Delete venue template's multiple authentication, authorization, and accounting servers. This method will be removed no sooner than 08/31/2026. The following URL /templates/venues/{venueId}/aaaServers ## Switch Interfaces - [GET /venues/{venueId}/switches/{switchId}/vePorts/{vePortId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getveport.md): Get a specified virtual ethernet port. - [PUT /venues/{venueId}/switches/{switchId}/vePorts/{vePortId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/updateveport.md): Update virtual ethernet port. - [DELETE /venues/{venueId}/switches/{switchId}/vePorts/{vePortId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/deleteveport.md): Delete virtual ethernet port. - [GET /venues/{venueId}/switches/{switchId}/portSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getswitchportsbyswitchid.md): Get switch's port settings by switch id. - [PUT /venues/{venueId}/switches/{switchId}/portSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/updateportsettings.md): Update switch's port setting. Use activity API with request id to get the status update. - [POST /venues/{venueId}/switches/{switchId}/portSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getswitchportsbyportids.md): Get switch's port settings with port ids. - [GET /venues/{venueId}/switches/{switchId}/lags/{lagId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getlag.md): Get LAG setting by id. - [PUT /venues/{venueId}/switches/{switchId}/lags/{lagId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/updatelag.md): Update switch's LAG setting. - [DELETE /venues/{venueId}/switches/{switchId}/lags/{lagId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/deletelag.md): Delete switch's LAG setting. - [PUT /venues/{venueId}/switches/portSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/updateportsamongswitches.md): Update ports of different switches. Use activity API with request id to get the status update. - [POST /venues/{venueId}/switches/portSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getportsamongswitches.md): Get port settings of different switches. - [POST /venues/{venueId}/vePorts/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getveportsbyvenuequery.md): Retrieve virtual ethernet ports of venue by query. - [GET /venues/{venueId}/switches/{switchId}/vePorts](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getveportsbyswitch.md): Retrieve virtual ethernet ports of the specified switch. - [POST /venues/{venueId}/switches/{switchId}/vePorts](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/addveports.md): Add virtual ethernet ports of the switch. - [DELETE /venues/{venueId}/switches/{switchId}/vePorts](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/deleteveports.md): Delete multiple virtual ethernet ports. - [POST /venues/{venueId}/switches/{switchId}/vePorts/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getveportsbyquery.md): Retrieve virtual ethernet ports of switch by query. - [GET /venues/{venueId}/switches/{switchId}/lags](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getlags.md): List of switch's LAG settings. - [POST /venues/{venueId}/switches/{switchId}/lags](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/addlags.md): Add switch's multiple LAG settings. - [DELETE /venues/{venueId}/switches/{switchId}/lags](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/deletelags.md): Delete switch's multiple LAG settings. - [POST /venues/{venueId}/switches/powerCycleRequests](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/powercycleport.md): Power cycle switch's port. Use activity API with request id to get the status update. - [GET /switches/{switchId}/portSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getswitchportsbyswitchid_1.md): Get switch's port settings by switch id. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/portSettings can be used for this content. - [PUT /switches/{switchId}/portSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/updateportsettings_1.md): Update switch's port setting. Use activity API with request id to get the status update. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/ - [POST /switches/{switchId}/portSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getswitchportsbyportids_1.md): Get switch's port settings with port ids. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/portSettings can be used for this content. - [GET /switches/vePorts/{vePortId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getveport_1.md): Get a specified virtual ethernet port. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vePorts/{vePortId} can be used for this content. - [PUT /switches/vePorts/{vePortId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/updateveport_1.md): Update virtual ethernet port. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vePorts/{vePortId} can be used for this content. - [DELETE /switches/vePorts/{vePortId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/deleteveport_1.md): Delete virtual ethernet port. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vePorts/{vePortId} can be used for this content. - [PUT /switches/portSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/updateportsamongswitches_1.md): Update ports of different switches. Use activity API with request id to get the status update. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/portS - [POST /switches/portSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getportsamongswitches_1.md): Get port settings of different switches. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/portSettings can be used for this content. - [GET /switches/lags/{lagId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getlag_1.md): Get LAG setting by id. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/lags/{lagId} can be used for this content. - [PUT /switches/lags/{lagId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/updatelag_1.md): Update switch's LAG setting. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/lags/{lagId} can be used for this content. - [DELETE /switches/lags/{lagId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/deletelag_1.md): Delete switch's LAG setting. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/lags/{lagId} can be used for this content. - [GET /switchProfiles/{switchProfileId}/trustedPorts/{trustedPortId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/gettrustedport.md): Get the specified trusted port of the switch profile. This method will be removed no sooner than 08/31/2026. - [PUT /switchProfiles/{switchProfileId}/trustedPorts/{trustedPortId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/updatetrustedport.md): Update the trusted port of the switch profile. This method will be removed no sooner than 08/31/2026. - [DELETE /switchProfiles/{switchProfileId}/trustedPorts/{trustedPortId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/deletetrustedport.md): Delete the specified trusted port of the switch profile. This method will be removed no sooner than 08/31/2026. - [GET /switches/{switchId}/vePorts](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getveportsbyswitch_1.md): Retrieve virtual ethernet ports of the specified switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vePorts can be used for this con - [POST /switches/{switchId}/vePorts](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/addveports_1.md): Add virtual ethernet ports of the switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vePorts can be used for this content. - [POST /switches/{switchId}/vePorts/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getveportsbyquery_1.md): Retrieve virtual ethernet ports of switch by query. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vePorts/query can be used for this co - [GET /switches/{switchId}/lags](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/getlags_1.md): List of switch's LAG settings. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/lags can be used for this content. - [POST /switches/{switchId}/lags](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/addlags_1.md): Add switch's multiple LAG settings. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/lags can be used for this content. - [POST /switchProfiles/{switchProfileId}/trustedPorts](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/addtrustedport.md): Add the trusted port of the switch profile. This method will be removed no sooner than 08/31/2026. - [DELETE /switchProfiles/{switchProfileId}/trustedPorts](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/deletetrustedports.md): Delete multiple trusted ports of the specified switch profile. This method will be removed no sooner than 08/31/2026. - [GET /venues/{venueId}/trustedPorts](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/gettrustedportsbyvenue.md): Retrieve trusted ports with the specified venue. This method will be removed no sooner than 08/31/2026. - [DELETE /switches/vePorts](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/deleteveports_1.md): Delete multiple virtual ethernet ports. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vePorts can be used for this content. - [DELETE /switches/lags](https://docs.ruckus.cloud/api/switch-0.4.0/switch-interfaces/deletelags_1.md): Delete switch's multiple LAG settings. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/lags can be used for this content. ## Switch Maintenance - [PUT /venues/{venueId}/switchFirmwares/schedules](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/changeupdateschedulev1001.md): Schedule the firmware upgrade for venues. Use activity API with request id to get the status update. - [POST /venues/{venueId}/switchFirmwares/schedules](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/updateschedule.md): Schedule the firmware upgrade for venues. Use activity API with request id to get the status update. - [DELETE /venues/{venueId}/switchFirmwares/schedules](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/skipupgradeschedule.md): Cancel the schedule for firmware upgrade. - [POST /venues/{venueId}/transactions/{transactionId}/configHistDetails](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getvenueconfigurationhistorydetailbytransaction.md): Get the configuration history details for this transaction relative to the switches in this venue. - [POST /venues/{venueId}/switches/{switchId}/configHistDetails/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getallconfigurationhistdetailsbyswitch.md): Query for configuration history details on this switch. - [GET /venues/{venueId}/switches/{switchId}/configBackups](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getconfigbackupsbyswitch.md): List of switch's configuration backup. - [POST /venues/{venueId}/switches/{switchId}/configBackups](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/addswitchconfigbackup.md): Create a switch's configuration backup. - [DELETE /venues/{venueId}/switches/{switchId}/configBackups](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/deleteswitchconfigbackups.md): Delete switch's configuration backups. - [POST /venues/{venueId}/switches/{switchId}/configBackups/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getswitchconfigbackupsbyquery.md): Query the switch's configuration backups. - [POST /venues/{venueId}/switches/{switchId}/configBackups/comparisons](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/compareswitchconfigbackups.md): Compare switch's configuration backups. - [POST /venues/{venueId}/configHistories/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getconfigurationhistorybyvenue.md): Query for configuration history details for switches in this venue. - [POST /switchFirmwares/schedules/switches/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getupgradeswitches_1.md): Get all switches by tenant id for upgrading. - [POST /switchFirmwares/schedules/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getupgradevenues_1.md): Get all venues by tenant id for upgrading. - [GET /venues/{venueId}/switches/{switchId}/configBackups/{configBackupId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getswitchconfigbackupbyid_1.md): Get a switch's configuration backup. - [DELETE /venues/{venueId}/switches/{switchId}/configBackups/{configBackupId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/deleteswitchconfigbackupbyid_1.md): Delete switch's configuration backup by id. - [PATCH /venues/{venueId}/switches/{switchId}/configBackups/{configBackupId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/restoreswitchbyconfigbackup_1.md): Restore switch's configuration backup. - [GET /venues/{venueId}/switches/{switchId}/transactions/{transactionId}/configHistDetails](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/retrieveswitchconfigurationhistdetailbytransaction.md): Get the configuration history details of this transaction on this switch. - [GET /venues/{venueId}/switches/{switchId}/configBackups/{configBackupId}/formattedConfigs](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getformattedconfigbackup.md): Retrieve formatted string representation of switch's configuration backup for convert to template. - [GET /switchFirmwares/versions/{versionType}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getversions_1.md): Get different version type of firmware. - [GET /switchFirmwares/currentVersions](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getcurrentversionsbyvenues_1.md): Get current versions of the venues. - [GET /switches/configBackups/{configBackupId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getswitchconfigbackupbyid.md): Get a switch's configuration backup. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/configBackups/{configBackupId} can be used for this - [PUT /switches/configBackups/{configBackupId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/restoreswitchbyconfigbackup.md): Restore switch's configuration backup. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/configBackups/{configBackupId} with PATCH method c - [DELETE /switches/configBackups/{configBackupId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/deleteswitchconfigbackupbyid.md): Delete switch's configuration backup by id. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/configBackups/{configBackupId} can be used fo - [POST /venues/switchFirmwares/upgradeStatusDetails/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getupgradestatusdetails.md): Get venue upgrade status by venue id for upgrading. This method will be removed no sooner than 08/31/2026. - [POST /venues/switchFirmwares/switches/schedules/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getupgradeswitches.md): Get all switches by tenant id for upgrading. This method will be removed no sooner than 08/31/2026. The following URL /switchFirmwares/schedules/switches/query can be used for this content. - [POST /venues/switchFirmwares/schedules](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/updateschedule_1.md): Schedule the firmware upgrade for venues. Use activity API with request id to get the status update. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switchFi - [DELETE /venues/switchFirmwares/schedules](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/skipupgradeschedule_1.md): Cancel the schedule for firmware upgrade. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switchFirmwares/schedules can be used for this content. - [POST /venues/switchFirmwares/schedules/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getupgradevenues.md): Get all venues by tenant id for upgrading. This method will be removed no sooner than 08/31/2026. The following URL /switchFirmwares/schedules/query can be used for this content. - [POST /switches/{switchId}/configHistDetails/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getallconfigurationhistdetailsbyswitch_1.md): Query for configuration history details on this switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/configHistDetails/query can be us - [GET /switches/{switchId}/configBackups](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getconfigbackupsbyswitch_1.md): List of switch's configuration backup. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/configBackups can be used for this content. - [POST /switches/{switchId}/configBackups](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/addswitchconfigbackup_1.md): Create a switch's configuration backup. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/configBackups can be used for this content. - [POST /switches/{switchId}/configBackups/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getswitchconfigbackupsbyquery_1.md): Query the switch's configuration backups. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/configBackups/query can be used for this conten - [POST /switches/configBackups/comparisons](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/compareswitchconfigbackups_1.md): Compare switch's configuration backups. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/configBackups/comparisons can be used for this co - [GET /venues/switchFirmwares/versions/{versionType}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getversions.md): Get different version type of firmware. This method will be removed no sooner than 08/31/2026. The following URL /switchFirmwares/versions/{versionType} can be used for this content. - [GET /venues/switchFirmwares/currentVersions](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/getcurrentversionsbyvenues.md): Get current versions of the venues. This method will be removed no sooner than 08/31/2026. The following URL /switchFirmwares/currentVersions can be used for this content. - [GET /switches/{switchId}/transactions/{transactionId}/configHistDetails](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/retrieveswitchconfigurationhistdetailbytransaction_1.md): Get the configuration history details of this transaction on this switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/transactions/{t - [DELETE /switches/configBackups](https://docs.ruckus.cloud/api/switch-0.4.0/switch-maintenance/deleteswitchconfigbackups_1.md): Delete switch's configuration backups. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/configBackups can be used for this content. ## Switch Network Config - [GET /venues/{venueId}/switches/{switchId}/vlans/{vlanId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/getswitchvlan.md): Get the specified switch level VLAN by id. - [PUT /venues/{venueId}/switches/{switchId}/vlans/{vlanId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/updateswitchvlan.md): Update a VLAN of the switch. - [DELETE /venues/{venueId}/switches/{switchId}/vlans/{vlanId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/deleteswitchvlan.md): Delete a VLAN of the switch. - [GET /venues/{venueId}/switches/{switchId}/staticRoutes/{staticRouteId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/getstaticroutebyid.md): Get the specified static route. - [PUT /venues/{venueId}/switches/{switchId}/staticRoutes/{staticRouteId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/updatestaticroute.md): Update the specified static route. - [DELETE /venues/{venueId}/switches/{switchId}/staticRoutes/{staticRouteId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/deletestaticroute.md): Delete the specified static route. - [GET /venues/{venueId}/switches/{switchId}/dhcpServers/{dhcpServerId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/getswitchdhcpserversetting.md): Get switch's DHCP server setting. - [PUT /venues/{venueId}/switches/{switchId}/dhcpServers/{dhcpServerId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/updateswitchdhcpserversettings.md): Update switch's DHCP server setting. - [DELETE /venues/{venueId}/switches/{switchId}/dhcpServers/{dhcpServerId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/deleteswitchdhcpserversetting.md): Delete switch's DHCP server setting. - [POST /venues/{venueId}/vlans](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/addswitchvlans.md): Create multiple VLANs under the specified switches. - [POST /venues/{venueId}/vlans/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/getswitchvlanbyswitchids.md): Retrieve all usable VLANs under the specified switches. - [GET /venues/{venueId}/switches/{switchId}/vlans](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/getvlanbyvenuewithveportsinfobyswitchid.md): List all usable VLANs that are available for the VE setting. - [POST /venues/{venueId}/switches/{switchId}/vlans](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/addswitchvlan.md): Create a VLAN of the switch. - [DELETE /venues/{venueId}/switches/{switchId}/vlans](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/deleteswitchvlans.md): Delete multiple VLANs of the switch. - [POST /venues/{venueId}/switches/{switchId}/vlans/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/queryswitchvlans.md): Query the switch's switch level VLANs. - [GET /venues/{venueId}/switches/{switchId}/staticRoutes](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/getstaticroutesbyswitchid.md): Get multiple static routes of the switch. - [POST /venues/{venueId}/switches/{switchId}/staticRoutes](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/addstaticroutes.md): Add multiple static routes of the switch. - [DELETE /venues/{venueId}/switches/{switchId}/staticRoutes](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/deletestaticroutes.md): Delete multiple static routes. - [POST /venues/{venueId}/switches/{switchId}/dhcpServers](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/addswitchdhcpserversettings_1.md): Add switch's DHCP server settings. Use activity API with request id to get the status update. - [DELETE /venues/{venueId}/switches/{switchId}/dhcpServers](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/deleteswitchdhcpserversettings_1.md): Delete switch's DHCP servers. - [POST /venues/{venueId}/switches/{switchId}/dhcpServers/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/listoficxdhcpservers.md): List of ICX DHCP servers. - [PATCH /venues/{venueId}/switches/{switchId}/dhcpServerStates](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/changeswitchdhcpserverstate_1.md): Change switch's DHCP server state. Use activity API with request id to get the status update. - [GET /venues/{venueId}/vlanUnions](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/getvlanunionbyvenue.md): List all usable VLANs under this venue. - [PUT /switches/{switchId}/dhcpServers](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/updateswitchdhcpserversettings_1.md): Update switch's DHCP server setting. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/dhcpServers/{dhcpServerId} can be used for this cont - [POST /switches/{switchId}/dhcpServers](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/addswitchdhcpserversettings.md): Add switch's DHCP server settings. Use activity API with request id to get the status update. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switc - [DELETE /switches/{switchId}/dhcpServers](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/deleteswitchdhcpserversettings.md): Delete switch's DHCP servers. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/dhcpServers can be used for this content. - [GET /switches/vlans/{vlanId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/getswitchvlan_1.md): Get the specified switch level VLAN by id. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vlans/{vlanId} can be used for this content. - [PUT /switches/vlans/{vlanId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/updateswitchvlan_1.md): Update a VLAN of the switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vlans/{vlanId} can be used for this content. - [DELETE /switches/vlans/{vlanId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/deleteswitchvlan_1.md): Delete a VLAN of the switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vlans/{vlanId} can be used for this content. - [GET /switches/staticRoutes/{staticRouteId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/getstaticroutebyid_1.md): Get the specified static route. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/staticRoutes/{staticRouteId} can be used for this content - [PUT /switches/staticRoutes/{staticRouteId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/updatestaticroute_1.md): Update the specified static route. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/staticRoutes/{staticRouteId} can be used for this cont - [DELETE /switches/staticRoutes/{staticRouteId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/deletestaticroute_1.md): Delete the specified static route. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/staticRoutes/{staticRouteId} can be used for this cont - [GET /switches/{switchId}/vlans](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/getswitchvlans.md): Get switch level VLANs by switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vlans can be used for this content. - [POST /switches/{switchId}/vlans](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/addswitchvlan_1.md): Create a VLAN of the switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vlans can be used for this content. - [POST /switches/{switchId}/vlans/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/queryswitchvlans_1.md): Query the switch's switch level VLANs. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vlans/query can be used for this content. - [GET /switches/{switchId}/staticRoutes](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/getstaticroutesbyswitchid_1.md): Get multiple static routes of the switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/staticRoutes can be used for this content. - [POST /switches/{switchId}/staticRoutes](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/addstaticroutes_1.md): Add multiple static routes of the switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/staticRoutes can be used for this content. - [POST /switches/{switchId}/dhcpServers/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/listoficxdhcpservers_1.md): List of ICX's DHCP servers. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/dhcpServers/query can be used for this content. - [POST /switches/{switchId}/dhcpServerStateSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/changeswitchdhcpserverstate.md): Change switch's DHCP server state. Use activity API with request id to get the status update. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switc - [POST /switches/vlans](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/addswitchvlans_1.md): Create multiple VLANs under the specified switches. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/vlans can be used for this content. - [DELETE /switches/vlans](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/deleteswitchvlans_1.md): Delete multiple VLANs of the switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vlans can be used for this content. - [POST /switches/vlans/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/getswitchvlanbyswitchids_1.md): Retrieve all usable VLANs under the specified switches. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/vlans/query can be used for this content. - [POST /switches/dhcpServers/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/listofvenuedhcpservers.md): List of venue's DHCP servers. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/dhcpServers/query can be used for this content. - [GET /switches/dhcpServers/{dhcpServerId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/getswitchdhcpserversetting_1.md): Get switch's DHCP server setting. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/dhcpServers/{dhcpServerId} can be used for this content - [DELETE /switches/{switchId}/dhcpServers/{dhcpServerId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/deleteswitchdhcpserversetting_1.md): Delete switch's DHCP server setting. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/dhcpServers/{dhcpServerId} can be used for this cont - [DELETE /switches/staticRoutes](https://docs.ruckus.cloud/api/switch-0.4.0/switch-network-config/deletestaticroutes_1.md): Delete multiple static routes. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/staticRoutes can be used for this content. ## Switch Profiles - [PUT /venues/{venueId}/switchProfiles/{switchProfileId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/associateprofile.md): Associate a switch profile to a venue. - [DELETE /venues/{venueId}/switchProfiles/{switchProfileId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/disassociateprofile.md): Disassociate a switch profile to a venue. - [PUT /venues/{venueId}/cliTemplates/{cliTemplateId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/associateclitemplate.md): Associate command line interface templates to switches. - [DELETE /venues/{venueId}/cliTemplates/{cliTemplateId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/disassociateclitemplate.md): Disassociate command line interface templates to switches. - [GET /switchProfiles/{switchProfileId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/getprofilebyid.md): Get a regular switch profile or command line interface profile. - [PUT /switchProfiles/{switchProfileId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/updateprofile.md): Update a regular switch profile or command line interface profile. Use activity API with request id to get the status update. - [DELETE /switchProfiles/{switchProfileId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/deleteprofilebyid.md): Delete a regular switch profile or command line interface profile. - [GET /cliTemplates/{cliTemplateId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/getclitemplate.md): Get a command line interface template by id. - [PUT /cliTemplates/{cliTemplateId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/updateclitemplate.md): Update a command line interface template for switches by id. - [DELETE /cliTemplates/{cliTemplateId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/deleteclitemplate.md): Delete a command line interface template by id. - [POST /switchProfiles](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/addprofile.md): Add a regular switch profile or command line interface profile. Use activity API with request id to get the status update. - [POST /switchProfiles/{switchProfileId}/vlans](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/addvlan.md): Create a VLAN of the switch profile. - [POST /switchProfiles/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/queryprofiles.md): List the regular switch profiles or command line interface profiles. - [POST /cliTemplates](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/addclitemplate.md): Create a command line interface template for switches. - [DELETE /cliTemplates](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/deleteclitemplates.md): Delete command line interface templates. - [POST /cliTemplates/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/queryclitemplates.md): Get a list of command line interface templates by query. - [GET /venues/{venueId}/switches/{switchId}/vlanUnions](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/getvlanunion.md): List all usable VLANs for multiple ports of the same switch. - [GET /venues/{venueId}/switchProfiles](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/getprofilesbyvenueid.md): Get regular switch profiles or command line interface profiles of the venue. - [GET /venues/{venueId}/switchProfiles/vlans](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/getvlansbyvenue.md): Get a list of VLANs in profiles with the specified venue. - [GET /cliTemplates/examples](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/getclitemplates_1.md): Get a list of command line interface template examples. - [GET /switchProfiles/{switchProfileId}/vlans/{vlanId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/getvlanbyuuid.md): Get the specified VLAN of the switch profile. This method will be removed no sooner than 08/31/2026. - [PUT /switchProfiles/{switchProfileId}/vlans/{vlanId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/updatevlan.md): Update the VLAN of the switch profile. This method will be removed no sooner than 08/31/2026. - [DELETE /switchProfiles/{switchProfileId}/vlans/{vlanId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/deletevlanbyuuid.md): Delete the specified VLAN of the switch profile. This method will be removed no sooner than 08/31/2026. - [GET /switchProfiles/{switchProfileId}/acls/{aclId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/getaclbyid.md): Get the ACL of the switch profile. This method will be removed no sooner than 08/31/2026. - [PUT /switchProfiles/{switchProfileId}/acls/{aclId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/updateprofileacl.md): Update the ACL of the switch profile. This method will be removed no sooner than 08/31/2026. - [DELETE /switchProfiles/{switchProfileId}/acls/{aclId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/deleteprofileacl.md): Delete ACL of the switch profile. This method will be removed no sooner than 08/31/2026. - [GET /venues/{venueId}/vlans](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/getvlansbyvenueandmodel.md): List all of VLANs in profiles with the specified venue and the specific model. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switchProfiles/vlans can be us - [POST /venues/{venueId}/untaggedVlans/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/getuntaggedvlansbyvenue.md): List of venues switch profile VLANs with specific model and untagged port. This method will be removed no sooner than 08/31/2026. - [POST /venues/{venueId}/taggedVlans/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/gettaggedvlansbyvenue.md): List of venues switch profile VLANs with specific model and tagged port. This method will be removed no sooner than 08/31/2026. - [GET /switchProfiles](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/getprofiles.md): Get multiple regular switch profiles or command line interface profiles. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switchProfiles can be used for this - [DELETE /switchProfiles](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/deleteprofiles.md): Delete multiple regular switch profiles or command line interface profiles. This method will be removed no sooner than 08/31/2026. The following URL /switchProfiles/{switchProfileId} can be used for t - [GET /switchProfiles/{switchProfileId}/vlans](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/getvlans.md): Get multiple VLANs of the switch profile. This method will be removed no sooner than 08/31/2026. - [DELETE /switchProfiles/{switchProfileId}/vlans](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/deletevlans.md): Delete multiple VLANs of the switch profile. This method will be removed no sooner than 08/31/2026. - [GET /switchProfiles/{switchProfileId}/acls](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/getacls.md): Get multiple ACLs of the switch profile. This method will be removed no sooner than 08/31/2026. - [POST /switchProfiles/{switchProfileId}/acls](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/addprofileacl.md): Add the ACL of the switch profile. This method will be removed no sooner than 08/31/2026. - [DELETE /switchProfiles/{switchProfileId}/acls](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/deleteprofileacls.md): Delete multiple ACLs of the switch profile. This method will be removed no sooner than 08/31/2026. - [GET /cliTemplates](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/getclitemplates.md): Get a list of command line interface templates. This method will be removed no sooner than 08/31/2026. The following URL /cliTemplates/{cliTemplateId} can be used for this content. - [GET /venues/{venueId}/switchProfiles/acls](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/getaclsbyvenueid.md): Get all ACLs of switch profiles in the venue. This method will be removed no sooner than 08/31/2026. - [GET /switches/{switchId}/vlanUnions](https://docs.ruckus.cloud/api/switch-0.4.0/switch-profiles/getvlanunion_1.md): List all usable VLANs for multiple ports of the same switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/vlanUnions can be used for t ## Switch Security - [GET /webAuthPageTemplates/{templateId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/getwebauthpagetemplate.md): Get a web authentication page template by id. - [PUT /webAuthPageTemplates/{templateId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/putwebauthpagetemplate.md): Update web authentication page template by id. - [DELETE /webAuthPageTemplates/{templateId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/deletewebauthpagetemplate.md): Delete web authentication page template by id. - [GET /venues/{venueId}/aaaSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/getaaasettings.md): Retrieve venue's authentication, authorization, and accounting setting. - [PUT /venues/{venueId}/aaaSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/putaaasetting.md): Update authentication, authorization, and accounting setting by id. Use activity API with request id to get the status update. - [GET /venues/{venueId}/aaaServers/{aaaServerId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/getaaaserver.md): Get a switch's authentication, authorization, and accounting server setting. - [PUT /venues/{venueId}/aaaServers/{aaaServerId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/putaaaserver.md): Update authentication, authorization, and accounting server by id. Use activity API with request id to get the status update. - [DELETE /venues/{venueId}/aaaServers/{aaaServerId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/deleteaaaserver.md): Delete authentication, authorization, and accounting server by id. - [POST /webAuthPageTemplates](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/addwebauthpagetemplate.md): Add web authentication page template. - [POST /webAuthPageTemplates/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/querywebauthpagetemplates.md): List of tenant's web authentication page templates. - [POST /venues/{venueId}/switches/{switchId}/acls/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/getswitchaclsbyquery.md): Get switch ACLs by query criteria. - [POST /venues/{venueId}/aaaServers](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/addaaaserver.md): Add authentication, authorization, and accounting server. Use activity API with request id to get the status update. - [DELETE /venues/{venueId}/aaaServers](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/deleteaaaservers.md): Delete multiple authentication, authorization, and accounting servers. - [POST /venues/{venueId}/aaaServers/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/queryaaaservers.md): List of venue's authentication, authorization, and accounting servers. - [GET /webAuthPageTemplates/{templateId}/switches](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/getwebauthpagetemplateswitchinfo.md): Get a web authentication page template's switch info by id. - [GET /venues/{venueId}/switches/{switchId}/acls](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/getaclsbyswitch.md): Get all ACLs of the switch. - [GET /venues/{venueId}/switches/{switchId}/aclUnions](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/getaclunion.md): List all usable ACLs for this switch (the union of venue and device levels). - [PUT /venues/{venueId}/aaaSettings/{aaaSettingId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/putaaasetting_1.md): Update authentication, authorization, and accounting setting by id. Use activity API with request id to get the status update. This method will be removed no sooner than 08/31/2026. The following URL - [POST /venues/aaaServers/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/queryaaaservers_1.md): List of venue's authentication, authorization, and accounting servers. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/aaaServers/query can be used for this - [POST /switches/{switchId}/acls/query](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/getswitchaclsbyquery_1.md): Query the switch's switch level ACLs. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/acls/query can be used for this content. - [GET /venues/aaaServers/{aaaServerId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/getaaaserver_1.md): Get a switch's authentication, authorization, and accounting server setting. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/aaaServers/{aaaServerId} can be - [DELETE /venues/aaaServers/{aaaServerId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/deleteaaaserver_1.md): Delete authentication, authorization, and accounting server by id. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/aaaServers/{aaaServerId} can be used for t - [GET /switches/{switchId}/acls](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/getaclsbyswitch_1.md): Get all ACLs of the switch. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/acls can be used for this content. - [GET /switches/{switchId}/aclUnions](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/getaclunion_1.md): List all usable ACLs for this switch (the union of venue and device levels). This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId}/aclUnions ca - [GET /switches/acls/{aclId}](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/getaclbyid_1.md): Get the ACL of the switch. This method will be removed no sooner than 08/31/2026. - [DELETE /venues/aaaServers](https://docs.ruckus.cloud/api/switch-0.4.0/switch-security/deleteaaaservers_1.md): Delete multiple authentication, authorization, and accounting servers. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/aaaServers can be used for this conten ## Switches - [GET /venues/{venueId}/switches/{switchId}](https://docs.ruckus.cloud/api/switch-0.4.0/switches/getswitchbyid.md): Get ICX switch by id. - [PUT /venues/{venueId}/switches/{switchId}](https://docs.ruckus.cloud/api/switch-0.4.0/switches/updateswitchbyid.md): Update ICX switch. Use activity API with request id to get the status update. - [POST /venues/{venueId}/switches/{switchId}](https://docs.ruckus.cloud/api/switch-0.4.0/switches/addswitch.md): Add an ICX switch. Use activity API with request id to get the status update. - [DELETE /venues/{venueId}/switches/{switchId}](https://docs.ruckus.cloud/api/switch-0.4.0/switches/deleteswitchbyid.md): Delete ICX switch by id. - [PUT /venues/{venueId}/switches/{switchId}/positions](https://docs.ruckus.cloud/api/switch-0.4.0/switches/updateswitchposition.md): Update ICX switch position in the floor plan. - [GET /venues/{venueId}/switchSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switches/getvenuesetting.md): Get the switch settings of the venue. - [PUT /venues/{venueId}/switchSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switches/updatevenuesetting.md): Update the switch settings of the venue. Use activity API with request id to get the status update. - [GET /venues/{venueId}/switches](https://docs.ruckus.cloud/api/switch-0.4.0/switches/getswitchesbyvenue.md): Retrieve list of venues' ICX switches. - [POST /venues/{venueId}/switches](https://docs.ruckus.cloud/api/switch-0.4.0/switches/addmultipleswitches.md): Add multiple ICX switches. Use activity API with request id to get the status update. - [DELETE /venues/{venueId}/switches](https://docs.ruckus.cloud/api/switch-0.4.0/switches/deletemultipleswitches.md): Delete multiple ICX switches. - [POST /venues/{venueId}/switches/{switchId}/deviceRequests](https://docs.ruckus.cloud/api/switch-0.4.0/switches/devicerequests.md): Execute sync or reboot command on the specified switch device. - [POST /venues/{venueId}/switches/importRequests](https://docs.ruckus.cloud/api/switch-0.4.0/switches/importswitches.md): Add switches by CSV file. Use activity API with request id to get the status update. - [POST /venues/{venueId}/deviceRequests](https://docs.ruckus.cloud/api/switch-0.4.0/switches/multipledevicerequests.md): Execute batch operations on multiple switch devices. Supported actions include sync venue admin password and cycle port. - [POST /venues/switches/csvFile](https://docs.ruckus.cloud/api/switch-0.4.0/switches/importswitches_2.md): Add switches cross venues by CSV file. Use activity API with request id to get the status update. - [GET /venues/{venueId}/switches/importResults](https://docs.ruckus.cloud/api/switch-0.4.0/switches/getswitchesimportresult.md): Get download URL and import result. - [DELETE /venues/{venueId}/stacks/{stackSwitchSerialNumber}](https://docs.ruckus.cloud/api/switch-0.4.0/switches/deletestackmember.md): Delete a specific stack member. - [DELETE /venues/{venueId}/switchSettings](https://docs.ruckus.cloud/api/switch-0.4.0/switches/deletevenueswitchsettings.md): Delete switch settings of the venue. This method will be removed no sooner than 08/31/2026.The following URL /venues/{venueId}/switchSettings with PUT method can be used for this content. - [GET /switches/{switchId}](https://docs.ruckus.cloud/api/switch-0.4.0/switches/getswitchbyid_1.md): Get ICX switch by id. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId} can be used for this content. - [PUT /switches/{switchId}](https://docs.ruckus.cloud/api/switch-0.4.0/switches/updateswitchbyid_1.md): Update ICX switch. Use activity API with request id to get the status update. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId} can be used - [DELETE /switches/{switchId}](https://docs.ruckus.cloud/api/switch-0.4.0/switches/deleteswitchbyid_1.md): Delete ICX switch by id. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/{switchId} can be used for this content. - [POST /venues/switches](https://docs.ruckus.cloud/api/switch-0.4.0/switches/importswitches_1.md): Add switches by CSV file. Use activity API with request id to get the status update. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches/importRequests - [GET /switches](https://docs.ruckus.cloud/api/switch-0.4.0/switches/getswitchesoftenant.md): List of tenant's ICX switches. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches can be used for this content. - [POST /switches](https://docs.ruckus.cloud/api/switch-0.4.0/switches/addmultipleswitches_1.md): Add multiple ICX switches. Use activity API with request id to get the status update. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches can be used fo - [DELETE /switches](https://docs.ruckus.cloud/api/switch-0.4.0/switches/deletemultipleswitches_1.md): Delete multiple ICX switches. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/switches can be used for this content. - [POST /switches/{switchId}/deviceRequests](https://docs.ruckus.cloud/api/switch-0.4.0/switches/devicerequests_1.md): Execute sync or reboot command on the specified switch device, no need to provide switch id list on the request body. This method will be removed no sooner than 08/31/2026. The following URL /venues/{ - [POST /switches/deviceRequests](https://docs.ruckus.cloud/api/switch-0.4.0/switches/syncvenueadminpasswordmultipledevicerequests.md): Execute sync venues admin password on multiple switch devices, switch id list should be provided on the request body. This method will be removed no sooner than 08/31/2026. The following URL /venues/{ - [DELETE /stacks/{stackSwitchSerialNumber}](https://docs.ruckus.cloud/api/switch-0.4.0/switches/deletestackmember_1.md): Delete a specific stack member. This method will be removed no sooner than 08/31/2026. The following URL /venues/{venueId}/stacks/{stackSwitchSerialNumber} can be used for this content.