Skip to content
Switch Services/
/
Delete Switch Profile Tem...

Switch Services (0.4.0)

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.
Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
Terms of Service
Languages
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

AAA Server

Manage AAA (authentication, authorization, and accounting) servers.

Operations

AAA Setting

Manage AAA (authentication, authorization, and accounting) settings.

Operations

Command Line Interface Template

Manage command line interface templates.

Operations

Configuration History

Retrieve switch configuration history records.

Operations

DHCP Server

Manage ICX DHCP servers.

Operations

ICX Switch

Manage ICX switch settings.

Operations

Import Switch

Import and register new switches.

Operations

LAG

Manage LAGs (link aggregation groups).

Operations

Profile

Manage switch profiles and profile configurations.

Operations

Profile ACL

Manage ACL (access control list) of switch profile.

Operations

Profile Template

Manage switch profile templates.

Operations

Get Switch Profile TemplatesDeprecated

Request

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/{switchProfileId} can be used for this content.

Security
jwtAuth
No request payload

Responses

OK

Body
idstring

The identifier

namestring

The name of the configuration profile for identification and reference.

descriptionstring

The detailed description explaining the purpose and contents of this configuration profile.

aclsArray of objects(Acl_V1)unique

The set of Access Control List configurations included in this profile for traffic filtering.

vlansArray of objects(Vlan_V1)unique

The ordered set of VLAN configurations included in this profile with layer 2 security features.

voiceVlanConfigsArray of objects(VoiceVlanConfig_V1)unique

The set of voice VLAN configurations for VoIP traffic prioritization across different switch models.

trustedPortsArray of objects(TrustedPort_V1)unique

The set of trusted port configurations for DHCP snooping and ARP inspection security features.

profileTypestring

The type of profile indicating its scope: global, venue specific, or template based.

Enum"Regular""CLI"
venueCliTemplateobject(AcxVenueCliTemplateView)

The CLI template configuration associated with this profile for custom command execution.

venuesArray of stringsunique

The set of venue identifiers where this profile is deployed or available for use.

venueCountinteger(int64)

The total number of venues where this profile is currently deployed.

templateIdstring

The identifier of the profile template used as the basis for this profile configuration.

templateVersioninteger(int64)

The version number of the profile template.

applyOnboardOnlyboolean

The flag indicating whether this profile should only be applied during switch onboarding.

Response
{
  "id": "string",
  "name": "string",
  "description": "string",
  "acls": [
    { … }
  ],
  "vlans": [
    { … }
  ],
  "voiceVlanConfigs": [
    { … }
  ],
  "trustedPorts": [
    { … }
  ],
  "profileType": "Regular",
  "venueCliTemplate": {
    "id": "string",
    "name": "string",
    "cli": "string",
    "switchModels": "string",
    "variables": [ … ],
    "overwrite": true
  },
  "venues": [
    "string"
  ],
  "venueCount": 0,
  "templateId": "string",
  "templateVersion": 0,
  "applyOnboardOnly": true
}

Delete Switch Profile TemplatesDeprecated

Request

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/{switchProfileId} can be used for this content.

Security
jwtAuth
Body
requiredArray [
string
]
[
  "string"
]

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(EmptyView)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Profile VLAN

Manage VLANs (virtual local area networks) of switch profile.

Operations

Switch Access Control List

Manage ACLs (access control lists).

Operations

Switch Configuration Backup

Manage switch configuration backups and restore operations.

Operations

Switch Firmware Upgrade

Manage switch firmware upgrade and scheduling operations.

Operations

Switch Ports

Manage switch port configurations.

Operations

Switch Static Routes

Manage static route configurations.

Operations

Switch VLAN

Manage VLANs (virtual local area networks).

Operations

Switch Virtual Ethernet

Manage VE (virtual ethernet) port settings.

Operations

Trusted Port

Manage a port's trust settings.

Operations

Venue Switch Setting

Manage a switch's venue level settings.

Operations

Venue Template AAA Server

Manage venue template AAA (authentication, authorization, and accounting) servers.

Operations

Venue Template AAA Setting

Manage venue template AAA (authentication, authorization, and accounting) settings.

Operations