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.